Virtual base class for the parity subsystems. More...
#include <VQwSubsystemParity.h>
Inheritance diagram for VQwSubsystemParity:
Collaboration diagram for VQwSubsystemParity:
Public Member Functions | |
| VQwSubsystemParity (const TString &name) | |
| Constructor with name. More... | |
| VQwSubsystemParity (const VQwSubsystemParity &source) | |
| Copy constructor. More... | |
| virtual | ~VQwSubsystemParity () |
| Default destructor. More... | |
| virtual void | FillDB_MPS (QwParityDB *db, TString type) |
| Fill the database with MPS-based variables Note that most subsystems don't need to do this. More... | |
| virtual void | FillDB (QwParityDB *db, TString type) |
| Fill the database. More... | |
| virtual void | FillErrDB (QwParityDB *db, TString type) |
| virtual VQwSubsystem & | operator= (VQwSubsystem *value)=0 |
| Assignment Note: Must be called at the beginning of all subsystems routine call to operator=(VQwSubsystem *value) by VQwSubsystem::operator=(value) More... | |
| virtual VQwSubsystem & | operator+= (VQwSubsystem *value)=0 |
| virtual VQwSubsystem & | operator-= (VQwSubsystem *value)=0 |
| virtual void | Sum (VQwSubsystem *value1, VQwSubsystem *value2)=0 |
| virtual void | Difference (VQwSubsystem *value1, VQwSubsystem *value2)=0 |
| virtual void | Ratio (VQwSubsystem *numer, VQwSubsystem *denom)=0 |
| virtual void | Scale (Double_t factor)=0 |
| virtual void | AccumulateRunningSum (VQwSubsystem *value)=0 |
| Update the running sums for devices. More... | |
| virtual void | DeaccumulateRunningSum (VQwSubsystem *value)=0 |
| remove one entry from the running sums for devices More... | |
| virtual void | CalculateRunningAverage ()=0 |
| Calculate the average for all good events. More... | |
| virtual Int_t | LoadEventCuts (TString filename)=0 |
| Load the event cuts file. More... | |
| virtual Bool_t | ApplySingleEventCuts ()=0 |
| Apply the single event cuts. More... | |
| virtual void | PrintErrorCounters () const =0 |
| Report the number of events failed due to HW and event cut failures. More... | |
| virtual void | IncrementErrorCounters ()=0 |
| Increment the error counters. More... | |
| virtual UInt_t | GetEventcutErrorFlag ()=0 |
| Return the error flag to the top level routines related to stability checks and ErrorFlag updates. More... | |
| virtual UInt_t | UpdateErrorFlag () |
| Uses the error flags of contained data elements to update Returns the error flag to the top level routines related to stability checks and ErrorFlag updates. More... | |
| virtual void | UpdateErrorFlag (const VQwSubsystem *ev_error)=0 |
| update the error flag in the subsystem level from the top level routines related to stability checks. This will uniquely update the errorflag at each channel based on the error flag in the corresponding channel in the ev_error subsystem More... | |
| virtual void | Blind (const QwBlinder *blinder) |
| Blind the asymmetry of this subsystem. More... | |
| virtual void | Blind (const QwBlinder *blinder, const VQwSubsystemParity *subsys) |
| Blind the difference of this subsystem. More... | |
| virtual void | PrintValue () const |
| Print values of all channels. More... | |
| virtual void | WritePromptSummary (QwPromptSummary *ps, TString type) |
| virtual Bool_t | CheckForEndOfBurst () const |
| Public Member Functions inherited from VQwSubsystem | |
| VQwSubsystem (const TString &name) | |
| Constructor with name. More... | |
| VQwSubsystem (const VQwSubsystem &orig) | |
| Copy constructor by object. More... | |
| virtual | ~VQwSubsystem () |
| Default destructor. More... | |
| virtual void | ProcessOptions (QwOptions &options) |
| Process the command line options. More... | |
| TString | GetSubsystemName () const |
| Bool_t | HasDataLoaded () const |
| void | SetParent (QwSubsystemArray *parent) |
| Set the parent of this subsystem to the specified array. More... | |
| QwSubsystemArray * | GetParent (const unsigned int parent=0) const |
| Get the parent of this subsystem. More... | |
| VQwSubsystem * | GetSibling (const std::string &name) const |
| Get the sibling with specified name. More... | |
| Bool_t | PublishInternalValue (const TString &name, const TString &desc, const VQwHardwareChannel *value) const |
| Publish a variable name to the parent subsystem array. More... | |
| virtual Bool_t | PublishInternalValues () const |
| Publish all variables of the subsystem. More... | |
| virtual Bool_t | PublishByRequest (TString device_name) |
| Try to publish an internal variable matching the submitted name. More... | |
| Bool_t | RequestExternalValue (const TString &name, VQwHardwareChannel *value) const |
| Request a named value which is owned by an external subsystem; the request will be handled by the parent subsystem array. More... | |
| virtual const VQwHardwareChannel * | ReturnInternalValue (const TString &name) const |
| Return a pointer to a varialbe to the parent subsystem array to be delivered to a different subsystem. More... | |
| virtual Bool_t | ReturnInternalValue (const TString &name, VQwHardwareChannel *value) const |
| Return a named value to the parent subsystem array to be delivered to a different subsystem. More... | |
| virtual std::vector< TString > | GetParamFileNameList () |
| virtual std::map< TString, TString > | GetDetectorMaps () |
| virtual Int_t | LoadDetectorMaps (QwParameterFile &file) |
| Parse parameter file to find the map files. More... | |
| virtual Int_t | LoadChannelMap (TString mapfile)=0 |
| Mandatory map file definition. More... | |
| virtual Int_t | LoadInputParameters (TString mapfile)=0 |
| Mandatory parameter file definition. More... | |
| virtual Int_t | LoadGeometryDefinition (TString mapfile) |
| Optional geometry definition. More... | |
| virtual Int_t | LoadCrosstalkDefinition (TString mapfile) |
| Optional crosstalk definition. More... | |
| void | SetEventTypeMask (const UInt_t mask) |
| Set event type mask. More... | |
| UInt_t | GetEventTypeMask () const |
| Get event type mask. More... | |
| virtual void | ClearEventData ()=0 |
| virtual Int_t | ProcessConfigurationBuffer (const UInt_t roc_id, const UInt_t bank_id, UInt_t *buffer, UInt_t num_words)=0 |
| virtual Int_t | ProcessEvBuffer (const UInt_t event_type, const UInt_t roc_id, const UInt_t bank_id, UInt_t *buffer, UInt_t num_words) |
| virtual Int_t | ProcessEvBuffer (const UInt_t roc_id, const UInt_t bank_id, UInt_t *buffer, UInt_t num_words)=0 |
| TODO: The non-event-type-aware ProcessEvBuffer routine should be replaced with the event-type-aware version. More... | |
| virtual void | ProcessEvent ()=0 |
| virtual void | ExchangeProcessedData () |
| Request processed data from other subsystems for internal use in the second event processing stage. Not all derived classes will require data from other subsystems. More... | |
| virtual void | ProcessEvent_2 () |
| Process the event data again, including data from other subsystems. Not all derived classes will require a second stage of event data processing. More... | |
| virtual void | AtEndOfEventLoop () |
| Perform actions at the end of the event loop. More... | |
| virtual void | RandomizeEventData (int helicity=0, double time=0.0) |
| virtual void | EncodeEventData (std::vector< UInt_t > &buffer) |
| virtual void | PrintInfo () const |
| Print some information about the subsystem. More... | |
| virtual void | PrintDetectorMaps (Bool_t status) const |
| virtual void | ConstructHistograms () |
| Construct the histograms for this subsystem. More... | |
| virtual void | ConstructHistograms (TDirectory *folder) |
| Construct the histograms for this subsystem in a folder. More... | |
| virtual void | ConstructHistograms (TString &prefix) |
| Construct the histograms for this subsystem with a prefix. More... | |
| virtual void | ConstructHistograms (TDirectory *folder, TString &prefix)=0 |
| Construct the histograms for this subsystem in a folder with a prefix. More... | |
| virtual void | FillHistograms ()=0 |
| Fill the histograms for this subsystem. More... | |
| virtual void | ConstructBranchAndVector (TTree *tree, TString &prefix, std::vector< Double_t > &values)=0 |
| Construct the branch and tree vector. More... | |
| virtual void | ConstructBranchAndVector (TTree *tree, std::vector< Double_t > &values) |
| Construct the branch and tree vector. More... | |
| virtual void | ConstructBranch (TTree *tree, TString &prefix)=0 |
| Construct the branch and tree vector. More... | |
| virtual void | ConstructBranch (TTree *tree, TString &prefix, QwParameterFile &trim_file)=0 |
| Construct the branch and tree vector based on the trim file. More... | |
| virtual void | FillTreeVector (std::vector< Double_t > &values) const =0 |
| Fill the tree vector. More... | |
| virtual void | ConstructTree () |
| Construct the tree for this subsystem. More... | |
| virtual void | ConstructTree (TDirectory *folder) |
| Construct the tree for this subsystem in a folder. More... | |
| virtual void | ConstructTree (TString &prefix) |
| Construct the tree for this subsystem with a prefix. More... | |
| virtual void | ConstructTree (TDirectory *folder, TString &prefix) |
| Construct the tree for this subsystem in a folder with a prefix. More... | |
| virtual void | FillTree () |
| Fill the tree for this subsystem. More... | |
| virtual void | DeleteTree () |
| Delete the tree for this subsystem. More... | |
| Public Member Functions inherited from MQwHistograms | |
| void | ShareHistograms (const MQwHistograms *source) |
| Share histogram pointers between objects. More... | |
Private Member Functions | |
| VQwSubsystemParity () | |
| Private default constructor (not implemented, will throw linker error on use) More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from VQwSubsystem | |
| static void | DefineOptions () |
| Define options function (note: no virtual static functions in C++) More... | |
| Protected Member Functions inherited from VQwSubsystem | |
| void | UpdatePublishedValue (const TString &name, VQwHardwareChannel *data_channel) |
| void | ClearAllBankRegistrations () |
| Clear all registration of ROC and Bank IDs for this subsystem. More... | |
| virtual Int_t | RegisterROCNumber (const UInt_t roc_id, const UInt_t bank_id=0) |
| Tell the object that it will decode data from this ROC and sub-bank. More... | |
| Int_t | RegisterSubbank (const UInt_t bank_id) |
| Tell the object that it will decode data from this sub-bank in the ROC currently open for registration. More... | |
| Int_t | GetSubbankIndex () const |
| Int_t | GetSubbankIndex (const UInt_t roc_id, const UInt_t bank_id) const |
| void | SetDataLoaded (Bool_t flag) |
| Int_t | FindIndex (const std::vector< UInt_t > &myvec, const UInt_t value) const |
| Bool_t | Compare (VQwSubsystem *source) |
| Protected Member Functions inherited from MQwHistograms | |
| MQwHistograms () | |
| Default constructor. More... | |
| MQwHistograms (const MQwHistograms &source) | |
| Copy constructor. More... | |
| virtual | ~MQwHistograms () |
| Virtual destructor. More... | |
| virtual MQwHistograms & | operator= (const MQwHistograms &value) |
| void | Fill_Pointer (TH1_ptr hist_ptr, Double_t value) |
| void | AddHistogram (TH1 *h) |
| Register a histogram. More... | |
| Protected Attributes inherited from VQwSubsystem | |
| std::map< TString, VQwHardwareChannel * > | fPublishedInternalValues |
| Map of published internal values. More... | |
| std::vector< std::vector < TString > > | fPublishList |
| List of parameters to be published (loaded at the channel map) More... | |
| TString | fSystemName |
| Name of this subsystem. More... | |
| UInt_t | fEventTypeMask |
| Mask of event types. More... | |
| Bool_t | fIsDataLoaded |
| Has this subsystem gotten data to be processed? More... | |
| std::vector< TString > | fDetectorMapsNames |
| std::map< TString, TString > | fDetectorMaps |
| Int_t | fCurrentROC_ID |
| ROC ID that is currently being processed. More... | |
| Int_t | fCurrentBank_ID |
| Bank ID that is currently being processed. More... | |
| std::vector< UInt_t > | fROC_IDs |
| Vector of ROC IDs associated with this subsystem. More... | |
| std::vector< std::vector < UInt_t > > | fBank_IDs |
| Vector of Bank IDs per ROC ID associated with this subsystem. More... | |
| std::vector< QwSubsystemArray * > | fArrays |
| Vector of pointers to subsystem arrays that contain this subsystem. More... | |
| Protected Attributes inherited from MQwHistograms | |
| std::vector< TH1_ptr > | fHistograms |
| Histograms associated with this data element. More... | |
Detailed Description
Virtual base class for the parity subsystems.
Virtual base class for the classes containing the event-based information from each parity subsystem. This will define the interfaces used in communicating with the CODA routines.
Definition at line 36 of file VQwSubsystemParity.h.
Constructor & Destructor Documentation
|
private |
Private default constructor (not implemented, will throw linker error on use)
|
inline |
Constructor with name.
Definition at line 44 of file VQwSubsystemParity.h.
References VQwSubsystem::SetEventTypeMask().
Here is the call graph for this function:
|
inline |
Copy constructor.
Definition at line 48 of file VQwSubsystemParity.h.
|
inlinevirtual |
Member Function Documentation
|
pure virtual |
Update the running sums for devices.
Implemented in QwMainCerenkovDetector, QwComptonElectronDetector, QwHelicity, QwMollerDetector, QwBeamLine, QwLumi, QwIntegratedRaster, QwComptonPhotonDetector, QwScanner, QwBeamMod, QwScaler, and QwRegressionSubsystem.
Referenced by QwSubsystemArrayParity::AccumulateAllRunningSum(), and QwSubsystemArrayParity::AccumulateRunningSum().
Here is the caller graph for this function:
|
pure virtual |
Apply the single event cuts.
Implemented in QwRegressionSubsystem, QwComptonElectronDetector, QwMollerDetector, QwScanner, QwLumi, QwBeamMod, QwIntegratedRaster, QwScaler, QwComptonPhotonDetector, QwBeamLine, QwMainCerenkovDetector, and QwHelicity.
Referenced by QwSubsystemArrayParity::ApplySingleEventCuts().
Here is the caller graph for this function:
|
inlinevirtual |
Blind the asymmetry of this subsystem.
Reimplemented in QwMainCerenkovDetector.
Definition at line 99 of file VQwSubsystemParity.h.
Referenced by QwSubsystemArrayParity::Blind().
Here is the caller graph for this function:
|
inlinevirtual |
Blind the difference of this subsystem.
Reimplemented in QwMainCerenkovDetector.
Definition at line 101 of file VQwSubsystemParity.h.
|
pure virtual |
Calculate the average for all good events.
Implemented in QwMainCerenkovDetector, QwComptonElectronDetector, QwHelicity, QwBeamMod, QwBeamLine, QwMollerDetector, QwLumi, QwIntegratedRaster, QwComptonPhotonDetector, QwScanner, QwScaler, and QwRegressionSubsystem.
Referenced by QwSubsystemArrayParity::CalculateRunningAverage().
Here is the caller graph for this function:
|
inlinevirtual |
Definition at line 109 of file VQwSubsystemParity.h.
Referenced by QwSubsystemArrayParity::CheckForEndOfBurst().
Here is the caller graph for this function:
|
pure virtual |
remove one entry from the running sums for devices
Implemented in QwMainCerenkovDetector, QwComptonElectronDetector, QwHelicity, QwMollerDetector, QwBeamLine, QwLumi, QwIntegratedRaster, QwComptonPhotonDetector, QwScanner, QwBeamMod, QwScaler, and QwRegressionSubsystem.
Referenced by QwSubsystemArrayParity::DeaccumulateRunningSum().
Here is the caller graph for this function:
|
pure virtual |
|
inlinevirtual |
Fill the database.
Reimplemented in QwLumi, QwScanner, QwHelicity, QwBeamMod, QwIntegratedRaster, QwBeamLine, and QwMainCerenkovDetector.
Definition at line 58 of file VQwSubsystemParity.h.
Referenced by QwSubsystemArrayParity::FillDB().
Here is the caller graph for this function:
|
inlinevirtual |
Fill the database with MPS-based variables Note that most subsystems don't need to do this.
Reimplemented in QwBeamMod.
Definition at line 56 of file VQwSubsystemParity.h.
Referenced by QwSubsystemArrayParity::FillDB_MPS().
Here is the caller graph for this function:
|
inlinevirtual |
Reimplemented in QwLumi, QwHelicity, QwBeamMod, QwIntegratedRaster, QwBeamLine, and QwMainCerenkovDetector.
Definition at line 59 of file VQwSubsystemParity.h.
Referenced by QwSubsystemArrayParity::FillErrDB().
Here is the caller graph for this function:
|
pure virtual |
Return the error flag to the top level routines related to stability checks and ErrorFlag updates.
Implemented in QwScanner, QwRegressionSubsystem, QwComptonElectronDetector, QwMollerDetector, QwLumi, QwBeamMod, QwScaler, QwIntegratedRaster, QwComptonPhotonDetector, QwBeamLine, QwMainCerenkovDetector, and QwHelicity.
Referenced by QwSubsystemArrayParity::ApplySingleEventCuts(), and UpdateErrorFlag().
Here is the caller graph for this function:
|
pure virtual |
Increment the error counters.
Implemented in QwRegressionSubsystem, QwComptonElectronDetector, QwMollerDetector, QwScanner, QwLumi, QwBeamMod, QwScaler, QwIntegratedRaster, QwComptonPhotonDetector, QwBeamLine, QwMainCerenkovDetector, and QwHelicity.
Referenced by QwSubsystemArrayParity::IncrementErrorCounters().
Here is the caller graph for this function:
|
pure virtual |
Load the event cuts file.
Reimplemented from VQwSubsystem.
Implemented in QwComptonElectronDetector, QwMollerDetector, QwRegressionSubsystem, QwScanner, QwLumi, QwBeamMod, QwIntegratedRaster, QwScaler, QwComptonPhotonDetector, QwMainCerenkovDetector, QwBeamLine, and QwHelicity.
|
pure virtual |
|
pure virtual |
|
pure virtual |
Assignment Note: Must be called at the beginning of all subsystems routine call to operator=(VQwSubsystem *value) by VQwSubsystem::operator=(value)
Reimplemented from VQwSubsystem.
Implemented in QwMainCerenkovDetector, QwLumi, QwIntegratedRaster, QwComptonElectronDetector, QwHelicity, QwBeamMod, QwMollerDetector, QwBeamLine, QwComptonPhotonDetector, QwRegressionSubsystem, QwScaler, and QwScanner.
|
pure virtual |
Report the number of events failed due to HW and event cut failures.
Implemented in QwRegressionSubsystem, QwComptonElectronDetector, QwMollerDetector, QwScanner, QwLumi, QwBeamMod, QwScaler, QwIntegratedRaster, QwComptonPhotonDetector, QwBeamLine, QwMainCerenkovDetector, and QwHelicity.
Referenced by QwSubsystemArrayParity::PrintErrorCounters().
Here is the caller graph for this function:
|
inlinevirtual |
Print values of all channels.
Reimplemented in QwScanner, QwMainCerenkovDetector, QwComptonElectronDetector, QwLumi, QwIntegratedRaster, QwMollerDetector, QwBeamLine, QwComptonPhotonDetector, QwScaler, and QwRegressionSubsystem.
Definition at line 104 of file VQwSubsystemParity.h.
Referenced by QwBeamMod::Print(), and QwSubsystemArrayParity::PrintValue().
Here is the caller graph for this function:
|
pure virtual |
Implemented in QwMainCerenkovDetector, QwLumi, QwIntegratedRaster, QwHelicity, QwBeamMod, QwComptonElectronDetector, QwMollerDetector, QwBeamLine, QwRegressionSubsystem, QwComptonPhotonDetector, QwScaler, and QwScanner.
Referenced by QwSubsystemArrayParity::Ratio().
Here is the caller graph for this function:
|
pure virtual |
Implemented in QwMainCerenkovDetector, QwLumi, QwIntegratedRaster, QwBeamMod, QwComptonElectronDetector, QwHelicity, QwMollerDetector, QwBeamLine, QwRegressionSubsystem, QwComptonPhotonDetector, QwScaler, and QwScanner.
Referenced by QwSubsystemArrayParity::Scale().
Here is the caller graph for this function:
|
pure virtual |
|
inlinevirtual |
Uses the error flags of contained data elements to update Returns the error flag to the top level routines related to stability checks and ErrorFlag updates.
Reimplemented in QwBeamLine.
Definition at line 92 of file VQwSubsystemParity.h.
References GetEventcutErrorFlag().
Referenced by QwMainCerenkovDetector::UpdateErrorFlag(), and QwSubsystemArrayParity::UpdateErrorFlag().
Here is the call graph for this function:
Here is the caller graph for this function:
|
pure virtual |
update the error flag in the subsystem level from the top level routines related to stability checks. This will uniquely update the errorflag at each channel based on the error flag in the corresponding channel in the ev_error subsystem
Implemented in QwScanner, QwComptonElectronDetector, QwMollerDetector, QwRegressionSubsystem, QwLumi, QwBeamMod, QwIntegratedRaster, QwScaler, QwComptonPhotonDetector, QwBeamLine, QwMainCerenkovDetector, and QwHelicity.
|
inlinevirtual |
Reimplemented in QwMainCerenkovDetector, QwLumi, QwBeamMod, QwIntegratedRaster, and QwBeamLine.
Definition at line 106 of file VQwSubsystemParity.h.
Referenced by QwSubsystemArrayParity::WritePromptSummary().
Here is the caller graph for this function:
The documentation for this class was generated from the following file:
