#include <include/Processus.h>

Inheritance diagram for Processus:

Public Types
enum	states { ERR =-1, NOT_OK, OK }

Public Types inherited from Attrib
enum	Attribut { UNDEFINED, PASSIVE, ACTIVE, INTERFACE, IO, IODATA, ELEMENT, HARDWARE, PROCESSUS, SOFTWARE }

Public Member Functions
	Processus ()
	Standard constructor. More...

virtual	~Processus ()
	Destructor. More...

StatusCode	startProcessing ()

StatusCode	endProcessing ()

virtual StatusCode	initialize ()=0

virtual StatusCode	execute ()=0

virtual StatusCode	finalize ()=0

virtual Processus *	clone ()=0

void	clean ()

void	setStorage (std::string storage)

Data *	data ()

std::vector< double >	data (unsigned int row)

std::vector< double >	data (std::string name)

Histo1D *	hist1d (unsigned int row)

Histo2D *	hist2d (unsigned int row)

void	addDataStream (std::string name, std::string title)

void	addHisto1d (TH1D *h)

void	addHisto2d (TH2D *h)

StatusCode	dataFill (int i, double val)

StatusCode	dataFill (std::string name, double val)

std::string	storage ()

void	setElement (Element *element)

Element *	element ()

void	incNErrors ()

void	setNErrors (unsigned int)

unsigned int	nErrors ()

TFile *	rootFile ()

void	openRootFile ()

void	closeRootFile ()

void	startChrono ()

void	setLogMsg (std::string logMsg)

std::string	logMsg ()

void	setState (int state)

double	elapsedTime ()

double	elapsedTime (time_t start)

Public Member Functions inherited from Object
	Object ()
	Standard constructor. More...

virtual	~Object ()
	Destructor. More...

std::string	name () const

std::string	type ()

unsigned char	id ()

std::string	title ()

void	msgSvc (int level, std::string msg, std::string name)

void	msg (std::string mymsg)

void	verbose (std::string mymsg)

void	debug (std::string mymsg)

void	info (std::string mymsg)

void	warning (std::string mymsg)

void	error (std::string mymsg)

void	fatal (std::string mymsg)

void	msg (std::string mymsg, std::string name)

void	verbose (std::string mymsg, std::string name)

void	debug (std::string mymsg, std::string name)

void	info (std::string mymsg, std::string name)

void	warning (std::string mymsg, std::string name)

void	error (std::string mymsg, std::string name)

void	fatal (std::string mymsg, std::string name)

void	setName (std::string name)

void	setType (std::string type)

void	setId (unsigned char id)

void	setTitle (std::string title)

void	setDllName (std::string dllName)

std::string	dllName ()

Public Member Functions inherited from Attrib
	Attrib ()
	Standard constructor. More...

virtual	~Attrib ()
	Destructor. More...

bool	is (int attribut)

void	add (int attribut)

void	remove (int attribut)

std::string	attributs ()

Protected Attributes
Element *	m_element

Protected Attributes inherited from Attrib
std::string	m_attribString [10]

Private Attributes
Data *	m_data

TFile *	m_rootFile

Options *	m_options

time_t	m_start

ProcState *	m_state

std::string	m_storage

std::string	m_logMsg

Detailed Description

Author: Frederic Machefert

Date: 2004-07-22

Definition at line 32 of file Processus.h.

Member Enumeration Documentation

◆ states

enum Processus::states

Enumerator
ERR
NOT_OK
OK

Definition at line 34 of file Processus.h.

34 { ERR=-1 , NOT_OK , OK };

Processus::NOT_OK

Definition: Processus.h:34

Processus::ERR

Definition: Processus.h:34

Processus::OK

Definition: Processus.h:34

Constructor & Destructor Documentation

◆ Processus()

Processus::Processus ( )

Standard constructor.

Definition at line 23 of file Processus.cpp.

References Attrib::add(), and m_data.

                        : 
   m_element (0),
   m_data    (0),
   m_rootFile(0),
   m_options (application()->options()),
   m_state   (0),
   m_storage (std::string("")),
   m_logMsg  (std::string(""))
 #ifdef _NETWORK_
   ,  
   m_service (false),
   m_updateDelay  (2),
   m_timerService (0),
   m_valueService (0)  
   m_stateService (0)
 #endif  
 {
   m_data=new Data();
   add(8); add(9);
 }

◆ ~Processus()

Processus::~Processus ( )

virtual

Destructor.

Definition at line 47 of file Processus.cpp.

References m_data, m_element, and m_state.

                       {
   if (0!=m_data) delete m_data;
   if (0!=m_element)
   {
     if (0!=m_state)
     {
       delete m_state;      
     }
   }
 #ifdef _NETWORK_
   if ( 0 != m_timerService ){
     delete m_timerService;
   }
   if ( 0 != m_stateService ){
     delete m_stateService;
   }
   if ( 0 != m_valueService ){
     delete m_valueService;
   }
 #endif
 }

Member Function Documentation

◆ addDataStream()

void Processus::addDataStream	(	std::string	name,
		std::string	title
	)

inline

Definition at line 153 of file Processus.h.

Referenced by RegisterTest::initialize(), TestSuite::initialize(), TestSPI::initialize(), TestUSB::initialize(), TestI2C::initialize(), UsbFTInterfaceTest::initialize(), ADCMeasurement::initialize(), and CurrentMeasurement::initialize().

                                                        {
     m_data->addDataStream(name, title);
   }

◆ addHisto1d()

void Processus::addHisto1d ( TH1D * h )

inline

Definition at line 160 of file Processus.h.

Referenced by StorageFifo::initialize(), StorageFifoAcquisition::initialize(), TestSuite::initialize(), A3PE_BitFlip::initialize(), and Acquisition::initialize().

                            {
     m_data->addHisto1d(h);
   }

◆ addHisto2d()

void Processus::addHisto2d ( TH2D * h )

inline

Definition at line 167 of file Processus.h.

Referenced by TestSuite::initialize().

                            {
     m_data->addHisto2d(h);
   }

◆ clean()

void Processus::clean ( )

inline

Definition at line 85 of file Processus.h.

Referenced by Application::prepare().

   {
     m_element=0;
     if (0!=m_state) {
       delete m_state;
       m_state=0;
     }
 #ifdef _NETWORK_
     warning("Cleaning state service : should it be done ?","Processus::clean")
       if (0!=m_stateService)
       {
         delete m_stateService;
       }
 #endif
   }

◆ clone()

virtual Processus* Processus::clone ( )

pure virtual

processus termination virtual function

Implemented in Acquisition, Acquisition, EmulateFE, CurrentMeasurement, PhaserScan, TestSuite, UsbFTInterfaceTest, RegisterTest, ADCMeasurement, A3PE_BitFlip, StorageFifoAcquisition, PhaserRampExec, TestI2C, TestSPI, TestUSB, StorageFifo, and ProcessusWrap.

Referenced by Application::prepare().

◆ closeRootFile()

void Processus::closeRootFile ( )

Close Root file if already opened and requested

Definition at line 160 of file Processus.cpp.

References Options::dataFileFullName(), Options::dataStorage(), Object::info(), m_options, and m_rootFile.

Referenced by endProcessing(), RegisterTest::finalize(), UsbFTInterfaceTest::finalize(), and PhaserRampExec::finalize().

                                 {
   if ( 0!= m_rootFile && m_options->dataStorage() ){
     m_rootFile->Write();
         std::string mess=std::string("Closing root file ");
         mess.append(m_options->dataFileFullName());
         info(mess,"closeRootFile");
     m_rootFile->Delete();
     m_rootFile = 0;
   }
 }

◆ data() [1/3]

Data* Processus::data ( )

inline

Get accessor to member m_data

Returns: the current value of m_data

Definition at line 114 of file Processus.h.

Referenced by StorageFifoAcquisition::execute(), and export_proc().

               {
     return m_data;
   }

◆ data() [2/3]

std::vector<double> Processus::data ( unsigned int row )

inline

Get accessor to member m_data

Returns: the current value of m_data

Definition at line 122 of file Processus.h.

                                           {
     return m_data->vector(row);
   }

◆ data() [3/3]

std::vector<double> Processus::data ( std::string name )

inline

Get accessor to member m_data

Returns: the current value of m_data

Definition at line 130 of file Processus.h.

                                         {
     return m_data->vector(name);
   }

◆ dataFill() [1/2]

StatusCode Processus::dataFill	(	int	i,
		double	val
	)

inline

Set data stream with value

Returns: the StatusCode

Definition at line 175 of file Processus.h.

References StatusCode::FAILURE, and StatusCode::SUCCESS.

Referenced by TestSuite::execute(), TestI2C::execute(), TestUSB::execute(), TestSPI::execute(), UsbFTInterfaceTest::execute(), CurrentMeasurement::execute(), and ADCMeasurement::execute().

                                         {
     if (m_data->vectorPtr(i)!=0){
       m_data->vectorPtr(i)->push_back(val);
       return StatusCode::SUCCESS;
     }
     else {
       return StatusCode::FAILURE;
     }
   }

◆ dataFill() [2/2]

StatusCode Processus::dataFill	(	std::string	name,
		double	val
	)

inline

Set data stream with value

Returns: the StatusCode

Definition at line 189 of file Processus.h.

References StatusCode::FAILURE, and StatusCode::SUCCESS.

                                                  {
     int row=m_data->rowFromName(name);
     if (row<0) return StatusCode::FAILURE;
     if (m_data->vectorPtr(row)!=0){
       m_data->vectorPtr(row)->push_back(val);
       return StatusCode::SUCCESS;
     }
     else {
       return StatusCode::FAILURE;
     }
   }

◆ elapsedTime() [1/2]

double Processus::elapsedTime ( )

inline

Definition at line 340 of file Processus.h.

References ProcState::time.

Referenced by endProcessing(), UsbFTInterfaceTest::execute(), PhaserRampExec::finalize(), and setState().

                        {
     return difftime(time(0),m_start);
   }

◆ elapsedTime() [2/2]

double Processus::elapsedTime ( time_t start )

inline

Definition at line 343 of file Processus.h.

References ProcState::time.

                                    {
     return ((time(0)-start));
   }

◆ element()

Element* Processus::element ( )

inline

Get accessor to member m_element

Returns: the current value of m_element

Definition at line 231 of file Processus.h.

Referenced by UsbFTInterfaceTest::execute(), export_proc(), StorageFifoAcquisition::initialize(), StorageFifo::initialize(), A3PE_BitFlip::initialize(), Acquisition::initialize(), TestI2C::initialize(), TestSPI::initialize(), TestUSB::initialize(), EmulateFE::initialize(), CurrentMeasurement::initialize(), ADCMeasurement::initialize(), and PhaserRampExec::initialize().

                       {
     return m_element;
   }

◆ endProcessing()

StatusCode Processus::endProcessing ( )

processus standard termination function

Definition at line 115 of file Processus.cpp.

References Data::buildHistos(), closeRootFile(), elapsedTime(), Data::empty(), finalize(), ftos(), Object::info(), itos(), m_data, m_options, nErrors(), Options::nErrors(), Options::nEvt(), NOT_OK, Data::print(), Options::runNumber(), and setState().

Referenced by export_proc(), and Application::terminate().

                                     {
   setState( NOT_OK );
   // 
   info("--------------------------------------------------------------------------");
   info("Processed Run Number       : " + itos (m_options->runNumber()) , "finalize");
   info("Number of events processed : " + itos (m_options->nEvt())      , "finalize");
   info("Number of Errors           : " + itos (nErrors())           , "finalize");  
   info("Number of App errors       : " + itos (m_options->nErrors())   , "finalize");
   info("Elapsed time               : " + ftos (elapsedTime())       , "finalize");
   info("--------------------------------------------------------------------------");
   if (!m_data->empty()) 
     m_data->print();
   else 
     info("No data Stored.","finalize");
   info("--------------------------------------------------------------------------");
 
 #ifdef _NETWORK_
   if ( 0 != m_timerService ){
     m_timerService->setRunning ( false );
   }
 #endif
   StatusCode sc = finalize();
   m_data->buildHistos();  
   closeRootFile();
   return sc;
 }

◆ execute()

virtual StatusCode Processus::execute ( )

pure virtual

processus execution virtual function

Implemented in PhaserRampExec, ADCMeasurement, CurrentMeasurement, UsbFTInterfaceTest, EmulateFE, TestI2C, TestSPI, TestUSB, PhaserScan, A3PE_BitFlip, Acquisition, RegisterTest, TestSuite, StorageFifo, StorageFifoAcquisition, Acquisition, and ProcessusWrap.

Referenced by export_proc(), and Application::loop().

◆ finalize()

virtual StatusCode Processus::finalize ( )

pure virtual

processus termination virtual function

Implemented in PhaserRampExec, ADCMeasurement, CurrentMeasurement, UsbFTInterfaceTest, EmulateFE, TestI2C, TestSPI, TestUSB, PhaserScan, A3PE_BitFlip, Acquisition, RegisterTest, TestSuite, StorageFifo, StorageFifoAcquisition, Acquisition, and ProcessusWrap.

Referenced by endProcessing(), and export_proc().

◆ hist1d()

Histo1D* Processus::hist1d ( unsigned int row )

inline

Get accessor to member m_data

Returns: the current value of m_data

Definition at line 138 of file Processus.h.

Referenced by export_proc().

                                    {
     return m_data->hist1d(row);
   }

◆ hist2d()

Histo2D* Processus::hist2d ( unsigned int row )

inline

Get accessor to member m_data

Returns: the current value of m_data

Definition at line 146 of file Processus.h.

Referenced by export_proc().

                                    {
     return m_data->hist2d(row);
   }

◆ incNErrors()

void Processus::incNErrors ( )

Increment the number of Errors for that process

Definition at line 72 of file Processus.cpp.

References m_state, and ProcState::nerrors.

                            {
   m_state->nerrors++;
 }

◆ initialize()

virtual StatusCode Processus::initialize ( )

pure virtual

processus initialisation virtual function

Implemented in PhaserRampExec, ADCMeasurement, CurrentMeasurement, UsbFTInterfaceTest, EmulateFE, TestI2C, TestSPI, TestUSB, PhaserScan, A3PE_BitFlip, Acquisition, RegisterTest, TestSuite, StorageFifo, StorageFifoAcquisition, Acquisition, and ProcessusWrap.

Referenced by export_proc(), and startProcessing().

◆ logMsg()

std::string Processus::logMsg ( )

inline

Get accessor to member m_logMsg

Returns: the current value of m_logMsg

Definition at line 291 of file Processus.h.

References ProcState::state.

                       {
     return m_logMsg;
   }

◆ nErrors()

unsigned int Processus::nErrors ( )

Get accessor to member m_nErrors

Returns: the current value of m_nErrors

Definition at line 86 of file Processus.cpp.

References m_state, and ProcState::nerrors.

Referenced by endProcessing().

                                 {
   return ( m_state->nerrors++ );
 }

◆ openRootFile()

void Processus::openRootFile ( )

Open Root file if needed

Definition at line 146 of file Processus.cpp.

References Options::dataFileFullName(), Options::dataStorage(), Object::info(), m_options, m_rootFile, and Object::name().

Referenced by RegisterTest::initialize(), UsbFTInterfaceTest::initialize(), PhaserRampExec::initialize(), and startProcessing().

                                {
   if ( m_options->dataStorage() ){
     m_rootFile = new TFile(m_options->dataFileFullName().c_str(),
                            "RECREATE",name().c_str());
         std::string mess=std::string("Opening root file ");
         mess.append(m_options->dataFileFullName());
         info(mess,"openRootFile");
   }
 }

◆ rootFile()

TFile* Processus::rootFile ( )

inline

Get accessor to member m_rootFile

Returns: the current value of m_rootFile

Definition at line 258 of file Processus.h.

                      {
     return m_rootFile;
   }

◆ setElement()

void Processus::setElement ( Element * element )

inline

Set accessor to member m_element

Parameters

element the new value for m_element

Definition at line 217 of file Processus.h.

Referenced by export_proc(), and Application::prepare().

                                      {
     m_state = new ProcState ();
     m_state->nevent  = 0;
     m_state->nerrors = 0;
     m_state->time    = 0;
     strcpy( m_state->state,"");
     //  setState( OK );
     m_element = element;
   }

◆ setLogMsg()

void Processus::setLogMsg ( std::string logMsg )

inline

Set accessor to member m_logMsg

Parameters

logMsg the new value for m_logMsg

Definition at line 283 of file Processus.h.

                                     {
     m_logMsg = logMsg;
   }

◆ setNErrors()

void Processus::setNErrors ( unsigned int nerr )

Set accessor to member m_nErrors

Parameters

nErrors the new value for m_nErrors

Definition at line 79 of file Processus.cpp.

References m_state, and ProcState::nerrors.

Referenced by startProcessing().

                                              {
   m_state->nerrors = nerr ;
 }

◆ setState()

void Processus::setState ( int state )

Set accessor to member m_state.state

Parameters

state the new value for m_state.state

Definition at line 174 of file Processus.cpp.

References application(), elapsedTime(), ERR, Object::info(), m_options, m_state, Object::msgSvc(), Object::name(), ProcState::nerrors, Options::nErrors(), ProcState::nevent, Options::nEvt(), NOT_OK, OK, ProcState::state, and ProcState::time.

Referenced by endProcessing().

                                      {
   m_state->nevent  = m_options->nEvt();
   m_state->nerrors = m_options->nErrors();
   m_state->time    = (float) ( elapsedTime() );
   switch ( state ){
   case OK:
     strcpy(m_state->state,"OK");
     break;
   case NOT_OK:
     strcpy(m_state->state,"NOT_OK");
     break;
   case ERR:
     strcpy(m_state->state,"ERROR");
   }
 }

◆ setStorage()

void Processus::setStorage ( std::string storage )

inline

Set accessor to member m_storage

Parameters

storage the new value for m_storage

Definition at line 106 of file Processus.h.

Referenced by export_proc().

                                       {
     m_storage = storage;
   }

◆ startChrono()

void Processus::startChrono ( )

inline

Start processus time measurement

Definition at line 275 of file Processus.h.

References ProcState::time.

Referenced by PhaserRampExec::initialize(), and startProcessing().

                     {
     m_start = time(0);
   }

◆ startProcessing()

StatusCode Processus::startProcessing ( )

processus cmdline function processus virtual command function processus standard initialize function

Definition at line 93 of file Processus.cpp.

References Object::info(), initialize(), m_data, m_options, Object::name(), openRootFile(), Data::purge(), setNErrors(), Options::setNErrors(), and startChrono().

Referenced by export_proc(), and Application::prepare().

                                       {
   info("==========================================================================");
   info("   * " + name() + " *" );
   m_options->setNErrors ( 0 );
   setNErrors ( 0 );
   m_data->purge();
 #ifdef _NETWORK_
   if ( 0 != m_timerService ){
     m_timerService->setRunning ( true );
     m_timerService->timeHandler() ;
   }
 #endif
   // start measuring processus duration
   
   startChrono();
   openRootFile();
   return initialize();
 }

◆ storage()

std::string Processus::storage ( )

inline

Get accessor to member m_storage

Returns: the current value of m_storage

Definition at line 205 of file Processus.h.

Referenced by export_proc(), and Application::prepare().

                        {
     if ( 0 == m_storage.compare("") )
     {
       return name();
     }
     return m_storage;
   }

Member Data Documentation

◆ m_data

Data* Processus::m_data

private

Definition at line 358 of file Processus.h.

Referenced by endProcessing(), Processus(), startProcessing(), and ~Processus().

◆ m_element

Element* Processus::m_element

protected

Definition at line 348 of file Processus.h.

Referenced by ~Processus().

◆ m_logMsg

std::string Processus::m_logMsg

private

Definition at line 365 of file Processus.h.

◆ m_options

Options* Processus::m_options

private

Definition at line 360 of file Processus.h.

Referenced by closeRootFile(), endProcessing(), openRootFile(), setState(), and startProcessing().

◆ m_rootFile

TFile* Processus::m_rootFile

private

Definition at line 359 of file Processus.h.

Referenced by closeRootFile(), and openRootFile().

◆ m_start

time_t Processus::m_start

private

Definition at line 362 of file Processus.h.

◆ m_state

ProcState* Processus::m_state

private

Definition at line 363 of file Processus.h.

Referenced by incNErrors(), nErrors(), setNErrors(), setState(), and ~Processus().

◆ m_storage

std::string Processus::m_storage

private

Definition at line 364 of file Processus.h.

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

/home/eleclhcb/LHCb/lbcat-cmake/CatKernel/inc/Processus.h
/home/eleclhcb/LHCb/lbcat-cmake/CatKernel/src/Processus.cpp

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ states

Constructor & Destructor Documentation

◆ Processus()

◆ ~Processus()

Member Function Documentation

◆ addDataStream()

◆ addHisto1d()

◆ addHisto2d()

◆ clean()

◆ clone()

◆ closeRootFile()

◆ data() [1/3]

◆ data() [2/3]

◆ data() [3/3]

◆ dataFill() [1/2]

◆ dataFill() [2/2]

◆ elapsedTime() [1/2]

◆ elapsedTime() [2/2]

◆ element()

◆ endProcessing()

◆ execute()

◆ finalize()

◆ hist1d()

◆ hist2d()

◆ incNErrors()

◆ initialize()

◆ logMsg()

◆ nErrors()

◆ openRootFile()

◆ rootFile()

◆ setElement()

◆ setLogMsg()

◆ setNErrors()

◆ setState()

◆ setStorage()

◆ startChrono()

◆ startProcessing()

◆ storage()

Member Data Documentation

◆ m_data

◆ m_element

◆ m_logMsg

◆ m_options

◆ m_rootFile

◆ m_start

◆ m_state

◆ m_storage