MUserModule Class Reference
[Modules]

Inheritance diagram for MUserModule:

QModule QBaseModule

List of all members.


Detailed Description

Tutorial module.

Author:
Marco Vignati This modules shows the most common user interfaces of diana.


Public Member Functions

 MUserModule (QSequence *s)
 constructor
 ~MUserModule ()
 destructor
void Init ()
 Init method.
QEventDo (QEvent *ev)
 Do method.
void Done ()
 Done method.

Private Attributes

QVector * fMyVec

Constructor & Destructor Documentation

MUserModule::MUserModule ( QSequence *  s  ) 

constructor

called once in a sequence

MUserModule::~MUserModule (  ) 

destructor

called once in a sequence


Member Function Documentation

void MUserModule::Init (  )  [virtual]

Init method.

called before each event loop

Get Variables from config file (for performance improove call this methods only in Init() or Done() and store their values in a member variable See dianaframework/QBaseModule

Get non-eventbyevent variables to file ROOT (.root) and ASCII (.txt) files are currently supported See dianaframework/QGlobalDataManager

Implements QModule.

References QBaseModule::GetBool(), QBaseModule::GetDouble(), QBaseModule::GetInt(), QBaseModule::GetString(), and QBaseModule::SeqAuxData().

QEvent * MUserModule::Do ( QEvent ev  )  [virtual]

Do method.

called event by event

Set event by event variables If "save" is specified they will be written to the output file. Currently only MRootFileWriter support this feature. If "save" is not specified they will be saved onto memory.

Useful to share temporary quantities between modules and dump custom quantities

Get event by event variables

If they were in the input file (read with MRootFileReader) you can read back what you saved with ev->AuxData().Set...

Implements QModule.

References QEvent::AuxData(), QEventAuxData::GetBool(), QEventAuxData::GetDouble(), QEventAuxData::GetFloat(), QEventAuxData::GetInt(), QEventAuxData::GetString(), QEventAuxData::SetBool(), QEventAuxData::SetDouble(), QEventAuxData::SetFloat(), QEventAuxData::SetInt(), QEventAuxData::SetQObject(), and QEventAuxData::SetString().

void MUserModule::Done (  )  [virtual]

Done method.

called at the end of the event loop

Set non-eventbyevent variables from file ROOT (.root) and ASCII (.txt) files are currently supported

if the filename is omitted, objects are saved into memory, and their life is the same of the sequence.

See dianaframework/QGlobalDataManager

this works only for root files, overwrites the object root name!

Implements QModule.

References QBaseModule::SeqAuxData().


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

Generated on Tue Nov 16 10:50:03 2010 for CUORE Software by  doxygen 1.5.6