CScriptedScalers

Name

CScriptedScalers -- Scaler class that is scriptably configured.

Synopsis


            CScriptedScalers : public CScaler
           
  CScriptedScalers()
          throws ;
           
   void  addCreator(CModuleCreator& creator)
          throws ;
               void  addStandardCreators()
          throws ;
  
              virtual   void  addUserWrittenCreators()
          throws ;
              virtual   std::string  getConfigurationFile()
          throws ;
  
  
  
        

DESCRIPTION

This is a scriptable scaler module. It is for scalers what CScriptedSegment3sbsreadoutCScriptedSegmentScripted readout event segmentCScriptedSegment : public CEventSegment CScriptedSegment voidaddCreatorCModuleCreator&creator voidaddStandardCreators virtualvoidaddUserWrittenCreators virtualstd::stringgetConfigurationFileDESCRIPTIONThis class is a scripted event segment. It ties together the readout and module commands along with a set of module creators and an interpreter that will be used to execute the configuration file.The virtual methods addUserWrittenCreators and getConfigurationFile allow applications to tailor the important aspects of this class.Note that since this class is derived from , it defines and implements the initialize, clear, disable and read methods from that class. Those implementations iterate through the modules thta have been added to the readout in the order in which they have been added invoking appropriate methods in those modules.METHODSCScriptedSegmentConstructor. Weaves together a Tcl interpreter, a configuration file a readout and a module command along with a set of module creators to build an event segment that is configurable via a Tcl script.voidaddCreatorCModuleCreator&creatorThis is a convenience method used by addStandardCreators and, if used, addUserWrittenCreators to register module creators with the object/interpreter's module command. creator is a reference to a CModuleCreator object that will be added. The creator object must live for the lifetime of this object.voidaddStandardCreatorsThis method is invoked from the initialize method to register the creators for the standard supported modules.virtualvoidaddUserWrittenCreatorsCalled by initialize. The implementation in the base class is empty. Derived classes may override this implementation to create and register additional module creators by invoking addCreator as needed.virtualstd::stringgetConfigurationFileCalled by initialize to obtain the path to the configuration file. The base class implementation returns the first match among $HARDWARE_FILE, $HOME/config/hardware.tcl ./hardware.tcl. An error is thrown (CErrnoException with a meaningful error message) if there is no match in any of these locations.getConfigurationFile is virtual allowing you to override this behavior. This is normally done if you want a scriptable event segment to use a different configuration script. is for event segments. The methods in this class have identical meaning and usage as for CScriptedSegment3sbsreadoutCScriptedSegmentScripted readout event segmentCScriptedSegment : public CEventSegment CScriptedSegment voidaddCreatorCModuleCreator&creator voidaddStandardCreators virtualvoidaddUserWrittenCreators virtualstd::stringgetConfigurationFileDESCRIPTIONThis class is a scripted event segment. It ties together the readout and module commands along with a set of module creators and an interpreter that will be used to execute the configuration file.The virtual methods addUserWrittenCreators and getConfigurationFile allow applications to tailor the important aspects of this class.Note that since this class is derived from , it defines and implements the initialize, clear, disable and read methods from that class. Those implementations iterate through the modules thta have been added to the readout in the order in which they have been added invoking appropriate methods in those modules.METHODSCScriptedSegmentConstructor. Weaves together a Tcl interpreter, a configuration file a readout and a module command along with a set of module creators to build an event segment that is configurable via a Tcl script.voidaddCreatorCModuleCreator&creatorThis is a convenience method used by addStandardCreators and, if used, addUserWrittenCreators to register module creators with the object/interpreter's module command. creator is a reference to a CModuleCreator object that will be added. The creator object must live for the lifetime of this object.voidaddStandardCreatorsThis method is invoked from the initialize method to register the creators for the standard supported modules.virtualvoidaddUserWrittenCreatorsCalled by initialize. The implementation in the base class is empty. Derived classes may override this implementation to create and register additional module creators by invoking addCreator as needed.virtualstd::stringgetConfigurationFileCalled by initialize to obtain the path to the configuration file. The base class implementation returns the first match among $HARDWARE_FILE, $HOME/config/hardware.tcl ./hardware.tcl. An error is thrown (CErrnoException with a meaningful error message) if there is no match in any of these locations.getConfigurationFile is virtual allowing you to override this behavior. This is normally done if you want a scriptable event segment to use a different configuration script..