#include <TCLParameterReader.h>
Inheritance diagram for frib::analysis::CTCLParameterReader:
Collaboration diagram for frib::analysis::CTCLParameterReader:
Public Member Functions | |
| CTCLParameterReader (const char *pFilename) | |
| virtual void | read () |
 Public Member Functions inherited from frib::analysis::CParameterReader | |
| CParameterReader (const char *pFilename) | |
Additional Inherited Members | |
| Protected Attributes inherited from frib::analysis::CParameterReader | |
| std::string | m_filename |
Detailed Description
A parameter reader class that uses an extended Tcl interpreter to read the parameter and variable definition. The extensions to the interpreter are four new commands:
- treeparameter name low high bins units - Defines a treee parameter.
- treeparameterarray name low high bins units elements firstindex
- treevariable name value units
- treevariablearray name value units elements firstindex
- Note
- that these create initial definitions but user code can modify those definitions as well. Therefore it's normally needed to have all computational elements not only read the configuration file but to define any CTreeParameters/CTreeVariables as well...otherwise, since MPI is a multiprocessing, SPMD system, there's danger that one or more processes will operate with differing parameter/variable definitions.
Constructor & Destructor Documentation
◆ CTCLParameterReader()
| frib::analysis::CTCLParameterReader::CTCLParameterReader | ( | const char * | pFilename | ) |
constructor
- Parameters
-
pFilename - name of the file to read.
Member Function Documentation
◆ read()
|
virtual |
read Read the file.
- Create an interpreter.
- Evaluate the file on the interpreter.
This should result in a full set of tree parameter and tree variable definitions the user code can link to.
Implements frib::analysis::CParameterReader.
The documentation for this class was generated from the following files:
- base/TCLParameterReader.h
- base/TCLParameterReader.cpp
