CbmErrorMessage Class Reference

CbmRoot (+externals) headers. More...

#include <CbmErrorMessage.h>

Public Member Functions
	CbmErrorMessage ()
	CbmErrorMessage (ECbmModuleId sysId, double dTime, uint32_t uAddress, uint32_t uFlags, uint32_t uPayload=0)
	Standard constructor.
	~CbmErrorMessage ()
ECbmModuleId	GetSystemId () const
	System (enum DetectorId)
double	GetTime () const
	Absolute time [ns]
uint32_t	GetAddress () const
	Origin address
uint32_t	GetFlags () const
	Flags (bitfield)
uint32_t	GetPayload () const
	Payload (optional)
std::string	ToString () const
	Output information.
template<class Archive >
void	serialize (Archive &ar, const unsigned int)

Static Public Member Functions
static const char *	GetClassName ()
	Class name (static)

Private Member Functions
	ClassDefNV (CbmErrorMessage, 1)

Private Attributes
ECbmModuleId	fModuleId = ECbmModuleId::kLastModule
double	fdTime = -1.0
uint32_t	fuAddress = 0
uint32_t	fuFlags = 0
uint32_t	fuPayload = 0

Friends
class	boost::serialization::access

Detailed Description

CbmRoot (+externals) headers.

FairRoot headers Fairsoft (Root, Boost, ...) headers C/C++ headers

Base class for persistent representation of error messages information.

Author

Pierre-Alain Loizeau p.-a..nosp@m.loiz.nosp@m.eau@g.nosp@m.si.d.nosp@m.e

Since

19.02.2020

Version

19.02.2020

CbmErrorMessage is a base class for the ROOT representation of the error message delivered by the detector readout chains. The available information fields are the system ID, the time stamp, an origin index (address), the flags and (optionally) a payload.

The base class only provides bulk setters/getters, with the idea that derived class will provide direct accessors to specific flags/payloads.

Definition at line 44 of file CbmErrorMessage.h.

Constructor & Destructor Documentation

CbmErrorMessage() [1/2]

CbmErrorMessage::CbmErrorMessage ( )

inline

Default constructor

Definition at line 48 of file CbmErrorMessage.h.

CbmErrorMessage() [2/2]

CbmErrorMessage::CbmErrorMessage	(	ECbmModuleId	sysId,
		double	dTime,
		uint32_t	uAddress,
		uint32_t	uFlags,
		uint32_t	uPayload = 0 )

Standard constructor.

Parameters

[in]	sysId	System ID from ECbmModuleId enum.
[in]	dTime	Error time [ns].
[in]	uAddress	Some address for the error source.
[in]	uFlags	Flags/error pattern, 32b available.
[in]	uPayload	Optional error payload, 32b available.

Definition at line 16 of file CbmErrorMessage.cxx.

~CbmErrorMessage()

CbmErrorMessage::~CbmErrorMessage

(

)

Destructor

Definition at line 29 of file CbmErrorMessage.cxx.

Member Function Documentation

ClassDefNV()

CbmErrorMessage::ClassDefNV ( CbmErrorMessage , 1  )

private

GetAddress()

uint32_t CbmErrorMessage::GetAddress ( ) const

inline

Origin address

Definition at line 80 of file CbmErrorMessage.h.

References fuAddress.

Referenced by compareErrorMessageDataMembers(), and ToString().

GetClassName()

static const char * CbmErrorMessage::GetClassName ( )

inlinestatic

Class name (static)

Returns

CbmErrorMessage

Definition at line 68 of file CbmErrorMessage.h.

GetFlags()

uint32_t CbmErrorMessage::GetFlags ( ) const

inline

Flags (bitfield)

Definition at line 84 of file CbmErrorMessage.h.

References fuFlags.

Referenced by compareErrorMessageDataMembers(), and ToString().

GetPayload()

uint32_t CbmErrorMessage::GetPayload ( ) const

inline

Payload (optional)

Definition at line 88 of file CbmErrorMessage.h.

References fuPayload.

Referenced by compareErrorMessageDataMembers(), and ToString().

GetSystemId()

ECbmModuleId CbmErrorMessage::GetSystemId ( ) const

inline

System (enum DetectorId)

Definition at line 72 of file CbmErrorMessage.h.

References fModuleId.

Referenced by compareErrorMessageDataMembers(), and ToString().

GetTime()

double CbmErrorMessage::GetTime ( ) const

inline

Absolute time [ns]

Definition at line 76 of file CbmErrorMessage.h.

References fdTime.

Referenced by compareErrorMessageDataMembers(), and ToString().

serialize()

template<class Archive >

void CbmErrorMessage::serialize ( Archive & ar, const unsigned int  )

inline

Definition at line 96 of file CbmErrorMessage.h.

References fdTime, fModuleId, fuAddress, fuFlags, and fuPayload.

ToString()

std::string CbmErrorMessage::ToString

(

)

const

Output information.

Definition at line 34 of file CbmErrorMessage.cxx.

References GetAddress(), GetFlags(), GetPayload(), GetSystemId(), and GetTime().

Friends And Related Symbol Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Definition at line 106 of file CbmErrorMessage.h.

Member Data Documentation

fdTime

double CbmErrorMessage::fdTime = -1.0

private

Definition at line 109 of file CbmErrorMessage.h.

Referenced by GetTime(), and serialize().

fModuleId

ECbmModuleId CbmErrorMessage::fModuleId = ECbmModuleId::kLastModule

private

Definition at line 108 of file CbmErrorMessage.h.

Referenced by GetSystemId(), and serialize().

fuAddress

uint32_t CbmErrorMessage::fuAddress = 0

private

Definition at line 110 of file CbmErrorMessage.h.

Referenced by GetAddress(), and serialize().

fuFlags

uint32_t CbmErrorMessage::fuFlags = 0

private

Definition at line 111 of file CbmErrorMessage.h.

Referenced by GetFlags(), and serialize().

fuPayload

uint32_t CbmErrorMessage::fuPayload = 0

private

Definition at line 112 of file CbmErrorMessage.h.

Referenced by GetPayload(), and serialize().

---

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

• CbmErrorMessage.h
• CbmErrorMessage.cxx