Belle II Software development
DeSerializerCOPPERModule Class Reference

A class definition of an input module for Sequential ROOT I/O. More...

#include <DeSerializerCOPPER.h>

Inheritance diagram for DeSerializerCOPPERModule:
DeSerializerModule Module PathElement DeSerializerFILEModule

Public Types

enum  EModulePropFlags {
  c_Input = 1 ,
  c_Output = 2 ,
  c_ParallelProcessingCertified = 4 ,
  c_HistogramManager = 8 ,
  c_InternalSerializer = 16 ,
  c_TerminateInAllProcesses = 32 ,
  c_DontCollectStatistics = 64
}
 Each module can be tagged with property flags, which indicate certain features of the module. More...
 
typedef ModuleCondition::EAfterConditionPath EAfterConditionPath
 Forward the EAfterConditionPath definition from the ModuleCondition.
 

Public Member Functions

 DeSerializerCOPPERModule ()
 Constructor / Destructor.
 
void initialize () override
 Module functions to be called from main process.
 
void event () override
 Module functions to be called from event process.
 
void terminate () override
 This method is called at the end of the event processing.
 
virtual void openOutputFile ()
 Module functions to be called from event process.
 
virtual void dumpData (char *buf, int size)
 dump binary data
 
virtual void printData (int *buf, int nwords)
 dump error data
 
virtual void printASCIIData (int *buf, int nwords)
 dump error data
 
virtual std::vector< std::string > getFileNames (bool outputFiles)
 Return a list of output filenames for this modules.
 
virtual void beginRun ()
 Called when entering a new run.
 
virtual void endRun ()
 This method is called if the current run ends.
 
const std::string & getName () const
 Returns the name of the module.
 
const std::string & getType () const
 Returns the type of the module (i.e.
 
const std::string & getPackage () const
 Returns the package this module is in.
 
const std::string & getDescription () const
 Returns the description of the module.
 
void setName (const std::string &name)
 Set the name of the module.
 
void setPropertyFlags (unsigned int propertyFlags)
 Sets the flags for the module properties.
 
LogConfiggetLogConfig ()
 Returns the log system configuration.
 
void setLogConfig (const LogConfig &logConfig)
 Set the log system configuration.
 
void setLogLevel (int logLevel)
 Configure the log level.
 
void setDebugLevel (int debugLevel)
 Configure the debug messaging level.
 
void setAbortLevel (int abortLevel)
 Configure the abort log level.
 
void setLogInfo (int logLevel, unsigned int logInfo)
 Configure the printed log information for the given level.
 
void if_value (const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 Add a condition to the module.
 
void if_false (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to add a condition to the module.
 
void if_true (const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
 A simplified version to set the condition of the module.
 
bool hasCondition () const
 Returns true if at least one condition was set for the module.
 
const ModuleConditiongetCondition () const
 Return a pointer to the first condition (or nullptr, if none was set)
 
const std::vector< ModuleCondition > & getAllConditions () const
 Return all set conditions for this module.
 
bool evalCondition () const
 If at least one condition was set, it is evaluated and true returned if at least one condition returns true.
 
std::shared_ptr< PathgetConditionPath () const
 Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).
 
Module::EAfterConditionPath getAfterConditionPath () const
 What to do after the conditional path is finished.
 
std::vector< std::shared_ptr< Path > > getAllConditionPaths () const
 Return all condition paths currently set (no matter if the condition is true or not).
 
bool hasProperties (unsigned int propertyFlags) const
 Returns true if all specified property flags are available in this module.
 
bool hasUnsetForcedParams () const
 Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.
 
const ModuleParamListgetParamList () const
 Return module param list.
 
template<typename T >
ModuleParam< T > & getParam (const std::string &name) const
 Returns a reference to a parameter.
 
bool hasReturnValue () const
 Return true if this module has a valid return value set.
 
int getReturnValue () const
 Return the return value set by this module.
 
std::shared_ptr< PathElementclone () const override
 Create an independent copy of this module.
 
std::shared_ptr< boost::python::list > getParamInfoListPython () const
 Returns a python list of all parameters.
 

Static Public Member Functions

static RunInfoBuffergetStatus ()
 
static void exposePythonAPI ()
 Exposes methods of the Module class to Python.
 

Protected Member Functions

virtual int * getPreAllocBuf ()
 Getbuffer.
 
virtual int * getNewBuffer (int nwords, int *delete_flag)
 Getbuffer.
 
double getTimeSec ()
 store time info.
 
void recordTime (int event, double *array)
 store time info.
 
int checkData (char *buf, int prev_eve, int *cur_eve)
 check data
 
unsigned int calcSimpleChecksum (int *buf, int nwords)
 calculate checksum
 
unsigned int calcXORChecksum (int *buf, int nwords)
 calculate checksum
 
virtual void clearNumUsedBuf ()
 
void RateMonitor (unsigned int nevt, int subrun=-1, int run=-1)
 monitor rate
 
void shmOpen (char *path_cfg, char *path_sta)
 open shared memory
 
int * shmGet (int fd, int size_words)
 Get shared memory.
 
virtual void def_initialize ()
 Wrappers to make the methods without "def_" prefix callable from Python.
 
virtual void def_beginRun ()
 Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.
 
virtual void def_event ()
 Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.
 
virtual void def_endRun ()
 This method can receive that the current run ends as a call from the Python side.
 
virtual void def_terminate ()
 Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.
 
void setDescription (const std::string &description)
 Sets the description of the module.
 
void setType (const std::string &type)
 Set the module type.
 
template<typename T >
void addParam (const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
 Adds a new parameter to the module.
 
template<typename T >
void addParam (const std::string &name, T &paramVariable, const std::string &description)
 Adds a new enforced parameter to the module.
 
void setReturnValue (int value)
 Sets the return value for this module as integer.
 
void setReturnValue (bool value)
 Sets the return value for this module as bool.
 
void setParamList (const ModuleParamList &params)
 Replace existing parameter list.
 

Protected Attributes

const PreRawCOPPERFormat_latest m_pre_rawcpr
 Handle to data from HSLBs.
 
StoreObjPtr< EventMetaDatam_eventMetaDataPtr
 
StoreArray< RawDataBlockraw_datablkarray
 
int max_nevt
 StoreArray.
 
double max_seconds
 time to stop a run
 
int m_compressionLevel
 Compression Level.
 
int BUF_SIZE_WORD
 size of buffer for one event (word)
 
int n_basf2evt
 No. of sent events.
 
int m_prev_nevt
 No. of prev sent events.
 
std::string m_dump_fname
 dump filename
 
FILE * m_fp_dump
 dump file descripter
 
int * m_buffer
 buffer
 
int * m_bufary [NUM_PREALLOC_BUF]
 buffer
 
timeval m_t0
 
double m_totbytes
 
double m_prev_totbytes
 
int m_ncycle
 
double cur_time
 for time monitoring
 
double m_start_time
 
double m_prev_time
 
double time_array0 [1000]
 
double time_array1 [1000]
 
double time_array2 [1000]
 
double time_array3 [1000]
 
double time_array4 [1000]
 
double time_array5 [1000]
 
int prev_event
 
int m_num_usedbuf
 
int m_nodeid
 Node(PC or COPPER) ID.
 
std::string m_nodename
 Node name.
 
int m_run_no
 run no.
 
int m_prev_run_no
 run no.
 
unsigned int m_exprunsubrun_no
 run no.
 
unsigned int m_prev_exprunsubrun_no
 run no.
 
int m_exp_no
 exp no.
 
int m_data_type
 data type
 
int m_trunc_mask
 trunc mask
 
int m_shmflag
 Use shared memory.
 
int m_shmfd_cfg
 file descripter for shm
 
int m_shmfd_sta
 file descripter for shm
 
int monitor_numeve
 buffer for shared memory
 
int m_start_flag
 start flag
 
CprErrorMessage print_err
 wrapper for B2LOG system
 

Static Protected Attributes

static RunInfoBuffer g_status
 buffer class to communicate with NSM client
 

Private Member Functions

virtual int * readOneEventFromCOPPERFIFO (const int entry, int *delete_flag, int *m_size_word)
 
virtual void openCOPPER ()
 
virtual int readFD (int fd, char *buf, int data_size_byte, int delete_flag)
 receive data
 
virtual void initializeCOPPER ()
 Module functions to be called from main process.
 
std::list< ModulePtrgetModules () const override
 no submodules, return empty list
 
std::string getPathString () const override
 return the module name.
 
void setParamPython (const std::string &name, const boost::python::object &pyObj)
 Implements a method for setting boost::python objects.
 
void setParamPythonDict (const boost::python::dict &dictionary)
 Implements a method for reading the parameter values from a boost::python dictionary.
 

Private Attributes

StoreArray< RawDataBlockraw_dblkarray
 
int m_cpr_fd
 COPPER file descripter.
 
int m_use_slot
 bit flag for available FINESSE slot
 
int m_finesse_bit_flag
 bit flag for available FINESSE slot
 
unsigned int m_prev_ftsweve32
 Event # from data.
 
std::string m_name
 The name of the module, saved as a string (user-modifiable)
 
std::string m_type
 The type of the module, saved as a string.
 
std::string m_package
 Package this module is found in (may be empty).
 
std::string m_description
 The description of the module.
 
unsigned int m_propertyFlags
 The properties of the module as bitwise or (with |) of EModulePropFlags.
 
LogConfig m_logConfig
 The log system configuration of the module.
 
ModuleParamList m_moduleParamList
 List storing and managing all parameter of the module.
 
bool m_hasReturnValue
 True, if the return value is set.
 
int m_returnValue
 The return value.
 
std::vector< ModuleConditionm_conditions
 Module condition, only non-null if set.
 

Detailed Description

A class definition of an input module for Sequential ROOT I/O.

Definition at line 31 of file DeSerializerCOPPER.h.

Member Typedef Documentation

◆ EAfterConditionPath

Forward the EAfterConditionPath definition from the ModuleCondition.

Definition at line 88 of file Module.h.

Member Enumeration Documentation

◆ EModulePropFlags

enum EModulePropFlags
inherited

Each module can be tagged with property flags, which indicate certain features of the module.

Enumerator
c_Input 

This module is an input module (reads data).

c_Output 

This module is an output module (writes data).

c_ParallelProcessingCertified 

This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)

c_HistogramManager 

This module is used to manage histograms accumulated by other modules.

c_InternalSerializer 

This module is an internal serializer/deserializer for parallel processing.

c_TerminateInAllProcesses 

When using parallel processing, call this module's terminate() function in all processes().

This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.

c_DontCollectStatistics 

No statistics is collected for this module.

Definition at line 77 of file Module.h.

77 {
78 c_Input = 1,
79 c_Output = 2,
85 };
@ c_HistogramManager
This module is used to manage histograms accumulated by other modules.
Definition: Module.h:81
@ c_Input
This module is an input module (reads data).
Definition: Module.h:78
@ c_DontCollectStatistics
No statistics is collected for this module.
Definition: Module.h:84
@ c_ParallelProcessingCertified
This module can be run in parallel processing mode safely (All I/O must be done through the data stor...
Definition: Module.h:80
@ c_InternalSerializer
This module is an internal serializer/deserializer for parallel processing.
Definition: Module.h:82
@ c_Output
This module is an output module (writes data).
Definition: Module.h:79
@ c_TerminateInAllProcesses
When using parallel processing, call this module's terminate() function in all processes().
Definition: Module.h:83

Constructor & Destructor Documentation

◆ DeSerializerCOPPERModule()

Constructor / Destructor.

Definition at line 44 of file DeSerializerCOPPER.cc.

45{
46 //Set module properties
47 setDescription("Encode DataStore into RingBuffer");
48
49 // setPropertyFlags(c_Input | c_ParallelProcessingCertified);
50 addParam("FinesseBitFlag", m_finesse_bit_flag, "finesse (A,B,C,D) -> bit (0,1,2,3)", 15);
51
52 //Parameter definition
53 B2INFO("DeSerializerCOPPER: Constructor done.");
54 m_prev_ftsweve32 = 0xFFFFFFFF;
55
56 m_cpr_fd = -1;
57}
int m_finesse_bit_flag
bit flag for available FINESSE slot
unsigned int m_prev_ftsweve32
Event # from data.
int m_cpr_fd
COPPER file descripter.
DeSerializerModule()
Constructor / Destructor.
Definition: DeSerializer.cc:29
void setDescription(const std::string &description)
Sets the description of the module.
Definition: Module.cc:214
void addParam(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module.
Definition: Module.h:560

◆ ~DeSerializerCOPPERModule()

Definition at line 60 of file DeSerializerCOPPER.cc.

61{
62}

Member Function Documentation

◆ beginRun()

virtual void beginRun ( void  )
inlinevirtualinherited

Called when entering a new run.

Called at the beginning of each run, the method gives you the chance to change run dependent constants like alignment parameters, etc.

This method can be implemented by subclasses.

Reimplemented in ARICHBackgroundModule, BeamabortModule, BgoModule, CaveModule, ClawModule, CLAWSModule, DosiModule, FANGSModule, He3tubeModule, MicrotpcModule, Ph1bpipeModule, Ph1sustrModule, PindiodeModule, PlumeModule, QcsmonitorModule, SrsensorModule, GetEventFromSocketModule, CalibrationCollectorModule, EventsOfDoomBusterModule, CosmicsAlignmentValidationModule, EnergyBiasCorrectionModule, ChargedPidMVAModule, ChargedPidMVAMulticlassModule, CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, ParticleVertexFitterModule, PhotonEfficiencySystematicsModule, TagVertexModule, TreeFitterModule, arichBtestModule, ARICHDigitizerModule, ARICHDQMModule, ARICHRateCalModule, ARICHReconstructorModule, B2BIIMCParticlesMonitorModule, B2BIIConvertBeamParamsModule, B2BIIConvertMdstModule, B2BIIFixMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, BeamBkgGeneratorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, BeamBkgTagSetterModule, BGOverlayInputModule, AnalysisPhase1StudyModule, NtuplePhase1_v6Module, ReprocessorModule, BeamabortStudyModule, BeamDigitizerModule, BgoDigitizerModule, BgoStudyModule, ClawDigitizerModule, ClawStudyModule, ClawsDigitizerModule, ClawsStudyModule, CsiDigitizer_v2Module, CsIDigitizerModule, CsiModule, CsiStudy_v2Module, CsIStudyModule, DosiDigitizerModule, DosiStudyModule, FANGSDigitizerModule, FANGSStudyModule, He3DigitizerModule, He3tubeStudyModule, MicrotpcStudyModule, TpcDigitizerModule, PinDigitizerModule, PindiodeStudyModule, PlumeDigitizerModule, QcsmonitorDigitizerModule, QcsmonitorStudyModule, CDCCosmicAnalysisModule, CDCCRTestModule, cdcDQM7Module, CDCDQMModule, CDCPackerModule, CDCRecoTrackFilterModule, CDCUnpackerModule, DAQPerfModule, RxSocketModule, TxSocketModule, DqmHistoManagerModule, MonitorDataModule, TrackAnaModule, Ds2SampleModule, ReceiveEventModule, HLTDQM2ZMQModule, ElapsedTimeModule, DeSerializerPXDModule, GenRawSendModule, SerializerModule, CertifyParallelModule, Ds2RawModule, Ds2RbufModule, EvReductionModule, FastRbuf2DsModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, Ds2RawFileModule, PartialSeqRootReaderModule, SeqRootMergerModule, StorageDeserializerModule, StorageSerializerModule, IPDQMModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, ECLBackgroundModule, ECLChargedPIDModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, ECLChargedPIDMVAModule, ECLClusterPSDModule, ECLCovarianceMatrixModule, ECLCRFinderModule, ECLDataAnalysisModule, ECLDigitCalibratorModule, ECLDigitizerModule, ECLDigitizerPureCsIModule, EclDisplayModule, ECLDQMModule, ECLDQMConnectedRegionsModule, ECLDQMEXTENDEDModule, ECLDQMOutOfTimeDigitsModule, ECLFinalizerModule, ECLHitDebugModule, ECLLocalMaximumFinderModule, ECLLocalRunCalibratorModule, ECLLOMModule, ECLPackerModule, ECLShowerCorrectorModule, ECLShowerShapeModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLUnpackerModule, ECLWaveformFitModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, EventLimiterModule, IoVDependentConditionModule, ProgressModule, RandomBarrierModule, GearboxModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, EvtGenDecayModule, EvtGenInputModule, OverrideGenerationFlagsModule, KKGenInputModule, CreateFieldMapModule, ExportGeometryModule, SoftwareTriggerModule, SoftwareTriggerHLTDQMModule, StatisticsTimingHLTDQMModule, BKLMAnaModule, BKLMDigitAnalyzerModule, BKLMSimHistogrammerModule, BKLMTrackingModule, EKLMDataCheckerModule, KLMClusterAnaModule, KLMClusterEfficiencyModule, KLMClustersReconstructorModule, KLMDigitizerModule, KLMDigitTimeShifterModule, KLMDQMModule, KLMDQM2Module, KLMPackerModule, KLMReconstructorModule, KLMScintillatorSimulatorModule, KLMUnpackerModule, MVAExpertModule, MVAMultipleExpertsModule, MVAPrototypeModule, AWESOMEBasicModule, PXDBackgroundModule, PXDRawDQMChipsModule, PXDClustersFromTracksModule, PXDPerformanceModule, PXDClusterizerModule, Convert2RawDetModule, CDCDedxDQMModule, CDCDedxValidationModule, EventT0DQMModule, EventT0ValidationModule, DataWriterModule, ECLExpertModule, KLMExpertModule, KlongValidationModule, KLMMuonIDDNNExpertModule, FullSimModule, MaterialScanModule, SVDBackgroundModule, SVDClusterCalibrationsMonitorModule, SVDHotStripFinderModule, SVDLatencyCalibrationModule, SVDLocalCalibrationsCheckModule, SVDLocalCalibrationsMonitorModule, SVDPositionErrorScaleFactorImporterModule, SVDTimeCalibrationsMonitorModule, SVDDQMHitTimeModule, svdDumpModule, SVDPackerModule, SVDB4CommissioningPlotsModule, SVDClusterEvaluationModule, SVDClusterEvaluationTrueInfoModule, SVDClusterFilterModule, SVDMaxStripTTreeModule, SVDOccupancyAnalysisModule, SVDPerformanceModule, SVDPerformanceTTreeModule, SVDShaperDigitsFromTracksModule, SVDClusterizerModule, SVDCoGTimeEstimatorModule, SVDDataFormatCheckModule, SVDMissingAPVsClusterCreatorModule, SVDRecoDigitCreatorModule, SVD3SamplesEmulatorModule, SVDDigitizerModule, SVDEventInfoSetterModule, SVDTriggerQualityGeneratorModule, SVDSpacePointCreatorModule, SVDTimeGroupingModule, SVDUnpackerModule, TOPBackgroundModule, TOPBunchFinderModule, TOPChannelMaskerModule, TOPChannelT0MCModule, TOPDigitizerModule, TOPTriggerDigitizerModule, TOPDoublePulseGeneratorModule, TOPDQMModule, TOPGainEfficiencyCalculatorModule, TOPLaserHitSelectorModule, TOPInterimFENtupleModule, TOPLaserCalibratorModule, TOPMCTrackMakerModule, TOPModuleT0CalibratorModule, TOPNtupleModule, TOPPackerModule, TOPRawDigitConverterModule, TOPTBCComparatorModule, TOPTimeBaseCalibratorModule, TOPTimeRecalibratorModule, TOPUnpackerModule, TOPWaveformFeatureExtractorModule, TOPXTalkChargeShareSetterModule, DQMHistoModuleBase, SVDEventT0EstimatorModule, ExtModule, FlipQualityModule, BeamSpotMonitorModule, KinkFinderModule, MCV0MatcherModule, MCTrackCandClassifierModule, MuidModule, PXDROIFinderModule, SVDROIFinderAnalysisModule, SVDROIFinderModule, SPTCmomentumSeedRetrieverModule, SPTCvirtualIPRemoverModule, TrackCreatorModule, TrackFinderMCTruthRecoTracksModule, EffPlotsModule, HitXPModule, TrackingPerformanceEvaluationModule, V0findingPerformanceEvaluationModule, TrackQETrainingDataCollectorModule, TrackQualityEstimatorMVAModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, TrackFinderVXDAnalizerModule, VXDSimpleClusterizerModule, QualityEstimatorVXDModule, VXDQETrainingDataCollectorModule, VXDQualityEstimatorMVAModule, SectorMapBootstrapModule, SegmentNetworkProducerModule, TrackFinderVXDBasicPathFinderModule, TrackFinderVXDCellOMatModule, VXDTFTrainingDataCollectorModule, FindletModule< AFindlet >, FindletModule< HitBasedT0Extractor >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< CKFToSVDFindlet >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< DATCONFPGAFindlet >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< vxdHoughTracking::SVDHoughTracking >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToPXDFindlet >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromHitsFindlet >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromSegmentsFindlet >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderLegendre >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterPreparer >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< FacetCreator >, FindletModule< HitReclaimer >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFitter >, FindletModule< SegmentLinker >, FindletModule< SegmentOrienter >, FindletModule< SegmentPairCreator >, FindletModule< SegmentRejecter >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTripleCreator >, FindletModule< StereoHitFinder >, FindletModule< SuperClusterCreator >, FindletModule< TrackCombiner >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackExporter >, FindletModule< TrackFinderAutomaton >, FindletModule< TrackFinderCosmics >, FindletModule< TrackFinder >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityEstimator >, FindletModule< TrackRejecter >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitCreator >, FindletModule< WireHitPreparer >, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, CDCTriggerNDFinderModule, CDCTriggerTSFModule, TRGCDCModule, TRGCDCETFUnpackerModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSFUnpackerModule, TRGCDCTSStreamModule, CDCTriggerUnpackerModule, MCMatcherTRGECLModule, TRGECLFAMModule, TRGECLModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLEventTimingDQMModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGGDLModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLSummaryModule, TRGGDLUnpackerModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLDQMModule, TRGGRLUnpackerModule, KLMTriggerModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TRGRAWDATAModule, VXDMisalignmentModule, DQMHistAnalysisARICHModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisEventT0EfficiencyModule, DQMHistAnalysisEventT0TriggerJitterModule, DQMHistAnalysisExampleModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisHLTModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputRootFileModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLMModule, DQMHistAnalysisKLM2Module, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPeakModule, DQMHistAnalysisPXDERModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisSVDClustersOnTrackModule, DQMHistAnalysisSVDDoseModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDGeneralModule, DQMHistAnalysisSVDOccupancyModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisSVDUnpackerModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTrackingAbortModule, DQMHistAnalysisTrackingHLTModule, DQMHistAnalysisTRGECLModule, DQMHistAutoCanvasModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DQMHistReferenceModule, DQMHistSnapshotsModule, DAQMonitorModule, DelayDQMModule, V0ObjectsDQMModule, ECLDQMInjectionModule, PyModule, PXDBgTupleProducerModule, PXDMCBgTupleProducerModule, PXDDAQDQMModule, PXDDQMClustersModule, PXDDQMCorrModule, PXDDQMEfficiencyModule, PXDDQMEfficiencySelftrackModule, PXDDQMExpressRecoModule, PXDGatedDHCDQMModule, PXDGatedModeDQMModule, PXDInjectionDQMModule, PXDRawDQMCorrModule, PXDRawDQMModule, PXDROIDQMModule, PXDTrackClusterDQMModule, PXDDigitizerModule, PXDPackerModule, PXDUnpackerModule, TTDDQMModule, SVDDQMClustersOnTrackModule, SVDDQMDoseModule, SVDDQMExpressRecoModule, SVDDQMInjectionModule, SVDUnpackerDQMModule, PXDclusterFilterModule, PXDdigiFilterModule, PXDROIFinderAnalysisModule, TrackingAbortDQMModule, VXDDQMExpressRecoModule, vxdDigitMaskingModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisEpicsOutputModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDCMModule, DQMHistAnalysisPXDDAQModule, DQMHistAnalysisPXDEffModule, DQMHistAnalysisPXDInjectionModule, DQMHistAnalysisPXDReductionModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisRunNrModule, DQMHistAnalysisTRGModule, DQMHistInjectionModule, and DQMHistOutputToEPICSModule.

Definition at line 147 of file Module.h.

147{};

◆ calcSimpleChecksum()

unsigned int calcSimpleChecksum ( int *  buf,
int  nwords 
)
protectedinherited

calculate checksum

Definition at line 172 of file DeSerializer.cc.

173{
174 unsigned int checksum = 0;
175 for (int i = 0; i < nwords; i++) {
176 checksum = checksum + (unsigned int)buf[ i ];
177 // printf( "[DEBUG] i %.4d 0x%.8x 0x%.8x\n", i, checksum, buf[i]);
178 }
179 return checksum;
180}

◆ calcXORChecksum()

unsigned int calcXORChecksum ( int *  buf,
int  nwords 
)
protectedinherited

calculate checksum

Definition at line 161 of file DeSerializer.cc.

162{
163 unsigned int checksum = 0;
164 for (int i = 0; i < nwords; i++) {
165
166 checksum = checksum ^ buf[ i ];
167 }
168 return checksum;
169}

◆ clearNumUsedBuf()

virtual void clearNumUsedBuf ( )
inlineprotectedvirtualinherited

Definition at line 143 of file DeSerializer.h.

144 {
145 m_num_usedbuf = 0;
146 return ;
147 }

◆ clone()

std::shared_ptr< PathElement > clone ( ) const
overridevirtualinherited

Create an independent copy of this module.

Note that parameters are shared, so changing them on a cloned module will also affect the original module.

Implements PathElement.

Definition at line 179 of file Module.cc.

180{
182 newModule->m_moduleParamList.setParameters(getParamList());
183 newModule->setName(getName());
184 newModule->m_package = m_package;
185 newModule->m_propertyFlags = m_propertyFlags;
186 newModule->m_logConfig = m_logConfig;
187 newModule->m_conditions = m_conditions;
188
189 return newModule;
190}
std::shared_ptr< Module > registerModule(const std::string &moduleName, std::string sharedLibPath="") noexcept(false)
Creates an instance of a module and registers it to the ModuleManager.
static ModuleManager & Instance()
Exception is thrown if the requested module could not be created by the ModuleManager.
const ModuleParamList & getParamList() const
Return module param list.
Definition: Module.h:363
const std::string & getName() const
Returns the name of the module.
Definition: Module.h:187
const std::string & getType() const
Returns the type of the module (i.e.
Definition: Module.cc:41
unsigned int m_propertyFlags
The properties of the module as bitwise or (with |) of EModulePropFlags.
Definition: Module.h:512
LogConfig m_logConfig
The log system configuration of the module.
Definition: Module.h:514
std::vector< ModuleCondition > m_conditions
Module condition, only non-null if set.
Definition: Module.h:521
std::string m_package
Package this module is found in (may be empty).
Definition: Module.h:510
std::shared_ptr< Module > ModulePtr
Defines a pointer to a module object as a boost shared pointer.
Definition: Module.h:43

◆ def_beginRun()

virtual void def_beginRun ( )
inlineprotectedvirtualinherited

Wrapper method for the virtual function beginRun() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 426 of file Module.h.

426{ beginRun(); }
virtual void beginRun()
Called when entering a new run.
Definition: Module.h:147

◆ def_endRun()

virtual void def_endRun ( )
inlineprotectedvirtualinherited

This method can receive that the current run ends as a call from the Python side.

For regular C++-Modules that forwards the call to the regular endRun() method.

Reimplemented in PyModule.

Definition at line 439 of file Module.h.

439{ endRun(); }
virtual void endRun()
This method is called if the current run ends.
Definition: Module.h:166

◆ def_event()

virtual void def_event ( )
inlineprotectedvirtualinherited

Wrapper method for the virtual function event() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 432 of file Module.h.

432{ event(); }
virtual void event()
This method is the core of the module.
Definition: Module.h:157

◆ def_initialize()

virtual void def_initialize ( )
inlineprotectedvirtualinherited

Wrappers to make the methods without "def_" prefix callable from Python.

Overridden in PyModule. Wrapper method for the virtual function initialize() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 420 of file Module.h.

420{ initialize(); }
virtual void initialize()
Initialize the Module.
Definition: Module.h:109

◆ def_terminate()

virtual void def_terminate ( )
inlineprotectedvirtualinherited

Wrapper method for the virtual function terminate() that has the implementation to be used in a call from Python.

Reimplemented in PyModule.

Definition at line 445 of file Module.h.

445{ terminate(); }
virtual void terminate()
This method is called at the end of the event processing.
Definition: Module.h:176

◆ dumpData()

void dumpData ( char *  buf,
int  size 
)
virtualinherited

dump binary data

Definition at line 211 of file DeSerializer.cc.

212{
213 if (fwrite(buf, size, 1, m_fp_dump) <= 0) {
214 char err_buf[500];
215 sprintf(err_buf, "[FATAL] Failed to write buffer to a file. Exiting...\n");
216 print_err.PrintError(err_buf, __FILE__, __PRETTY_FUNCTION__, __LINE__);
217 exit(-1);
218 }
219}
CprErrorMessage print_err
wrapper for B2LOG system
Definition: DeSerializer.h:213
FILE * m_fp_dump
dump file descripter
Definition: DeSerializer.h:95

◆ endRun()

virtual void endRun ( void  )
inlinevirtualinherited

This method is called if the current run ends.

Use this method to store information, which should be aggregated over one run.

This method can be implemented by subclasses.

Reimplemented in BeamabortModule, BgoModule, CaveModule, ClawModule, CLAWSModule, DosiModule, FANGSModule, He3tubeModule, MicrotpcModule, Ph1bpipeModule, Ph1sustrModule, PindiodeModule, PlumeModule, QcsmonitorModule, SrsensorModule, GetEventFromSocketModule, CalibrationCollectorModule, AlignDQMModule, CosmicsAlignmentValidationModule, CurlTaggerModule, LowEnergyPi0IdentificationExpertModule, LowEnergyPi0VetoExpertModule, arichBtestModule, ARICHDQMModule, B2BIIMCParticlesMonitorModule, B2BIIConvertMdstModule, B2BIIMdstInputModule, BelleMCOutputModule, BeamBkgGeneratorModule, BeamBkgHitRateMonitorModule, BeamBkgMixerModule, BeamBkgTagSetterModule, BGOverlayInputModule, AnalysisPhase1StudyModule, NtuplePhase1_v6Module, ReprocessorModule, BeamabortStudyModule, BeamDigitizerModule, BgoDigitizerModule, BgoStudyModule, ClawDigitizerModule, ClawStudyModule, ClawsDigitizerModule, ClawsStudyModule, CsiDigitizer_v2Module, CsIDigitizerModule, CsiModule, CsiStudy_v2Module, CsIStudyModule, DosiDigitizerModule, DosiStudyModule, FANGSDigitizerModule, FANGSStudyModule, He3DigitizerModule, He3tubeStudyModule, MicrotpcStudyModule, TpcDigitizerModule, TPCStudyModule, PinDigitizerModule, PindiodeStudyModule, PlumeDigitizerModule, QcsmonitorDigitizerModule, QcsmonitorStudyModule, CDCCosmicAnalysisModule, CDCCRTestModule, cdcDQM7Module, CDCDQMModule, CDCPackerModule, CDCRecoTrackFilterModule, CDCUnpackerModule, DAQPerfModule, RxSocketModule, TxSocketModule, DqmHistoManagerModule, MonitorDataModule, TrackAnaModule, Ds2SampleModule, ReceiveEventModule, HLTDQM2ZMQModule, HLTDs2ZMQModule, ElapsedTimeModule, DeSerializerPXDModule, GenRawSendModule, Root2RawModule, SerializerModule, CertifyParallelModule, Ds2RawModule, Ds2RbufModule, EvReductionModule, FastRbuf2DsModule, Raw2DsModule, RawInputModule, Rbuf2DsModule, Rbuf2RbufModule, Ds2RawFileModule, PartialSeqRootReaderModule, SeqRootMergerModule, StorageDeserializerModule, StorageRootOutputModule, StorageSerializerModule, PhysicsObjectsDQMModule, PhysicsObjectsMiraBelleBhabhaModule, PhysicsObjectsMiraBelleDst2Module, PhysicsObjectsMiraBelleDstModule, PhysicsObjectsMiraBelleHadronModule, PhysicsObjectsMiraBelleModule, ECLBackgroundModule, ECLChargedPIDModule, ECLChargedPIDDataAnalysisModule, ECLChargedPIDDataAnalysisValidationModule, ECLClusterPSDModule, ECLCovarianceMatrixModule, ECLCRFinderModule, ECLDataAnalysisModule, ECLDigitCalibratorModule, ECLDigitizerModule, ECLDigitizerPureCsIModule, EclDisplayModule, ECLDQMModule, ECLDQMEXTENDEDModule, ECLDQMOutOfTimeDigitsModule, ECLFinalizerModule, ECLHitDebugModule, ECLLocalMaximumFinderModule, ECLLocalRunCalibratorModule, ECLLOMModule, ECLPackerModule, ECLShowerCorrectorModule, ECLShowerShapeModule, ECLSplitterN1Module, ECLSplitterN2Module, ECLUnpackerModule, ECLWaveformFitModule, HistoModule, SubEventModule, SwitchDataStoreModule, EventInfoPrinterModule, RandomBarrierModule, HistoManagerModule, StatisticsSummaryModule, SeqRootInputModule, SeqRootOutputModule, RxModule, TxModule, ZMQTxInputModule, ZMQTxWorkerModule, EvtGenDecayModule, OverrideGenerationFlagsModule, BKLMAnaModule, BKLMDigitAnalyzerModule, BKLMSimHistogrammerModule, BKLMTrackingModule, EKLMDataCheckerModule, KLMClusterEfficiencyModule, KLMClustersReconstructorModule, KLMDigitizerModule, KLMDQMModule, KLMDQM2Module, KLMPackerModule, KLMReconstructorModule, KLMScintillatorSimulatorModule, KLMUnpackerModule, AWESOMEBasicModule, PXDBackgroundModule, PXDClustersFromTracksModule, PXDPerformanceModule, Convert2RawDetModule, PrintDataModule, PrintEventRateModule, Root2BinaryModule, CDCDedxDQMModule, CDCDedxValidationModule, EventT0ValidationModule, DataWriterModule, KlongValidationModule, KLMMuonIDDNNExpertModule, FullSimModule, SVDBackgroundModule, SVDClusterCalibrationsMonitorModule, SVDHotStripFinderModule, SVDLatencyCalibrationModule, SVDLocalCalibrationsMonitorModule, SVDPositionErrorScaleFactorImporterModule, SVDTimeCalibrationsMonitorModule, svdDumpModule, SVDPackerModule, SVDB4CommissioningPlotsModule, SVDClusterEvaluationModule, SVDClusterEvaluationTrueInfoModule, SVDClusterFilterModule, SVDOccupancyAnalysisModule, SVDPerformanceModule, SVDShaperDigitsFromTracksModule, SVDClusterizerModule, SVDCoGTimeEstimatorModule, SVDDataFormatCheckModule, SVDRecoDigitCreatorModule, SVD3SamplesEmulatorModule, SVDTriggerQualityGeneratorModule, SVDUnpackerModule, TOPBackgroundModule, TOPChannelT0MCModule, TOPTriggerDigitizerModule, TOPDoublePulseGeneratorModule, TOPGainEfficiencyCalculatorModule, TOPLaserHitSelectorModule, TOPInterimFENtupleModule, TOPLaserCalibratorModule, TOPMCTrackMakerModule, TOPNtupleModule, TOPPackerModule, TOPRawDigitConverterModule, TOPTBCComparatorModule, TOPTimeBaseCalibratorModule, TOPUnpackerModule, TOPWaveformFeatureExtractorModule, TOPWaveformQualityPlotterModule, TOPXTalkChargeShareSetterModule, ExtModule, GenfitVisModule, MCV0MatcherModule, MCTrackCandClassifierModule, MuidModule, MCSlowPionPXDROICreatorModule, PXDROIFinderModule, SVDROIDQMModule, SVDROIFinderAnalysisModule, SVDROIFinderModule, RT2SPTCConverterModule, SPTCmomentumSeedRetrieverModule, SPTCvirtualIPRemoverModule, TrackFinderMCTruthRecoTracksModule, EffPlotsModule, HitXPModule, TrackingPerformanceEvaluationModule, V0findingPerformanceEvaluationModule, SecMapTrainerBaseModule, SecMapTrainerVXDTFModule, TrackFinderVXDAnalizerModule, VXDSimpleClusterizerModule, NoKickCutsEvalModule, SectorMapBootstrapModule, VXDTFTrainingDataCollectorModule, FindletModule< AFindlet >, FindletModule< HitBasedT0Extractor >, FindletModule< CKFToSVDSeedFindlet >, FindletModule< CKFToSVDFindlet >, FindletModule< CosmicsTrackMergerFindlet >, FindletModule< DATCONFPGAFindlet >, FindletModule< MCVXDCDCTrackMergerFindlet >, FindletModule< vxdHoughTracking::SVDHoughTracking >, FindletModule< CKFToCDCFindlet >, FindletModule< CKFToCDCFromEclFindlet >, FindletModule< CKFToPXDFindlet >, FindletModule< AsicBackgroundLibraryCreator >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromHitsFindlet >, FindletModule< CDCTrackingEventLevelMdstInfoFillerFromSegmentsFindlet >, FindletModule< AxialSegmentPairCreator >, FindletModule< AxialStraightTrackFinder >, FindletModule< AxialTrackCreatorMCTruth >, FindletModule< AxialTrackCreatorSegmentHough >, FindletModule< AxialTrackFinderHough >, FindletModule< AxialTrackFinderLegendre >, FindletModule< ClusterBackgroundDetector >, FindletModule< ClusterPreparer >, FindletModule< ClusterRefiner< BridgingWireHitRelationFilter > >, FindletModule< FacetCreator >, FindletModule< HitReclaimer >, FindletModule< MonopoleAxialTrackFinderLegendre >, FindletModule< MonopoleStereoHitFinder >, FindletModule< MonopoleStereoHitFinderQuadratic >, FindletModule< SegmentCreatorFacetAutomaton >, FindletModule< SegmentCreatorMCTruth >, FindletModule< SegmentFinderFacetAutomaton >, FindletModule< SegmentFitter >, FindletModule< SegmentLinker >, FindletModule< SegmentOrienter >, FindletModule< SegmentPairCreator >, FindletModule< SegmentRejecter >, FindletModule< SegmentTrackCombiner >, FindletModule< SegmentTripleCreator >, FindletModule< StereoHitFinder >, FindletModule< SuperClusterCreator >, FindletModule< TrackCombiner >, FindletModule< TrackCreatorSegmentPairAutomaton >, FindletModule< TrackCreatorSegmentTripleAutomaton >, FindletModule< TrackCreatorSingleSegments >, FindletModule< TrackExporter >, FindletModule< TrackFinderAutomaton >, FindletModule< TrackFinderCosmics >, FindletModule< TrackFinder >, FindletModule< TrackFinderSegmentPairAutomaton >, FindletModule< TrackFinderSegmentTripleAutomaton >, FindletModule< TrackFlightTimeAdjuster >, FindletModule< TrackLinker >, FindletModule< TrackOrienter >, FindletModule< TrackQualityAsserter >, FindletModule< TrackQualityEstimator >, FindletModule< TrackRejecter >, FindletModule< WireHitBackgroundDetector >, FindletModule< WireHitCreator >, FindletModule< WireHitPreparer >, CDCTriggerNeuroDQMModule, CDCTriggerNeuroDQMOnlineModule, CDCTriggerNDFinderModule, TRGCDCModule, TRGCDCETFUnpackerModule, TRGCDCT2DDQMModule, TRGCDCT3DConverterModule, TRGCDCT3DDQMModule, TRGCDCT3DUnpackerModule, TRGCDCTSFDQMModule, TRGCDCTSFUnpackerModule, TRGCDCTSStreamModule, MCMatcherTRGECLModule, TRGECLFAMModule, TRGECLModule, TRGECLBGTCHitModule, TRGECLDQMModule, TRGECLQAMModule, TRGECLRawdataAnalysisModule, TRGECLTimingCalModule, TRGECLUnpackerModule, TRGGDLModule, TRGGDLDQMModule, TRGGDLDSTModule, TRGGDLSummaryModule, TRGGDLUnpackerModule, TRGGRLMatchModule, TRGGRLModule, TRGGRLProjectsModule, TRGGRLDQMModule, TRGGRLUnpackerModule, KLMTriggerModule, TRGTOPDQMModule, TRGTOPTRD2TTSConverterModule, TRGTOPUnpackerModule, TRGTOPUnpackerWaveformModule, TRGTOPWaveformPlotterModule, TRGRAWDATAModule, DQMHistAnalysisARICHModule, DQMHistAnalysisARICHMonObjModule, DQMHistAnalysisCDCDedxModule, DQMHistAnalysisCDCEpicsModule, DQMHistAnalysisCDCMonObjModule, DQMHistAnalysisDAQMonObjModule, DQMHistAnalysisECLModule, DQMHistAnalysisECLConnectedRegionsModule, DQMHistAnalysisECLOutOfTimeDigitsModule, DQMHistAnalysisECLShapersModule, DQMHistAnalysisECLSummaryModule, DQMHistAnalysisEpicsExampleModule, DQMHistAnalysisExampleModule, DQMHistAnalysisExampleFlagsModule, DQMHistAnalysisHLTMonObjModule, DQMHistAnalysisInput2Module, DQMHistAnalysisInputPVSrvModule, DQMHistAnalysisInputTestModule, DQMHistAnalysisKLMModule, DQMHistAnalysisKLM2Module, DQMHistAnalysisMiraBelleModule, DQMHistAnalysisMonObjModule, DQMHistAnalysisOutputFileModule, DQMHistAnalysisOutputMonObjModule, DQMHistAnalysisOutputRelayMsgModule, DQMHistAnalysisPXDFitsModule, DQMHistAnalysisSVDClustersOnTrackModule, DQMHistAnalysisSVDDoseModule, DQMHistAnalysisSVDEfficiencyModule, DQMHistAnalysisSVDGeneralModule, DQMHistAnalysisSVDOccupancyModule, DQMHistAnalysisSVDOnMiraBelleModule, DQMHistAnalysisSVDUnpackerModule, DQMHistAnalysisTOPModule, DQMHistAnalysisTRGECLModule, DQMHistAnalysisTRGGDLModule, DQMHistComparitorModule, DQMHistDeltaHistoModule, DQMHistReferenceModule, DQMHistSnapshotsModule, PyModule, SVDUnpackerDQMModule, TrackSetEvaluatorHopfieldNNDEVModule, vxdDigitMaskingModule, DQMHistAnalysisDeltaEpicsMonObjExampleModule, DQMHistAnalysisDeltaTestModule, DQMHistAnalysisEpicsOutputModule, DQMHistAnalysisPhysicsModule, DQMHistAnalysisPXDChargeModule, DQMHistAnalysisPXDTrackChargeModule, DQMHistAnalysisRooFitExampleModule, DQMHistAnalysisTRGModule, and DQMHistOutputToEPICSModule.

Definition at line 166 of file Module.h.

166{};

◆ evalCondition()

bool evalCondition ( ) const
inherited

If at least one condition was set, it is evaluated and true returned if at least one condition returns true.

If no condition or result value was defined, the method returns false. Otherwise, the condition is evaluated and true returned, if at least one condition returns true. To speed up the evaluation, the condition strings were already parsed in the method if_value().

Returns
True if at least one condition and return value exists and at least one condition expression was evaluated to true.

Definition at line 96 of file Module.cc.

97{
98 if (m_conditions.empty()) return false;
99
100 //okay, a condition was set for this Module...
101 if (!m_hasReturnValue) {
102 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
103 }
104
105 for (const auto& condition : m_conditions) {
106 if (condition.evaluate(m_returnValue)) {
107 return true;
108 }
109 }
110 return false;
111}
int m_returnValue
The return value.
Definition: Module.h:519
bool m_hasReturnValue
True, if the return value is set.
Definition: Module.h:518

◆ event()

void event ( void  )
overridevirtual

Module functions to be called from event process.

Reimplemented from DeSerializerModule.

Reimplemented in DeSerializerFILEModule.

Definition at line 470 of file DeSerializerCOPPER.cc.

471{
472
473#ifdef NONSTOP
474 // Check run-pause request
475 if (g_run_pause > 0 || g_run_error > 0) {
476 waitResume(); // Stand-by loop
477 m_eventMetaDataPtr.create(); // Otherwise endRun() is called.
478 return;
479 }
480#endif
481
482 if (m_start_flag == 0) {
483 // Use shared memory to start(for HSLB dummy data)
484
485 if (g_status.isAvailable()) {
486 B2INFO("DeSerializerCOPPER: Waiting for Start...\n");
487 g_status.reportRunning();
488 }
489
490 m_start_time = getTimeSec();
491 n_basf2evt = 0;
492#ifdef YAMADA_DUMMY
493 B2INFO("Opening COPPER...");
494 fflush(stderr);
495 openCOPPER();
496 B2INFO("Done.\n");
497 fflush(stderr);
498#endif
499 }
500
501
502 for (int j = 0; j < NUM_EVT_PER_BASF2LOOP_COPPER; j++) {
503 int m_size_word = 0;
504 int delete_flag = 0;
505 if (m_start_flag == 0) {
506 B2INFO("DeSerializerCOPPER: Reading the 1st event from COPPER FIFO...");
507 }
508
509 int* temp_buf;
510 try {
511 temp_buf = readOneEventFromCOPPERFIFO(j, &delete_flag, &m_size_word);
512 g_status.copyEventHeader(temp_buf);
513 } catch (const string& err_str) {
514
515#ifdef NONSTOP
516 if (err_str == "RUN_PAUSE" || err_str == "RUN_ERROR") {
517 // Create EventMetaData otherwise endRun() is called.
518 m_eventMetaDataPtr.create();
519 return;
520 }
521#endif
522 print_err.PrintError(m_shmflag, &g_status, err_str);
523 exit(1);
524 }
525
526 if (m_start_flag == 0) {
527 B2INFO("DeSerializerCOPPER: Done. the size of the 1st event is " << m_size_word << "words");
528 m_start_flag = 1;
529 }
530
531 const int num_nodes = 1;
532 const int num_events = 1;
533 RawDataBlock* temp_rawdblk = raw_dblkarray.appendNew();
534 temp_rawdblk->SetBuffer(temp_buf, m_size_word, delete_flag, num_events, num_nodes);
535 // Fill Header and Trailer
536
537 PreRawCOPPERFormat_latest temp_rawcopper;
538 temp_rawcopper.SetBuffer(temp_buf, m_size_word, 0, num_events, num_nodes);
539
540 // Fill header and trailer
541 try {
544 // fillNewRawCOPPERHeader( &temp_rawcopper );
545 } catch (const string& err_str) {
546 print_err.PrintError(m_shmflag, &g_status, err_str);
547 exit(1);
548 }
549
550 if (m_dump_fname.size() > 0) {
551 dumpData((char*)temp_buf, m_size_word * sizeof(int));
552 }
553 m_totbytes += m_size_word * sizeof(int);
554 }
555
556
557 //
558 // Update EventMetaData
559 //
560 m_eventMetaDataPtr.create();
561 m_eventMetaDataPtr->setExperiment(0);
562 m_eventMetaDataPtr->setRun(0);
563 m_eventMetaDataPtr->setEvent(n_basf2evt);
564
565 //
566 // Monitor
567 //
568 if (max_nevt >= 0 || max_seconds >= 0.) {
569 if ((n_basf2evt * NUM_EVT_PER_BASF2LOOP_PC >= max_nevt && max_nevt > 0)
570 || (getTimeSec() - m_start_time > max_seconds && max_seconds > 0.)) {
571 printf("[DEBUG] RunPause was detected. ( Setting: Max event # %d MaxTime %lf ) Processed Event %d Elapsed Time %lf[s]\n",
572 max_nevt, max_seconds, n_basf2evt * NUM_EVT_PER_BASF2LOOP_PC, getTimeSec() - m_start_time);
573 m_eventMetaDataPtr->setEndOfData();
574 }
575 }
576
577 //
578 // Print current status
579 //
580 // if (n_basf2evt % 100 == 0 || n_basf2evt < 10) {
581 if (n_basf2evt % 100 == 0) {
582 RateMonitor(m_prev_ftsweve32, m_prev_exprunsubrun_no & RawHeader_latest::SUBRUNNO_MASK,
583 (m_prev_exprunsubrun_no & RawHeader_latest::RUNNO_MASK) >> RawHeader_latest::RUNNO_SHIFT);
584 }
585 n_basf2evt++;
586 if (g_status.isAvailable()) {
587 g_status.setInputNBytes(m_totbytes);
588 g_status.setInputCount(m_prev_ftsweve32 + 1);
589 }
590 return;
591}
void RateMonitor(unsigned int nevt, int subrun=-1, int run=-1)
monitor rate
unsigned int m_prev_exprunsubrun_no
run no.
Definition: DeSerializer.h:173
static RunInfoBuffer g_status
buffer class to communicate with NSM client
Definition: DeSerializer.h:200
int n_basf2evt
No. of sent events.
Definition: DeSerializer.h:86
virtual void dumpData(char *buf, int size)
dump binary data
std::string m_dump_fname
dump filename
Definition: DeSerializer.h:92
int m_shmflag
Use shared memory.
Definition: DeSerializer.h:185
unsigned int m_exprunsubrun_no
run no.
Definition: DeSerializer.h:170
double max_seconds
time to stop a run
Definition: DeSerializer.h:77
int m_nodeid
Node(PC or COPPER) ID.
Definition: DeSerializer.h:158
double getTimeSec()
store time info.
The Raw COPPER class ver.1 ( the latest version since May, 2014 ) This class stores data received by ...
unsigned int FillTopBlockRawHeader(unsigned int m_node_id, unsigned int prev_eve32, unsigned int prev_exprunsubrun_no, unsigned int *cur_exprunsubrun_no) OVERRIDE_CPP17
should be called by DeSerializerCOPPER.cc and fill contents in RawHeader
virtual void SetBuffer(int *bufin, int nwords, int delete_flag, int num_events, int num_nodes)
set buffer ( delete_flag : m_buffer is freeed( = 0 )/ not freeed( = 1 ) in Destructer )
The RawDataBlock class Base class for rawdata handling.
Definition: RawDataBlock.h:27
virtual void SetBuffer(int *bufin, int nwords, int delete_flag, int num_events, int num_nodes)
set buffer ( delete_flag : m_buffer is freeed( = 0 )/ not freeed( = 1 ) in Destructer )
Definition: RawDataBlock.cc:35

◆ exposePythonAPI()

void exposePythonAPI ( )
staticinherited

Exposes methods of the Module class to Python.

Definition at line 325 of file Module.cc.

326{
327 // to avoid confusion between std::arg and boost::python::arg we want a shorthand namespace as well
328 namespace bp = boost::python;
329
330 docstring_options options(true, true, false); //userdef, py sigs, c++ sigs
331
332 void (Module::*setReturnValueInt)(int) = &Module::setReturnValue;
333
334 enum_<Module::EAfterConditionPath>("AfterConditionPath",
335 R"(Determines execution behaviour after a conditional path has been executed:
336
337.. attribute:: END
338
339 End processing of this path after the conditional path. (this is the default for if_value() etc.)
340
341.. attribute:: CONTINUE
342
343 After the conditional path, resume execution after this module.)")
344 .value("END", Module::EAfterConditionPath::c_End)
345 .value("CONTINUE", Module::EAfterConditionPath::c_Continue)
346 ;
347
348 /* Do not change the names of >, <, ... we use them to serialize conditional pathes */
349 enum_<Belle2::ModuleCondition::EConditionOperators>("ConditionOperator")
356 ;
357
358 enum_<Module::EModulePropFlags>("ModulePropFlags",
359 R"(Flags to indicate certain low-level features of modules, see :func:`Module.set_property_flags()`, :func:`Module.has_properties()`. Most useful flags are:
360
361.. attribute:: PARALLELPROCESSINGCERTIFIED
362
363 This module can be run in parallel processing mode safely (All I/O must be done through the data store, in particular, the module must not write any files.)
364
365.. attribute:: HISTOGRAMMANAGER
366
367 This module is used to manage histograms accumulated by other modules
368
369.. attribute:: TERMINATEINALLPROCESSES
370
371 When using parallel processing, call this module's terminate() function in all processes. This will also ensure that there is exactly one process (single-core if no parallel modules found) or at least one input, one main and one output process.
372)")
373 .value("INPUT", Module::EModulePropFlags::c_Input)
374 .value("OUTPUT", Module::EModulePropFlags::c_Output)
375 .value("PARALLELPROCESSINGCERTIFIED", Module::EModulePropFlags::c_ParallelProcessingCertified)
376 .value("HISTOGRAMMANAGER", Module::EModulePropFlags::c_HistogramManager)
377 .value("INTERNALSERIALIZER", Module::EModulePropFlags::c_InternalSerializer)
378 .value("TERMINATEINALLPROCESSES", Module::EModulePropFlags::c_TerminateInAllProcesses)
379 ;
380
381 //Python class definition
382 class_<Module, PyModule> module("Module", R"(
383Base class for Modules.
384
385A module is the smallest building block of the framework.
386A typical event processing chain consists of a Path containing
387modules. By inheriting from this base class, various types of
388modules can be created. To use a module, please refer to
389:func:`Path.add_module()`. A list of modules is available by running
390``basf2 -m`` or ``basf2 -m package``, detailed information on parameters is
391given by e.g. ``basf2 -m RootInput``.
392
393The 'Module Development' section in the manual provides detailed information
394on how to create modules, setting parameters, or using return values/conditions:
395https://confluence.desy.de/display/BI/Software+Basf2manual#Module_Development
396
397)");
398 module
399 .def("__str__", &Module::getPathString)
400 .def("name", &Module::getName, return_value_policy<copy_const_reference>(),
401 "Returns the name of the module. Can be changed via :func:`set_name() <Module.set_name()>`, use :func:`type() <Module.type()>` for identifying a particular module class.")
402 .def("type", &Module::getType, return_value_policy<copy_const_reference>(),
403 "Returns the type of the module (i.e. class name minus 'Module')")
404 .def("set_name", &Module::setName, args("name"), R"(
405Set custom name, e.g. to distinguish multiple modules of the same type.
406
407>>> path.add_module('EventInfoSetter')
408>>> ro = path.add_module('RootOutput', branchNames=['EventMetaData'])
409>>> ro.set_name('RootOutput_metadata_only')
410>>> print(path)
411[EventInfoSetter -> RootOutput_metadata_only]
412
413)")
414 .def("description", &Module::getDescription, return_value_policy<copy_const_reference>(),
415 "Returns the description of this module.")
416 .def("package", &Module::getPackage, return_value_policy<copy_const_reference>(),
417 "Returns the package this module belongs to.")
418 .def("available_params", &_getParamInfoListPython,
419 "Return list of all module parameters as `ModuleParamInfo` instances")
420 .def("has_properties", &Module::hasProperties, (bp::arg("properties")),
421 R"DOCSTRING(Allows to check if the module has the given properties out of `ModulePropFlags` set.
422
423>>> if module.has_properties(ModulePropFlags.PARALLELPROCESSINGCERTIFIED):
424>>> ...
425
426Parameters:
427 properties (int): bitmask of `ModulePropFlags` to check for.
428)DOCSTRING")
429 .def("set_property_flags", &Module::setPropertyFlags, args("property_mask"),
430 "Set module properties in the form of an OR combination of `ModulePropFlags`.");
431 {
432 // python signature is too crowded, make ourselves
433 docstring_options subOptions(true, false, false); //userdef, py sigs, c++ sigs
434 module
435 .def("if_value", &Module::if_value,
436 (bp::arg("expression"), bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
437 R"DOCSTRING(if_value(expression, condition_path, after_condition_path=AfterConditionPath.END)
438
439Sets a conditional sub path which will be executed after this
440module if the return value set in the module passes the given ``expression``.
441
442Modules can define a return value (int or bool) using ``setReturnValue()``,
443which can be used in the steering file to split the Path based on this value, for example
444
445>>> module_with_condition.if_value("<1", another_path)
446
447In case the return value of the ``module_with_condition`` for a given event is
448less than 1, the execution will be diverted into ``another_path`` for this event.
449
450You could for example set a special return value if an error occurs, and divert
451the execution into a path containing :b2:mod:`RootOutput` if it is found;
452saving only the data producing/produced by the error.
453
454After a conditional path has executed, basf2 will by default stop processing
455the path for this event. This behaviour can be changed by setting the
456``after_condition_path`` argument.
457
458Parameters:
459 expression (str): Expression to determine if the conditional path should be executed.
460 This should be one of the comparison operators ``<``, ``>``, ``<=``,
461 ``>=``, ``==``, or ``!=`` followed by a numerical value for the return value
462 condition_path (Path): path to execute in case the expression is fulfilled
463 after_condition_path (AfterConditionPath): What to do once the ``condition_path`` has been executed.
464)DOCSTRING")
465 .def("if_false", &Module::if_false,
466 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
467 R"DOC(if_false(condition_path, after_condition_path=AfterConditionPath.END)
468
469Sets a conditional sub path which will be executed after this module if
470the return value of the module evaluates to False. This is equivalent to
471calling `if_value` with ``expression=\"<1\"``)DOC")
472 .def("if_true", &Module::if_true,
473 (bp::arg("condition_path"), bp::arg("after_condition_path")= Module::EAfterConditionPath::c_End),
474 R"DOC(if_true(condition_path, after_condition_path=AfterConditionPath.END)
475
476Sets a conditional sub path which will be executed after this module if
477the return value of the module evaluates to True. It is equivalent to
478calling `if_value` with ``expression=\">=1\"``)DOC");
479 }
480 module
481 .def("has_condition", &Module::hasCondition,
482 "Return true if a conditional path has been set for this module "
483 "using `if_value`, `if_true` or `if_false`")
484 .def("get_all_condition_paths", &_getAllConditionPathsPython,
485 "Return a list of all conditional paths set for this module using "
486 "`if_value`, `if_true` or `if_false`")
487 .def("get_all_conditions", &_getAllConditionsPython,
488 "Return a list of all conditional path expressions set for this module using "
489 "`if_value`, `if_true` or `if_false`")
490 .add_property("logging", make_function(&Module::getLogConfig, return_value_policy<reference_existing_object>()),
@ c_GE
Greater or equal than: ">=".
@ c_SE
Smaller or equal than: "<=".
@ c_GT
Greater than: ">"
@ c_NE
Not equal: "!=".
@ c_EQ
Equal: "=" or "=="
@ c_ST
Smaller than: "<"
Base class for Modules.
Definition: Module.h:72
LogConfig & getLogConfig()
Returns the log system configuration.
Definition: Module.h:225
void if_value(const std::string &expression, const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
Add a condition to the module.
Definition: Module.cc:79
void setPropertyFlags(unsigned int propertyFlags)
Sets the flags for the module properties.
Definition: Module.cc:208
void if_true(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to set the condition of the module.
Definition: Module.cc:90
void setReturnValue(int value)
Sets the return value for this module as integer.
Definition: Module.cc:220
void setLogConfig(const LogConfig &logConfig)
Set the log system configuration.
Definition: Module.h:230
const std::string & getDescription() const
Returns the description of the module.
Definition: Module.h:202
void if_false(const std::shared_ptr< Path > &path, EAfterConditionPath afterConditionPath=EAfterConditionPath::c_End)
A simplified version to add a condition to the module.
Definition: Module.cc:85
bool hasCondition() const
Returns true if at least one condition was set for the module.
Definition: Module.h:311
const std::string & getPackage() const
Returns the package this module is in.
Definition: Module.h:197
void setName(const std::string &name)
Set the name of the module.
Definition: Module.h:214
bool hasProperties(unsigned int propertyFlags) const
Returns true if all specified property flags are available in this module.
Definition: Module.cc:160
std::string getPathString() const override
return the module name.
Definition: Module.cc:192

◆ getAfterConditionPath()

Module::EAfterConditionPath getAfterConditionPath ( ) const
inherited

What to do after the conditional path is finished.

(defaults to c_End if no condition is set)

Definition at line 133 of file Module.cc.

134{
135 if (m_conditions.empty()) return EAfterConditionPath::c_End;
136
137 //okay, a condition was set for this Module...
138 if (!m_hasReturnValue) {
139 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
140 }
141
142 for (const auto& condition : m_conditions) {
143 if (condition.evaluate(m_returnValue)) {
144 return condition.getAfterConditionPath();
145 }
146 }
147
148 return EAfterConditionPath::c_End;
149}

◆ getAllConditionPaths()

std::vector< std::shared_ptr< Path > > getAllConditionPaths ( ) const
inherited

Return all condition paths currently set (no matter if the condition is true or not).

Definition at line 150 of file Module.cc.

151{
152 std::vector<std::shared_ptr<Path>> allConditionPaths;
153 for (const auto& condition : m_conditions) {
154 allConditionPaths.push_back(condition.getPath());
155 }
156
157 return allConditionPaths;
158}

◆ getAllConditions()

const std::vector< ModuleCondition > & getAllConditions ( ) const
inlineinherited

Return all set conditions for this module.

Definition at line 324 of file Module.h.

325 {
326 return m_conditions;
327 }

◆ getCondition()

const ModuleCondition * getCondition ( ) const
inlineinherited

Return a pointer to the first condition (or nullptr, if none was set)

Definition at line 314 of file Module.h.

315 {
316 if (m_conditions.empty()) {
317 return nullptr;
318 } else {
319 return &m_conditions.front();
320 }
321 }

◆ getConditionPath()

std::shared_ptr< Path > getConditionPath ( ) const
inherited

Returns the path of the last true condition (if there is at least one, else reaturn a null pointer).


Definition at line 113 of file Module.cc.

114{
115 PathPtr p;
116 if (m_conditions.empty()) return p;
117
118 //okay, a condition was set for this Module...
119 if (!m_hasReturnValue) {
120 B2FATAL("A condition was set for '" << getName() << "', but the module did not set a return value!");
121 }
122
123 for (const auto& condition : m_conditions) {
124 if (condition.evaluate(m_returnValue)) {
125 return condition.getPath();
126 }
127 }
128
129 // if none of the conditions were true, return a null pointer.
130 return p;
131}
std::shared_ptr< Path > PathPtr
Defines a pointer to a path object as a boost shared pointer.
Definition: Path.h:35

◆ getDescription()

const std::string & getDescription ( ) const
inlineinherited

Returns the description of the module.

Definition at line 202 of file Module.h.

202{return m_description;}
std::string m_description
The description of the module.
Definition: Module.h:511

◆ getFileNames()

virtual std::vector< std::string > getFileNames ( bool  outputFiles)
inlinevirtualinherited

Return a list of output filenames for this modules.

This will be called when basf2 is run with "--dry-run" if the module has set either the c_Input or c_Output properties.

If the parameter outputFiles is false (for modules with c_Input) the list of input filenames should be returned (if any). If outputFiles is true (for modules with c_Output) the list of output files should be returned (if any).

If a module has sat both properties this member is called twice, once for each property.

The module should return the actual list of requested input or produced output filenames (including handling of input/output overrides) so that the grid system can handle input/output files correctly.

This function should return the same value when called multiple times. This is especially important when taking the input/output overrides from Environment as they get consumed when obtained so the finalized list of output files should be stored for subsequent calls.

Reimplemented in RootInputModule, StorageRootOutputModule, and RootOutputModule.

Definition at line 134 of file Module.h.

135 {
136 return std::vector<std::string>();
137 }

◆ getLogConfig()

LogConfig & getLogConfig ( )
inlineinherited

Returns the log system configuration.

Definition at line 225 of file Module.h.

225{return m_logConfig;}

◆ getModules()

std::list< ModulePtr > getModules ( ) const
inlineoverrideprivatevirtualinherited

no submodules, return empty list

Implements PathElement.

Definition at line 506 of file Module.h.

506{ return std::list<ModulePtr>(); }

◆ getName()

const std::string & getName ( ) const
inlineinherited

Returns the name of the module.

This can be changed via e.g. set_name() in the steering file to give more useful names if there is more than one module of the same type.

For identifying the type of a module, using getType() (or type() in Python) is recommended.

Definition at line 187 of file Module.h.

187{return m_name;}
std::string m_name
The name of the module, saved as a string (user-modifiable)
Definition: Module.h:508

◆ getNewBuffer()

int * getNewBuffer ( int  nwords,
int *  delete_flag 
)
protectedvirtualinherited

Getbuffer.

Definition at line 250 of file DeSerializer.cc.

251{
252
253 int* temp_buf = NULL;
254 // Prepare buffer
255 // printf( "[DEBUG] ############ %d %d %d %d\n", nwords, BUF_SIZE_WORD, m_num_usedbuf, NUM_PREALLOC_BUF );
256 if (nwords > BUF_SIZE_WORD) {
257 *delete_flag = 1;
258 temp_buf = new int[ nwords ];
259 } else {
260 if ((temp_buf = getPreAllocBuf()) == 0x0) {
261 char err_buf[500];
262 sprintf(err_buf, "[FATAL] Null pointer from GetPreALlocBuf(). Exting...\n");
263 print_err.PrintError(err_buf, __FILE__, __PRETTY_FUNCTION__, __LINE__);
264 sleep(1234567);
265 exit(1);
266 } else {
267 *delete_flag = 0;
268 }
269 }
270
271 return temp_buf;
272
273}
virtual int * getPreAllocBuf()
Getbuffer.
int BUF_SIZE_WORD
size of buffer for one event (word)
Definition: DeSerializer.h:83

◆ getPackage()

const std::string & getPackage ( ) const
inlineinherited

Returns the package this module is in.

Definition at line 197 of file Module.h.

197{return m_package;}

◆ getParamInfoListPython()

std::shared_ptr< boost::python::list > getParamInfoListPython ( ) const
inherited

Returns a python list of all parameters.

Each item in the list consists of the name of the parameter, a string describing its type, a python list of all default values and the description of the parameter.

Returns
A python list containing the parameters of this parameter list.

Definition at line 279 of file Module.cc.

280{
282}
std::shared_ptr< boost::python::list > getParamInfoListPython() const
Returns a python list of all parameters.
ModuleParamList m_moduleParamList
List storing and managing all parameter of the module.
Definition: Module.h:516

◆ getParamList()

const ModuleParamList & getParamList ( ) const
inlineinherited

Return module param list.

Definition at line 363 of file Module.h.

363{ return m_moduleParamList; }

◆ getPathString()

std::string getPathString ( ) const
overrideprivatevirtualinherited

return the module name.

Implements PathElement.

Definition at line 192 of file Module.cc.

193{
194
195 std::string output = getName();
196
197 for (const auto& condition : m_conditions) {
198 output += condition.getString();
199 }
200
201 return output;
202}

◆ getPreAllocBuf()

int * getPreAllocBuf ( )
protectedvirtualinherited

Getbuffer.

Definition at line 275 of file DeSerializer.cc.

276{
277 int* tempbuf = 0;
278 if (m_num_usedbuf < NUM_PREALLOC_BUF) {
279 tempbuf = m_bufary[ m_num_usedbuf ];
281 } else {
282 char err_buf[500];
283 sprintf(err_buf,
284 "[FATAL] No pre-allocated buffers are left. %d > %d. Not enough buffers are allocated or memory leak or forget to call ClearNumUsedBuf every event loop. Exting...",
285 m_num_usedbuf, NUM_PREALLOC_BUF);
286 print_err.PrintError(err_buf, __FILE__, __PRETTY_FUNCTION__, __LINE__);
287 sleep(1234567);
288 exit(1);
289 }
290 return tempbuf;
291}
int * m_bufary[NUM_PREALLOC_BUF]
buffer
Definition: DeSerializer.h:101

◆ getReturnValue()

int getReturnValue ( ) const
inlineinherited

Return the return value set by this module.

This value is only meaningful if hasReturnValue() is true

Definition at line 381 of file Module.h.

381{ return m_returnValue; }

◆ getStatus()

static RunInfoBuffer & getStatus ( )
inlinestaticinherited

Definition at line 250 of file DeSerializer.h.

251 {
252 return g_status;
253 }

◆ getTimeSec()

double getTimeSec ( )
protectedinherited

store time info.

Definition at line 184 of file DeSerializer.cc.

185{
186 struct timeval t;
187 gettimeofday(&t, NULL);
188 return (t.tv_sec + t.tv_usec * 1.e-6);
189}

◆ getType()

const std::string & getType ( ) const
inherited

Returns the type of the module (i.e.

class name minus 'Module')

Definition at line 41 of file Module.cc.

42{
43 if (m_type.empty())
44 B2FATAL("Module type not set for " << getName());
45 return m_type;
46}
std::string m_type
The type of the module, saved as a string.
Definition: Module.h:509

◆ hasCondition()

bool hasCondition ( ) const
inlineinherited

Returns true if at least one condition was set for the module.

Definition at line 311 of file Module.h.

311{ return not m_conditions.empty(); };

◆ hasProperties()

bool hasProperties ( unsigned int  propertyFlags) const
inherited

Returns true if all specified property flags are available in this module.

Parameters
propertyFlagsOred EModulePropFlags which should be compared with the module flags.

Definition at line 160 of file Module.cc.

161{
162 return (propertyFlags & m_propertyFlags) == propertyFlags;
163}

◆ hasReturnValue()

bool hasReturnValue ( ) const
inlineinherited

Return true if this module has a valid return value set.

Definition at line 378 of file Module.h.

378{ return m_hasReturnValue; }

◆ hasUnsetForcedParams()

bool hasUnsetForcedParams ( ) const
inherited

Returns true and prints error message if the module has unset parameters which the user has to set in the steering file.

Definition at line 166 of file Module.cc.

167{
169 std::string allMissing = "";
170 for (const auto& s : missing)
171 allMissing += s + " ";
172 if (!missing.empty())
173 B2ERROR("The following required parameters of Module '" << getName() << "' were not specified: " << allMissing <<
174 "\nPlease add them to your steering file.");
175 return !missing.empty();
176}
std::vector< std::string > getUnsetForcedParams() const
Returns list of unset parameters (if they are required to have a value.

◆ if_false()

void if_false ( const std::shared_ptr< Path > &  path,
EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End 
)
inherited

A simplified version to add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression "<1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters
pathShared pointer to the Path which will be executed if the return value is false.
afterConditionPathWhat to do after executing 'path'.

Definition at line 85 of file Module.cc.

86{
87 if_value("<1", path, afterConditionPath);
88}

◆ if_true()

void if_true ( const std::shared_ptr< Path > &  path,
EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End 
)
inherited

A simplified version to set the condition of the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

It is equivalent to the if_value() method, using the expression ">=1". This method is meant to be used together with the setReturnValue(bool value) method.

Parameters
pathShared pointer to the Path which will be executed if the return value is true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 90 of file Module.cc.

91{
92 if_value(">=1", path, afterConditionPath);
93}

◆ if_value()

void if_value ( const std::string &  expression,
const std::shared_ptr< Path > &  path,
EAfterConditionPath  afterConditionPath = EAfterConditionPath::c_End 
)
inherited

Add a condition to the module.

Please note that successive calls of this function will add more than one condition to the module. If more than one condition results in true, only the last of them will be used.

See https://confluence.desy.de/display/BI/Software+ModCondTut or ModuleCondition for a description of the syntax.

Please be careful: Avoid creating cyclic paths, e.g. by linking a condition to a path which is processed before the path where this module is located in.

Parameters
expressionThe expression of the condition.
pathShared pointer to the Path which will be executed if the condition is evaluated to true.
afterConditionPathWhat to do after executing 'path'.

Definition at line 79 of file Module.cc.

80{
81 m_conditions.emplace_back(expression, path, afterConditionPath);
82}

◆ initialize()

void initialize ( void  )
overridevirtual

Module functions to be called from main process.

Reimplemented from DeSerializerModule.

Reimplemented in DeSerializerFILEModule.

Definition at line 64 of file DeSerializerCOPPER.cc.

65{
66 B2INFO("DeSerializerCOPPER: initialize() started.");
67 // allocate buffer
68 for (int i = 0 ; i < NUM_PREALLOC_BUF; i++) {
69 m_bufary[i] = new int[ BUF_SIZE_WORD ];
70 }
71 m_buffer = new int[ BUF_SIZE_WORD ];
72
73 //
74 // Initialize basf2 related
75 //
76 for (int i = 0 ; i < NUM_PREALLOC_BUF; i++) {
77 memset(m_bufary[i], 0, BUF_SIZE_WORD * sizeof(int));
78 }
79
80 // Initialize EvtMetaData
81 m_eventMetaDataPtr.registerInDataStore();
82
83 // Initialize Array of RawCOPPER
84 // rawcprarray.registerInDataStore();
85 raw_dblkarray.registerInDataStore();
86
87 if (m_dump_fname.size() > 0) {
89 }
90 memset(time_array0, 0, sizeof(time_array0));
91 memset(time_array1, 0, sizeof(time_array1));
92 memset(time_array2, 0, sizeof(time_array2));
93 memset(time_array3, 0, sizeof(time_array3));
94 memset(time_array4, 0, sizeof(time_array4));
95 memset(time_array5, 0, sizeof(time_array5));
96
97 // initialize COPPER
99
100 //
101 // report ready to SLC
102 //
103 if (m_shmflag > 0) {
104 if (m_nodename.size() == 0 || m_nodeid < 0) {
105 m_shmflag = 0;
106 } else {
107 printf("nodename = %s\n", m_nodename.c_str());
109 g_status.reportReady();
110 }
111 }
112
113#ifdef NONSTOP
114 openRunPauseNshm();
115#endif
116
117 B2INFO("DeSerializerCOPPER: initialize() done.");
118}
virtual void initializeCOPPER()
Module functions to be called from main process.
std::string m_nodename
Node name.
Definition: DeSerializer.h:161
virtual void openOutputFile()
Module functions to be called from event process.

◆ initializeCOPPER()

void initializeCOPPER ( )
privatevirtual

Module functions to be called from main process.

Definition at line 123 of file DeSerializerCOPPER.cc.

124{
125
126#ifndef DUMMY
127 m_use_slot = 0; /* bit mask */
128 int slot_shift;
129
130 if ((m_finesse_bit_flag & 0x1) == 1) {
131 slot_shift = 0; // a:0, b:1, c:2, d:3
132 m_use_slot |= 1 << slot_shift; //
133 }
134
135 if (((m_finesse_bit_flag >> 1) & 0x1) == 1) {
136 slot_shift = 1; // a:0, b:1, c:2, d:3
137 m_use_slot |= 1 << slot_shift; //
138 }
139
140 if (((m_finesse_bit_flag >> 2) & 0x1) == 1) {
141 slot_shift = 2; // a:0, b:1, c:2, d:3
142 m_use_slot |= 1 << slot_shift; //
143 }
144
145 if (((m_finesse_bit_flag >> 3) & 0x1) == 1) {
146 slot_shift = 3; // a:0, b:1, c:2, d:3
147 m_use_slot |= 1 << slot_shift; //
148 }
149 //
150 // Present slots to use
151 //
152 if (! m_use_slot) {
153 char err_buf[100] = "[FATAL] Slot is not specified. Exiting...";
154 print_err.PrintError(m_shmflag, &g_status, err_buf, __FILE__, __PRETTY_FUNCTION__, __LINE__);
155 exit(1);
156 } else {
157 int slot;
158 printf("[DEBUG] ");
159 for (slot = 0; slot < 4; slot++) {
160 if (m_use_slot & (1 << slot)) printf(" %c", 'A' + slot);
161 }
162 printf("\n");
163 }
164
165
166#endif
167
168#ifndef YAMADA_DUMMY
169 B2INFO("Opening COPPER...");
170 fflush(stderr);
171 openCOPPER();
172 B2INFO("Done.\n");
173 fflush(stderr);
174#endif
175
176
177
178}
int m_use_slot
bit flag for available FINESSE slot

◆ openCOPPER()

void openCOPPER ( )
privatevirtual

Definition at line 315 of file DeSerializerCOPPER.cc.

316{
317
318 if (m_cpr_fd != -1) {
319 close(m_cpr_fd);
320 m_cpr_fd = -1;
321 }
322 //
323 // Open a finesse device
324 //
325 if ((m_cpr_fd = open("/dev/copper/copper", O_RDONLY)) == -1) {
326 char err_buf[500];
327 sprintf(err_buf, "[FATAL] Failed to open /dev/copper/copper. Exiting... ");
328 print_err.PrintError(m_shmflag, &g_status, err_buf, __FILE__, __PRETTY_FUNCTION__, __LINE__);
329 exit(1);
330 }
331
332 int set_regval = 15; // How many events to be stored in COPPER FIFO before request for DMA
333 // int set_regval=1;
334 ioctl(m_cpr_fd, CPRIOSET_LEF_WA_FF, &set_regval);
335 ioctl(m_cpr_fd, CPRIOSET_LEF_WB_FF, &set_regval);
336 ioctl(m_cpr_fd, CPRIOSET_LEF_WC_FF, &set_regval);
337 ioctl(m_cpr_fd, CPRIOSET_LEF_WD_FF, &set_regval);
338 ioctl(m_cpr_fd, CPRIOSET_FINESSE_STA, &m_use_slot, sizeof(m_use_slot));
339
340 int v = 511 - 32;
341
342 ioctl(m_cpr_fd, CPRIOSET_LEF_WA_AF, &v, sizeof(v));
343 ioctl(m_cpr_fd, CPRIOSET_LEF_WB_AF, &v, sizeof(v));
344 ioctl(m_cpr_fd, CPRIOSET_LEF_WC_AF, &v, sizeof(v));
345 ioctl(m_cpr_fd, CPRIOSET_LEF_WD_AF, &v, sizeof(v));
346
347
348 B2INFO("DeSerializerCOPPER: openCOPPER() done.");
349
350}

◆ openOutputFile()

void openOutputFile ( )
virtualinherited

Module functions to be called from event process.

Definition at line 201 of file DeSerializer.cc.

202{
203 if ((m_fp_dump = fopen(m_dump_fname.c_str(), "wb")) == NULL) {
204 char err_buf[500];
205 sprintf(err_buf, "[FATAL] Failed to open file %s. Exiting...\n", m_dump_fname.c_str());
206 print_err.PrintError(err_buf, __FILE__, __PRETTY_FUNCTION__, __LINE__);
207 exit(-1);
208 }
209}

◆ printASCIIData()

void printASCIIData ( int *  buf,
int  nwords 
)
virtualinherited

dump error data

Definition at line 233 of file DeSerializer.cc.

234{
235 char ascii_code[500];
236 sprintf(ascii_code,
237 " ! #$ &'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[ ]^_'abcdefghijklmnopqrstuvwxyz{|}~ ");
238 printf("[DEBUG]");
239 for (int i = 0; i < nwords; i++) {
240 for (int j = 0 ; j < 4; j++) {
241 printf("%c", ascii_code[(buf[ i ] >> j * 8) & 0x7f ]);
242 }
243 if (i % 10 == 9) printf("\n[DEBUG]");
244 }
245 printf("\n[DEBUG]");
246 printf("\n");
247 return;
248}

◆ printData()

void printData ( int *  buf,
int  nwords 
)
virtualinherited

dump error data

Definition at line 221 of file DeSerializer.cc.

222{
223 printf("[DEBUG]");
224 for (int i = 0; i < nwords; i++) {
225 printf("%.8x ", buf[ i ]);
226 if (i % 10 == 9) printf("\n[DEBUG]");
227 }
228 printf("\n[DEBUG]");
229 printf("\n");
230 return;
231}

◆ RateMonitor()

void RateMonitor ( unsigned int  nevt,
int  subrun = -1,
int  run = -1 
)
protectedinherited

monitor rate

Definition at line 294 of file DeSerializer.cc.

295{
296 double current_time = getTimeSec();
297 double total_time = current_time - m_start_time;
298 double interval = current_time - m_prev_time;
299 time_t timer;
300 struct tm* t_st;
301 time(&timer);
302 t_st = localtime(&timer);
303 char timeStr[100];
304 std::strftime(timeStr, sizeof(timeStr), "%Y-%m-%d %H:%M:%S\n", t_st);
305
306 printf("[INFO] run %d sub %d Event %12d Rate %6.2lf[kHz] Recvd Flow %6.2lf[MB/s] RunTime %8.2lf[s] interval %8.4lf[s] %s",
307 run, subrun,
308 nevt, (nevt - m_prev_nevt) / interval / 1.e3,
309 (m_totbytes - m_prev_totbytes) / interval / 1.e6,
310 total_time,
311 interval,
312 timeStr);
313
314 fflush(stdout);
315 m_prev_time = current_time;
316 m_prev_totbytes = m_totbytes;
317 m_prev_nevt = nevt;
318
319}
int m_prev_nevt
No. of prev sent events.
Definition: DeSerializer.h:89

◆ readFD()

int readFD ( int  fd,
char *  buf,
int  data_size_byte,
int  delete_flag 
)
privatevirtual

receive data

Definition at line 354 of file DeSerializerCOPPER.cc.

355{
356
357 int n = 0;
358 while (1) {
359 int read_size = 0;
360 if ((read_size = read(fd, (char*)buf + n, data_size_byte - n)) < 0) {
361 if (errno == EINTR) {
362 continue;
363 } else if (errno == EAGAIN || errno == EWOULDBLOCK) {
364 if (n > 0) {
365 char err_buf[500];
366 sprintf(err_buf, "[FATAL] Return due to EAGAIN in the middle of an event( COPPER driver would't do this.). Exting...");
367 print_err.PrintError(m_shmflag, &g_status, err_buf, __FILE__, __PRETTY_FUNCTION__, __LINE__);
368 exit(-1);
369 }
370#ifdef NONSTOP
371 // Check run-pause request from SLC
372 string err_str;
373 try {
374 callCheckRunPause(err_str);
375 } catch (const string& err_str) {
376 if (delete_flag) {
377 // Delete allocated buffer
378 B2WARNING("Delete buffer before going to Run-pause state");
379 delete buf;
380 }
381 throw (err_str);
382 }
383#endif
384 continue;
385 } else {
386#ifdef NONSTOP
387 g_run_error = 1;
388 printf("[ERROR] Failed to read data from COPPER. %s %s %d",
389 __FILE__, __PRETTY_FUNCTION__, __LINE__);
390 string err_str = "RUN_ERROR";
391 throw (err_str);
392#endif
393 char err_buf[500];
394 sprintf(err_buf, "[FATAL] Failed to read data from COPPER. %s %s %d",
395 __FILE__, __PRETTY_FUNCTION__, __LINE__);
396 print_err.PrintError(m_shmflag, &g_status, err_buf, __FILE__, __PRETTY_FUNCTION__, __LINE__);
397 exit(-1);
398 }
399 } else {
400 n += read_size;
401 if (n == data_size_byte)break;
402 }
403 }
404 return n;
405}

◆ readOneEventFromCOPPERFIFO()

int * readOneEventFromCOPPERFIFO ( const int  entry,
int *  delete_flag,
int *  m_size_word 
)
privatevirtual

Definition at line 181 of file DeSerializerCOPPER.cc.

182{
183#ifdef USE_PCIE40
184 char err_buf[500];
185 sprintf(err_buf, "[FATAL] This function is not supported. Exiting...: \n%s %s %d\n",
186 __FILE__, __PRETTY_FUNCTION__, __LINE__);
187 print_err.PrintError(err_buf, __FILE__, __PRETTY_FUNCTION__, __LINE__);
188 exit(1);
189#else
190 // prepare buffer
191 *m_size_word = 0;
192 int* temp_buf = m_bufary[ entry ];
193 temp_buf[0] = BUF_SIZE_WORD ;
194 *delete_flag = 0;
195
196 //
197 // Read data from HSLB
198 //
199#ifndef DUMMY
200 int recvd_byte = (m_pre_rawcpr.tmp_header.RAWHEADER_NWORDS) * sizeof(int);
201 // Firstly, read data with an allocated buffer.
202 while (1) {
203 int read_size = 0;
204 if ((read_size = read(m_cpr_fd, (char*)m_bufary[entry] + recvd_byte, sizeof(int) * BUF_SIZE_WORD - recvd_byte)) < 0) {
205 if (errno == EINTR) {
206 continue;
207 } else if (errno == EAGAIN || errno == EWOULDBLOCK) {
208
209 if (recvd_byte > (int)((m_pre_rawcpr.tmp_header.RAWHEADER_NWORDS) * sizeof(int))) {
210 char err_buf[500];
211 sprintf(err_buf, "[FATAL] EAGAIN return in the middle of an event( COPPER driver should't do this.). Exting...");
212 print_err.PrintError(m_shmflag, &g_status, err_buf, __FILE__, __PRETTY_FUNCTION__, __LINE__);
213 exit(-1);
214 }
215
216#ifdef NONSTOP
217 // Check run-pause request from SLC
218 string err_str;
219 callCheckRunPause(err_str);
220#endif
221 continue;
222
223 } else {
224 char err_buf[500];
225 sprintf(err_buf, "[FATAL] Failed to read data from COPPER. Exiting...");
226 print_err.PrintError(m_shmflag, &g_status, err_buf, __FILE__, __PRETTY_FUNCTION__, __LINE__);
227 exit(-1);
228 }
229 } else {
230 recvd_byte += read_size;
231 if (recvd_byte - (m_pre_rawcpr.tmp_header.RAWHEADER_NWORDS) * sizeof(int) > (int)(sizeof(int) *
232 (m_pre_rawcpr.POS_DATA_LENGTH + 1)))break;
233 }
234 }
235
236 //
237 // Calcurate data size
238 //
239 *m_size_word = m_bufary[ entry ][ m_pre_rawcpr.POS_DATA_LENGTH + (m_pre_rawcpr.tmp_header.RAWHEADER_NWORDS) ]
240 + m_pre_rawcpr.SIZE_COPPER_DRIVER_HEADER + m_pre_rawcpr.SIZE_COPPER_DRIVER_TRAILER
241 + m_pre_rawcpr.tmp_header.RAWHEADER_NWORDS +
242 m_pre_rawcpr.tmp_trailer.RAWTRAILER_NWORDS; // 9 words are COPPER haeder and trailer size.
243
244 //
245 // If there are data remaining to be read, continue reading
246 //
247 if ((int)((*m_size_word - m_pre_rawcpr.tmp_trailer.RAWTRAILER_NWORDS) * sizeof(int)) > recvd_byte) {
248
249 // If event size is larger than BUF_SIZE_WORD, allocate a new buffer
250 if (*m_size_word > BUF_SIZE_WORD) {
251 *delete_flag = 1;
252 temp_buf = new int[ *m_size_word ];
253 memcpy(temp_buf, m_bufary[ entry ], recvd_byte);
254 recvd_byte += readFD(m_cpr_fd, (char*)temp_buf + recvd_byte,
255 (*m_size_word - m_pre_rawcpr.tmp_trailer.RAWTRAILER_NWORDS) * sizeof(int) - recvd_byte, *delete_flag);
256 } else {
257
258 recvd_byte += readFD(m_cpr_fd, (char*)(m_bufary[ entry ]) + recvd_byte,
259 (*m_size_word - m_pre_rawcpr.tmp_trailer.RAWTRAILER_NWORDS) * sizeof(int) - recvd_byte, *delete_flag);
260 }
261
262 if ((int)((*m_size_word - m_pre_rawcpr.tmp_trailer.RAWTRAILER_NWORDS) * sizeof(int)) != recvd_byte) {
263 char err_buf[500];
264
265 sprintf(err_buf, "[FATAL] CORRUPTED DATA: Read less bytes(%d) than expected(%d:%d). Exiting...\n",
266 recvd_byte,
267 *m_size_word * sizeof(int) - m_pre_rawcpr.tmp_trailer.RAWTRAILER_NWORDS * sizeof(int),
268 m_bufary[ entry ][ m_pre_rawcpr.POS_DATA_LENGTH ]);
269 print_err.PrintError(m_shmflag, &g_status, err_buf, __FILE__, __PRETTY_FUNCTION__, __LINE__);
270 exit(-1);
271 }
272 } else if ((int)((*m_size_word - m_pre_rawcpr.tmp_trailer.RAWTRAILER_NWORDS) * sizeof(int)) < recvd_byte) {
273 char err_buf[500];
274 sprintf(err_buf, "[FATAL] CORRUPTED DATA: Read more than data size. Exiting...: %d %d %d %d %d\n",
275 recvd_byte, *m_size_word * sizeof(int), m_pre_rawcpr.tmp_trailer.RAWTRAILER_NWORDS * sizeof(int),
276 m_bufary[ entry ][ m_pre_rawcpr.POS_DATA_LENGTH ], m_pre_rawcpr.POS_DATA_LENGTH);
277 print_err.PrintError(m_shmflag, &g_status, err_buf, __FILE__, __PRETTY_FUNCTION__, __LINE__);
278 exit(-1);
279 }
280#else
281 //
282 // Make dummy data
283 //
284 *m_size_word = 256 + entry;
285 m_bufary[entry][0] = *m_size_word;
286#endif
287
288 //
289 // Fill Data length
290 //
291 temp_buf[ 0 ] = *m_size_word;
292
293
294#ifdef TIME_MONITOR
295 if (n_basf2evt >= 50000 && n_basf2evt < 50500) {
297 time_array2[ n_basf2evt - 50000 ] = cur_time - m_start_time;
298 }
299#endif
300
301#ifdef CHECK_SUM
302 unsigned int checksum = 0;
303 for (int i = 0; i < m_bufary[entry][0]; i++) {
304 if (i != 2) checksum += m_bufary[entry][i];
305 }
306 m_bufary[entry][2] = checksum;
307#endif
308 return temp_buf;
309#endif
310}
virtual int readFD(int fd, char *buf, int data_size_byte, int delete_flag)
receive data
const PreRawCOPPERFormat_latest m_pre_rawcpr
Handle to data from HSLBs.
double cur_time
for time monitoring
Definition: DeSerializer.h:116
RawTrailer_latest tmp_trailer
trailer ( not recorded )
RawHeader_latest tmp_header
header ( not recorded )

◆ recordTime()

void recordTime ( int  event,
double *  array 
)
protectedinherited

store time info.

Definition at line 192 of file DeSerializer.cc.

193{
194 if (event >= 10000 && event < 10500) {
195 array[ event - 10000 ] = getTimeSec() - m_start_time;
196 }
197 return;
198}
void event() override
Module functions to be called from main process.

◆ setAbortLevel()

void setAbortLevel ( int  abortLevel)
inherited

Configure the abort log level.

Definition at line 67 of file Module.cc.

68{
69 m_logConfig.setAbortLevel(static_cast<LogConfig::ELogLevel>(abortLevel));
70}
ELogLevel
Definition of the supported log levels.
Definition: LogConfig.h:26
void setAbortLevel(ELogLevel abortLevel)
Configure the abort level.
Definition: LogConfig.h:112

◆ setDebugLevel()

void setDebugLevel ( int  debugLevel)
inherited

Configure the debug messaging level.

Definition at line 61 of file Module.cc.

62{
63 m_logConfig.setDebugLevel(debugLevel);
64}
void setDebugLevel(int debugLevel)
Configure the debug messaging level.
Definition: LogConfig.h:98

◆ setDescription()

void setDescription ( const std::string &  description)
protectedinherited

Sets the description of the module.

Parameters
descriptionA description of the module.

Definition at line 214 of file Module.cc.

215{
216 m_description = description;
217}

◆ setLogConfig()

void setLogConfig ( const LogConfig logConfig)
inlineinherited

Set the log system configuration.

Definition at line 230 of file Module.h.

230{m_logConfig = logConfig;}

◆ setLogInfo()

void setLogInfo ( int  logLevel,
unsigned int  logInfo 
)
inherited

Configure the printed log information for the given level.

Parameters
logLevelThe log level (one of LogConfig::ELogLevel)
logInfoWhat kind of info should be printed? ORed combination of LogConfig::ELogInfo flags.

Definition at line 73 of file Module.cc.

74{
75 m_logConfig.setLogInfo(static_cast<LogConfig::ELogLevel>(logLevel), logInfo);
76}
void setLogInfo(ELogLevel logLevel, unsigned int logInfo)
Configure the printed log information for the given level.
Definition: LogConfig.h:127

◆ setLogLevel()

void setLogLevel ( int  logLevel)
inherited

Configure the log level.

Definition at line 55 of file Module.cc.

56{
57 m_logConfig.setLogLevel(static_cast<LogConfig::ELogLevel>(logLevel));
58}
void setLogLevel(ELogLevel logLevel)
Configure the log level.
Definition: LogConfig.cc:25

◆ setName()

void setName ( const std::string &  name)
inlineinherited

Set the name of the module.

Note
The module name is set when using the REG_MODULE macro, but the module can be renamed before calling process() using the set_name() function in your steering file.
Parameters
nameThe name of the module

Definition at line 214 of file Module.h.

214{ m_name = name; };

◆ setParamList()

void setParamList ( const ModuleParamList params)
inlineprotectedinherited

Replace existing parameter list.

Definition at line 501 of file Module.h.

501{ m_moduleParamList = params; }

◆ setParamPython()

void setParamPython ( const std::string &  name,
const boost::python::object &  pyObj 
)
privateinherited

Implements a method for setting boost::python objects.

The method supports the following types: list, dict, int, double, string, bool The conversion of the python object to the C++ type and the final storage of the parameter value is done in the ModuleParam class.

Parameters
nameThe unique name of the parameter.
pyObjThe object which should be converted and stored as the parameter value.

Definition at line 234 of file Module.cc.

235{
236 LogSystem& logSystem = LogSystem::Instance();
237 logSystem.updateModule(&(getLogConfig()), getName());
238 try {
240 } catch (std::runtime_error& e) {
241 throw std::runtime_error("Cannot set parameter '" + name + "' for module '"
242 + m_name + "': " + e.what());
243 }
244
245 logSystem.updateModule(nullptr);
246}
Class for logging debug, info and error messages.
Definition: LogSystem.h:46
void updateModule(const LogConfig *moduleLogConfig=nullptr, const std::string &moduleName="")
Sets the log configuration to the given module log configuration and sets the module name This method...
Definition: LogSystem.h:191
static LogSystem & Instance()
Static method to get a reference to the LogSystem instance.
Definition: LogSystem.cc:31
void setParamPython(const std::string &name, const PythonObject &pyObj)
Implements a method for setting boost::python objects.

◆ setParamPythonDict()

void setParamPythonDict ( const boost::python::dict &  dictionary)
privateinherited

Implements a method for reading the parameter values from a boost::python dictionary.

The key of the dictionary has to be the name of the parameter and the value has to be of one of the supported parameter types.

Parameters
dictionaryThe python dictionary from which the parameter values are read.

Definition at line 249 of file Module.cc.

250{
251
252 LogSystem& logSystem = LogSystem::Instance();
253 logSystem.updateModule(&(getLogConfig()), getName());
254
255 boost::python::list dictKeys = dictionary.keys();
256 int nKey = boost::python::len(dictKeys);
257
258 //Loop over all keys in the dictionary
259 for (int iKey = 0; iKey < nKey; ++iKey) {
260 boost::python::object currKey = dictKeys[iKey];
261 boost::python::extract<std::string> keyProxy(currKey);
262
263 if (keyProxy.check()) {
264 const boost::python::object& currValue = dictionary[currKey];
265 setParamPython(keyProxy, currValue);
266 } else {
267 B2ERROR("Setting the module parameters from a python dictionary: invalid key in dictionary!");
268 }
269 }
270
271 logSystem.updateModule(nullptr);
272}
void setParamPython(const std::string &name, const boost::python::object &pyObj)
Implements a method for setting boost::python objects.
Definition: Module.cc:234

◆ setPropertyFlags()

void setPropertyFlags ( unsigned int  propertyFlags)
inherited

Sets the flags for the module properties.

Parameters
propertyFlagsbitwise OR of EModulePropFlags

Definition at line 208 of file Module.cc.

209{
210 m_propertyFlags = propertyFlags;
211}

◆ setReturnValue() [1/2]

void setReturnValue ( bool  value)
protectedinherited

Sets the return value for this module as bool.

The bool value is saved as an integer with the convention 1 meaning true and 0 meaning false. The value can be used in the steering file to divide the analysis chain into several paths.

Parameters
valueThe value of the return value.

Definition at line 227 of file Module.cc.

228{
229 m_hasReturnValue = true;
230 m_returnValue = value;
231}

◆ setReturnValue() [2/2]

void setReturnValue ( int  value)
protectedinherited

Sets the return value for this module as integer.

The value can be used in the steering file to divide the analysis chain into several paths.

Parameters
valueThe value of the return value.

Definition at line 220 of file Module.cc.

221{
222 m_hasReturnValue = true;
223 m_returnValue = value;
224}

◆ setType()

void setType ( const std::string &  type)
protectedinherited

Set the module type.

Only for use by internal modules (which don't use the normal REG_MODULE mechanism).

Definition at line 48 of file Module.cc.

49{
50 if (!m_type.empty())
51 B2FATAL("Trying to change module type from " << m_type << " is not allowed, the value is assumed to be fixed.");
52 m_type = type;
53}

◆ shmGet()

int * shmGet ( int  fd,
int  size_words 
)
protectedinherited

Get shared memory.

Definition at line 152 of file DeSerializer.cc.

153{
154 int offset = 0;
155 return (int*)mmap(NULL, size_words * sizeof(int), PROT_READ | PROT_WRITE, MAP_SHARED, fd, offset);
156}

◆ shmOpen()

void shmOpen ( char *  path_cfg,
char *  path_sta 
)
protectedinherited

open shared memory

Definition at line 114 of file DeSerializer.cc.

116{
117 errno = 0;
118 /*m_shmfd_cfg = shm_open( "/cpr_config2", O_CREAT | O_EXCL | O_RDWR, 0666);
119 if (m_shmfd_cfg < 0) {
120 if (errno != EEXIST) {
121 perror("shm_open1");
122 exit(1);
123 }
124 m_shmfd_cfg = shm_open(path_cfg, O_RDWR, 0666);
125 if (m_shmfd_cfg < 0) {
126 printf( "[DEBUG] %s\n", path_cfg);
127 perror("[ERROR] shm_open2");
128 exit(1);
129 }
130 */
131 //}
132 /*
133 m_shmfd_sta = shm_open( "/cpr_status2", O_CREAT | O_EXCL | O_RDWR, 0666);
134 if (m_shmfd_sta < 0) {
135 if (errno != EEXIST) {
136 perror("shm_open1");
137 exit(1);
138 }
139 m_shmfd_sta = shm_open(path_sta , O_RDWR, 0666);
140 if (m_shmfd_sta < 0) {
141 printf( "[DEBUG] %s\n", path_sta);
142 perror("[ERROR] shm_open2");
143 exit(1);
144 }
145 //}
146 int size = 4 * sizeof(int);
147 ftruncate(m_shmfd_cfg, size);
148 ftruncate(m_shmfd_sta, size);
149 */
150}

◆ terminate()

void terminate ( void  )
overridevirtualinherited

This method is called at the end of the event processing.

This method is called only once after the event processing finished. Use this method for cleaning up, closing files, etc.

This method can be implemented by subclasses.

Reimplemented from Module.

Definition at line 100 of file DeSerializer.cc.

101{
102 delete[] m_buffer;
103 for (int i = 0 ; i < NUM_EVT_PER_BASF2LOOP_COPPER; i++) {
104 delete[] m_bufary[i];
105 }
106
107 if (m_dump_fname.size() > 0) {
108 fclose(m_fp_dump);
109 }
110
111}

Member Data Documentation

◆ BUF_SIZE_WORD

int BUF_SIZE_WORD
protectedinherited

size of buffer for one event (word)

Definition at line 83 of file DeSerializer.h.

◆ cur_time

double cur_time
protectedinherited

for time monitoring

Definition at line 116 of file DeSerializer.h.

◆ g_status

RunInfoBuffer g_status
staticprotectedinherited

buffer class to communicate with NSM client

Definition at line 200 of file DeSerializer.h.

◆ m_bufary

int* m_bufary[NUM_PREALLOC_BUF]
protectedinherited

buffer

Definition at line 101 of file DeSerializer.h.

◆ m_buffer

int* m_buffer
protectedinherited

buffer

Definition at line 98 of file DeSerializer.h.

◆ m_compressionLevel

int m_compressionLevel
protectedinherited

Compression Level.

Definition at line 80 of file DeSerializer.h.

◆ m_conditions

std::vector<ModuleCondition> m_conditions
privateinherited

Module condition, only non-null if set.

Definition at line 521 of file Module.h.

◆ m_cpr_fd

int m_cpr_fd
private

COPPER file descripter.

Definition at line 81 of file DeSerializerCOPPER.h.

◆ m_data_type

int m_data_type
protectedinherited

data type

Definition at line 179 of file DeSerializer.h.

◆ m_description

std::string m_description
privateinherited

The description of the module.

Definition at line 511 of file Module.h.

◆ m_dump_fname

std::string m_dump_fname
protectedinherited

dump filename

Definition at line 92 of file DeSerializer.h.

◆ m_eventMetaDataPtr

StoreObjPtr<EventMetaData> m_eventMetaDataPtr
protectedinherited

Definition at line 68 of file DeSerializer.h.

◆ m_exp_no

int m_exp_no
protectedinherited

exp no.

Definition at line 176 of file DeSerializer.h.

◆ m_exprunsubrun_no

unsigned int m_exprunsubrun_no
protectedinherited

run no.

Definition at line 170 of file DeSerializer.h.

◆ m_finesse_bit_flag

int m_finesse_bit_flag
private

bit flag for available FINESSE slot

Definition at line 87 of file DeSerializerCOPPER.h.

◆ m_fp_dump

FILE* m_fp_dump
protectedinherited

dump file descripter

Definition at line 95 of file DeSerializer.h.

◆ m_hasReturnValue

bool m_hasReturnValue
privateinherited

True, if the return value is set.

Definition at line 518 of file Module.h.

◆ m_logConfig

LogConfig m_logConfig
privateinherited

The log system configuration of the module.

Definition at line 514 of file Module.h.

◆ m_moduleParamList

ModuleParamList m_moduleParamList
privateinherited

List storing and managing all parameter of the module.

Definition at line 516 of file Module.h.

◆ m_name

std::string m_name
privateinherited

The name of the module, saved as a string (user-modifiable)

Definition at line 508 of file Module.h.

◆ m_ncycle

int m_ncycle
protectedinherited

Definition at line 114 of file DeSerializer.h.

◆ m_nodeid

int m_nodeid
protectedinherited

Node(PC or COPPER) ID.

Definition at line 158 of file DeSerializer.h.

◆ m_nodename

std::string m_nodename
protectedinherited

Node name.

Definition at line 161 of file DeSerializer.h.

◆ m_num_usedbuf

int m_num_usedbuf
protectedinherited

of already used buffers

Definition at line 154 of file DeSerializer.h.

◆ m_package

std::string m_package
privateinherited

Package this module is found in (may be empty).

Definition at line 510 of file Module.h.

◆ m_pre_rawcpr

const PreRawCOPPERFormat_latest m_pre_rawcpr
protected

Handle to data from HSLBs.

Definition at line 63 of file DeSerializerCOPPER.h.

◆ m_prev_exprunsubrun_no

unsigned int m_prev_exprunsubrun_no
protectedinherited

run no.

Definition at line 173 of file DeSerializer.h.

◆ m_prev_ftsweve32

unsigned int m_prev_ftsweve32
private

Event # from data.

Definition at line 92 of file DeSerializerCOPPER.h.

◆ m_prev_nevt

int m_prev_nevt
protectedinherited

No. of prev sent events.

Definition at line 89 of file DeSerializer.h.

◆ m_prev_run_no

int m_prev_run_no
protectedinherited

run no.

Definition at line 167 of file DeSerializer.h.

◆ m_prev_time

double m_prev_time
protectedinherited

Definition at line 119 of file DeSerializer.h.

◆ m_prev_totbytes

double m_prev_totbytes
protectedinherited

Definition at line 113 of file DeSerializer.h.

◆ m_propertyFlags

unsigned int m_propertyFlags
privateinherited

The properties of the module as bitwise or (with |) of EModulePropFlags.

Definition at line 512 of file Module.h.

◆ m_returnValue

int m_returnValue
privateinherited

The return value.

Definition at line 519 of file Module.h.

◆ m_run_no

int m_run_no
protectedinherited

run no.

Definition at line 164 of file DeSerializer.h.

◆ m_shmfd_cfg

int m_shmfd_cfg
protectedinherited

file descripter for shm

Definition at line 194 of file DeSerializer.h.

◆ m_shmfd_sta

int m_shmfd_sta
protectedinherited

file descripter for shm

Definition at line 197 of file DeSerializer.h.

◆ m_shmflag

int m_shmflag
protectedinherited

Use shared memory.

Definition at line 185 of file DeSerializer.h.

◆ m_start_flag

int m_start_flag
protectedinherited

start flag

Definition at line 210 of file DeSerializer.h.

◆ m_start_time

double m_start_time
protectedinherited

Definition at line 118 of file DeSerializer.h.

◆ m_t0

timeval m_t0
protectedinherited

Definition at line 111 of file DeSerializer.h.

◆ m_totbytes

double m_totbytes
protectedinherited

Definition at line 112 of file DeSerializer.h.

◆ m_trunc_mask

int m_trunc_mask
protectedinherited

trunc mask

Definition at line 182 of file DeSerializer.h.

◆ m_type

std::string m_type
privateinherited

The type of the module, saved as a string.

Definition at line 509 of file Module.h.

◆ m_use_slot

int m_use_slot
private

bit flag for available FINESSE slot

Definition at line 84 of file DeSerializerCOPPER.h.

◆ max_nevt

int max_nevt
protectedinherited

StoreArray.

of events in a run

Definition at line 74 of file DeSerializer.h.

◆ max_seconds

double max_seconds
protectedinherited

time to stop a run

Definition at line 77 of file DeSerializer.h.

◆ monitor_numeve

int monitor_numeve
protectedinherited

buffer for shared memory

buffer for shared memory

Definition at line 207 of file DeSerializer.h.

◆ n_basf2evt

int n_basf2evt
protectedinherited

No. of sent events.

Definition at line 86 of file DeSerializer.h.

◆ prev_event

int prev_event
protectedinherited

Definition at line 126 of file DeSerializer.h.

◆ print_err

CprErrorMessage print_err
protectedinherited

wrapper for B2LOG system

Definition at line 213 of file DeSerializer.h.

◆ raw_datablkarray

StoreArray<RawDataBlock> raw_datablkarray
protectedinherited

Definition at line 70 of file DeSerializer.h.

◆ raw_dblkarray

StoreArray<RawDataBlock> raw_dblkarray
private

Definition at line 68 of file DeSerializerCOPPER.h.

◆ time_array0

double time_array0[1000]
protectedinherited

Definition at line 120 of file DeSerializer.h.

◆ time_array1

double time_array1[1000]
protectedinherited

Definition at line 121 of file DeSerializer.h.

◆ time_array2

double time_array2[1000]
protectedinherited

Definition at line 122 of file DeSerializer.h.

◆ time_array3

double time_array3[1000]
protectedinherited

Definition at line 123 of file DeSerializer.h.

◆ time_array4

double time_array4[1000]
protectedinherited

Definition at line 124 of file DeSerializer.h.

◆ time_array5

double time_array5[1000]
protectedinherited

Definition at line 125 of file DeSerializer.h.


The documentation for this class was generated from the following files: