CbmErrorMessage Class Reference

CbmRoot (+externals) headers. More...

#include <CbmErrorMessage.h>

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

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

Private Member Functions
	ClassDefNV (CbmErrorMessage, 1)

Private Attributes
ECbmModuleId	fModuleId = ECbmModuleId::kLastModule
Double_t	fdTime = -1.0
UInt_t	fuAddress = 0
UInt_t	fuFlags = 0
UInt_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 39 of file CbmErrorMessage.h.

Constructor & Destructor Documentation

CbmErrorMessage() [1/2]

CbmErrorMessage::CbmErrorMessage ( )

inline

Default constructor

Definition at line 43 of file CbmErrorMessage.h.

CbmErrorMessage() [2/2]

CbmErrorMessage::CbmErrorMessage	(	ECbmModuleId	sysId,
		Double_t	dTime,
		UInt_t	uAddress,
		UInt_t	uFlags,
		UInt_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 13 of file CbmErrorMessage.cxx.

~CbmErrorMessage()

CbmErrorMessage::~CbmErrorMessage

(

)

Destructor

Definition at line 27 of file CbmErrorMessage.cxx.

Member Function Documentation

ClassDefNV()

CbmErrorMessage::ClassDefNV ( CbmErrorMessage  , 1    )

private

GetAddress()

UInt_t CbmErrorMessage::GetAddress ( ) const

inline

Origin address

Definition at line 79 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 67 of file CbmErrorMessage.h.

GetFlags()

UInt_t CbmErrorMessage::GetFlags ( ) const

inline

Flags (bitfield)

Definition at line 83 of file CbmErrorMessage.h.

References fuFlags.

Referenced by compareErrorMessageDataMembers(), and ToString().

GetPayload()

UInt_t CbmErrorMessage::GetPayload ( ) const

inline

Payload (optional)

Definition at line 87 of file CbmErrorMessage.h.

References fuPayload.

Referenced by compareErrorMessageDataMembers(), and ToString().

GetSystemId()

ECbmModuleId CbmErrorMessage::GetSystemId ( ) const

inline

System (enum DetectorId)

Definition at line 71 of file CbmErrorMessage.h.

References fModuleId.

Referenced by compareErrorMessageDataMembers(), and ToString().

GetTime()

Double_t CbmErrorMessage::GetTime ( ) const

inline

Absolute time [ns]

Definition at line 75 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 95 of file CbmErrorMessage.h.

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

ToString()

std::string CbmErrorMessage::ToString

(

)

const

Output information.

Definition at line 32 of file CbmErrorMessage.cxx.

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

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Definition at line 104 of file CbmErrorMessage.h.

Member Data Documentation

fdTime

Double_t CbmErrorMessage::fdTime = -1.0

private

Definition at line 107 of file CbmErrorMessage.h.

Referenced by GetTime(), and serialize().

fModuleId

ECbmModuleId CbmErrorMessage::fModuleId = ECbmModuleId::kLastModule

private

Definition at line 106 of file CbmErrorMessage.h.

Referenced by GetSystemId(), and serialize().

fuAddress

UInt_t CbmErrorMessage::fuAddress = 0

private

Definition at line 108 of file CbmErrorMessage.h.

Referenced by GetAddress(), and serialize().

fuFlags

UInt_t CbmErrorMessage::fuFlags = 0

private

Definition at line 109 of file CbmErrorMessage.h.

Referenced by GetFlags(), and serialize().

fuPayload

UInt_t CbmErrorMessage::fuPayload = 0

private

Definition at line 110 of file CbmErrorMessage.h.

Referenced by GetPayload(), and serialize().

---

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

• CbmErrorMessage.h
• CbmErrorMessage.cxx