EqPeriodic Class Reference

Inheritance diagram for EqPeriodic:

Collaboration diagram for EqPeriodic:

Public Member Functions
	EqPeriodic (const char *eqname, const char *eqfilename)
void	HandlePeriodic ()
	EqPeriodic (const char *eqname, const char *eqfilename)
void	HandlePeriodic ()
Public Member Functions inherited from TMFeEquipment
	TMFeEquipment (const char *eqname, const char *eqfilename)
virtual	~TMFeEquipment ()
TMFeResult	EqInit (const std::vector< std::string > &args)
	Initialize equipment.
TMFeResult	EqPreInit ()
	Initialize equipment, before EquipmentBase::Init()
TMFeResult	EqPostInit ()
	Initialize equipment, after EquipmentBase::Init()
TMFeResult	EqReadCommon ()
	Read TMFeEqInfo from ODB /Equipment/NAME/Common.
TMFeResult	EqWriteCommon (bool create=false)
	Write TMFeEqInfo to ODB /Equipment/NAME/Common.
virtual TMFeResult	HandleInit (const std::vector< std::string > &args)
virtual void	HandleUsage ()
virtual TMFeResult	HandleBeginRun (int run_number)
virtual TMFeResult	HandleEndRun (int run_number)
virtual TMFeResult	HandlePauseRun (int run_number)
virtual TMFeResult	HandleResumeRun (int run_number)
virtual TMFeResult	HandleStartAbortRun (int run_number)
virtual TMFeResult	HandleRpc (const char *cmd, const char *args, std::string &response)
virtual bool	HandlePoll ()
virtual void	HandlePollRead ()
void	EqPollThread ()
void	EqStartPollThread ()
void	EqStopPollThread ()
TMFeResult	ComposeEvent (char *pevent, size_t size) const
TMFeResult	BkInit (char *pevent, size_t size) const
void *	BkOpen (char *pevent, const char *bank_name, int bank_type) const
TMFeResult	BkClose (char *pevent, void *ptr) const
int	BkSize (const char *pevent) const
TMFeResult	EqSendEvent (const char *pevent, bool write_to_odb=true)
TMFeResult	EqSendEvent (const std::vector< char > &event, bool write_to_odb=true)
TMFeResult	EqSendEvent (const std::vector< std::vector< char > > &event, bool write_to_odb=true)
TMFeResult	EqSendEvent (int sg_n, const char *sg_ptr[], const size_t sg_len[], bool write_to_odb=true)
TMFeResult	EqWriteEventToOdb (const char *pevent)
TMFeResult	EqZeroStatistics ()
TMFeResult	EqWriteStatistics ()
TMFeResult	EqSetStatus (const char *status, const char *color)
	TMFeEquipment (TMFE *mfe, const char *name, TMFeCommon *common)
TMFeError	Init ()
	Initialize equipment.
TMFeError	SendData (const char *data, int size)
	...
TMFeError	ComposeEvent (char *pevent, int size)
TMFeError	BkInit (char *pevent, int size)
void *	BkOpen (char *pevent, const char *bank_name, int bank_type)
TMFeError	BkClose (char *pevent, void *ptr)
int	BkSize (const char *pevent)
TMFeError	SendEvent (const char *pevent)
TMFeError	ZeroStatistics ()
TMFeError	WriteStatistics ()
TMFeError	SetStatus (const char *status, const char *color)
Public Member Functions inherited from TMFeRpcHandlerInterface
virtual TMFeResult	HandleBinaryRpc (const char *cmd, const char *args, std::vector< char > &result)
virtual void	HandleBeginRun ()
virtual void	HandleEndRun ()
virtual void	HandlePauseRun ()
virtual void	HandleResumeRun ()
virtual void	HandleStartAbortRun ()
virtual std::string	HandleRpc (const char *cmd, const char *args)

Additional Inherited Members
Public Attributes inherited from TMFeEquipment
std::string	fEqName
std::string	fEqFilename
bool	fEqConfEnableRpc = true
bool	fEqConfEnablePeriodic = true
bool	fEqConfEnablePoll = false
bool	fEqConfReadConfigFromOdb = true
bool	fEqConfEnabled = true
uint16_t	fEqConfEventID = 1
uint16_t	fEqConfTriggerMask = 0
std::string	fEqConfBuffer = "SYSTEM"
int	fEqConfType = 0
int	fEqConfSource = 0
std::string	fEqConfFormat = "MIDAS"
int	fEqConfReadOn = 0
int	fEqConfPeriodMilliSec = 1000
double	fEqConfEventLimit = 0
uint32_t	fEqConfNumSubEvents = 0
int	fEqConfLogHistory = 0
bool	fEqConfHidden = false
int	fEqConfWriteCacheSize = 10000000
bool	fEqConfReadOnlyWhenRunning = true
bool	fEqConfWriteEventsToOdb = false
double	fEqConfPeriodStatisticsSec = 1.0
double	fEqConfPollSleepSec = 0.000100
size_t	fEqConfMaxEventSize = 0
size_t	fEqConfBufferSize = 0
std::mutex	fEqMutex
TMFE *	fMfe = NULL
TMFrontend *	fFe = NULL
MVOdb *	fOdbEq = NULL
	ODB Equipment/EQNAME.
MVOdb *	fOdbEqCommon = NULL
	ODB Equipment/EQNAME/Common.
MVOdb *	fOdbEqSettings = NULL
	ODB Equipment/EQNAME/Settings.
MVOdb *	fOdbEqVariables = NULL
	ODB Equipment/EQNAME/Variables.
MVOdb *	fOdbEqStatistics = NULL
	ODB Equipment/EQNAME/Statistics.
TMEventBuffer *	fEqEventBuffer = NULL
int	fEqSerial = 0
double	fEqStatEvents = 0
double	fEqStatBytes = 0
double	fEqStatEpS = 0
double	fEqStatKBpS = 0
double	fEqStatLastTime = 0
double	fEqStatLastEvents = 0
double	fEqStatLastBytes = 0
double	fEqStatLastWrite = 0
double	fEqStatNextWrite = 0
double	fEqPeriodicLastCallTime = 0
double	fEqPeriodicNextCallTime = 0
std::atomic_bool	fEqPollThreadStarting {false}
std::atomic_bool	fEqPollThreadRunning {false}
std::atomic_bool	fEqPollThreadShutdownRequested {false}
std::thread *	fEqPollThread = NULL
std::string	fName
TMFeCommon *	fCommon
int	fBufferHandle
int	fSerial
double	fStatEvents
double	fStatBytes
double	fStatEpS
double	fStatKBpS
double	fStatLastTime
double	fStatLastEvents
double	fStatLastBytes

Detailed Description

Definition at line 187 of file tmfe_example_frontend.cxx.

Constructor & Destructor Documentation

EqPeriodic() [1/2]

EqPeriodic::EqPeriodic ( const char *  eqname, const char *  eqfilename  )

inline

Definition at line 191 of file tmfe_example_frontend.cxx.

      : TMFeEquipment(eqname, eqfilename)
   {
      /* configure your equipment here */
 
      fEqConfReadConfigFromOdb = false;
      fEqConfEventID = 2;
      fEqConfBuffer = "SYSTEM";
      fEqConfPeriodMilliSec = 1000; // in milliseconds
      fEqConfLogHistory = 1;
      fEqConfReadOnlyWhenRunning = true;
      fEqConfWriteEventsToOdb = true;
   }

EqPeriodic() [2/2]

EqPeriodic::EqPeriodic ( const char *  eqname, const char *  eqfilename  )

inline

Definition at line 21 of file tmfe_example_indexed.cxx.

      : TMFeEquipment(eqname, eqfilename)
   {
      /* configure your equipment here */
 
      fEqConfReadConfigFromOdb = false;
      fEqConfEventID = 3;
      fEqConfBuffer = "BUF%02d";
      fEqConfPeriodMilliSec = 1000; // in milliseconds
      fEqConfLogHistory = 0;
      fEqConfWriteEventsToOdb = false;
   }

Member Function Documentation

HandlePeriodic() [1/2]

void EqPeriodic::HandlePeriodic ( )

inlinevirtual

Reimplemented from TMFeEquipment.

Definition at line 205 of file tmfe_example_frontend.cxx.

   {
      char buf[1024];
 
      ComposeEvent(buf, sizeof(buf));
      BkInit(buf, sizeof(buf));
 
      /* create SCLR bank */
      uint32_t* pdata = (uint32_t*)BkOpen(buf, "PRDC", TID_UINT32);
      
      /* following code "simulates" some values in sine wave form */
      for (int a = 0; a < 16; a++)
         *pdata++ = 100*sin(M_PI*time(NULL)/60+a/2.0)+100;
      
      BkClose(buf, pdata);
 
      EqSendEvent(buf);
   }

Here is the call graph for this function:

HandlePeriodic() [2/2]

void EqPeriodic::HandlePeriodic ( )

inlinevirtual

Reimplemented from TMFeEquipment.

Definition at line 34 of file tmfe_example_indexed.cxx.

   {
      char buf[1024];
 
      ComposeEvent(buf, sizeof(buf));
      BkInit(buf, sizeof(buf));
 
      /* create SCLR bank */
      uint32_t* pdata = (uint32_t*)BkOpen(buf, "PRDC", TID_UINT32);
      
      /* following code "simulates" some values in sine wave form */
      for (int a = 0; a < 16; a++)
         *pdata++ = 100*sin(M_PI*time(NULL)/60+a/2.0)+100;
      
      BkClose(buf, pdata);
 
      EqSendEvent(buf);
   }

Here is the call graph for this function:

---

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

• progs/tmfe_example_frontend.cxx
• progs/tmfe_example_indexed.cxx