stsxyter::Message Class Reference

#include <StsXyterMessage.h>

Public Member Functions
	Message ()
	Message (const Message &src)
	Message (uint32_t uDataIn)
	~Message ()
void	assign (const Message &src)
Message &	operator= (const Message &src)
void	reset ()
uint32_t	GetData () const
void	SetData (uint32_t uValue)
uint32_t	GetField (uint32_t uShift, uint32_t uLen) const
uint8_t	GetBit (uint32_t uShift) const
uint32_t	GetFieldBE (uint32_t uShift, uint32_t uLen) const
uint8_t	GetBitBE (uint32_t uShift) const
uint32_t	DataBE () const
void	SetField (uint32_t uShift, uint32_t uLen, uint32_t uValue)
void	SetBit (uint32_t uShift, uint8_t uValue)
uint32_t	GetField (MessField field) const
uint8_t	GetBit (MessField field) const
bool	GetFlag (MessField field) const
uint32_t	GetFieldBE (MessField field) const
uint8_t	GetBitBE (MessField field) const
void	SetField (MessField field, uint32_t uValue)
void	SetBit (MessField field, uint8_t ucValue)
uint16_t	GetLinkIndex () const
	For all data: Returns the (global) index of the eLink on which the message was received (n bit field)
bool	IsHit () const
	Check if the message if a Hit Message.
bool	IsDummy () const
	Check if the message if a Dummy Hit Message.
bool	IsTsMsb () const
	Check if the message if a Ts_Msb.
MessType	GetMessType () const
	Returns the message type, see enum MessType.
uint16_t	GetHitChannel () const
	For Hit data: Returns StsXYTER channel number (7 bit field)
uint16_t	GetHitAdc () const
	For Hit data: Returns ADC value (5 bit field)
uint16_t	GetHitTimeFull () const
	For Hit data: Returns Full timestamp (10 bit field including 2 bits overlap)
uint16_t	GetHitTimeOver () const
	For Hit data: Returns timestamp overlap bits (2 bits field, overlap with 2 LSBs of TS_MSB message)
uint16_t	GetHitTime () const
	For Hit data: Returns timestamp (8 bit field, 2 MSB bits overlap removed)
uint16_t	GetHitTimeBinning () const
uint16_t	GetLinkIndexHitBinning () const
bool	IsHitMissedEvts () const
	For Hit data: Returns Missed event flag (1 bit field)
void	SetHitChannel (uint16_t usVal)
	For Hit data: Sets StsXYTER channel number (7 bit field)
void	SetHitAdc (uint16_t usVal)
	For Hit data: Sets ADC value (5 bit field)
void	SetHitTimeFull (uint16_t usVal)
	For Hit data: Sets Full timestamp (10 bit field including 2 bits overlap)
void	SetHitTimeOver (uint16_t usVal)
	For Hit data: Sets timestamp overlap bits (2 bits field, overlap with 2 LSBs of TS_MSB message)
void	SetHitTime (uint16_t usVal)
	For Hit data: Sets Full timestamp (8 bit field, 2 MSB bits overlap removed)
void	SetHitMissEvtsFlag (bool bVal)
	For Hit data: Sets Missed event flag (1 bit field)
MessSubType	GetSubType () const
	For non-Hit data: Returns subtype (2 bit field)
uint32_t	GetTsMsbVal () const
	For TS MSB data: Returns the TS MSB 22 bit field)
uint32_t	GetTsMsbValBinning () const
	For TS MSB data: Returns the TS MSB 29 bit field)
void	SetTsMsbVal (uint32_t uVal)
	For TS MSB data: Sets the TS MSB (22 bit field)
uint32_t	GetEpochVal () const
	For Epoch data: Returns the Epoch (29 bit field)
void	SetEpochVal (uint32_t uVal)
	For Epoch data: Sets the Epoch (29 bit field)
uint16_t	GetStatusLink () const
	For Status data: Returns the Link Inedx (9 bit field)
uint16_t	GetStatusSxTs () const
	For Status data: Returns the SMX TS from ACK frame (6 bit field)
uint16_t	GetStatusStatus () const
	For Status data: Returns the Status field from ACK frame (4 bit field)
uint16_t	GetStatusDpbTs () const
	For Status data: Returns the DPB TS when frame received (9 bit field)
bool	IsCpFlagOn () const
	For Status data: Returns the CP flag from ACK frame (1 bit field)
void	SetStatusLink (uint16_t usVal)
	For Status data: Sets the Status (9 bit field)
void	SetStatusSxTs (uint16_t usVal)
	For Status data: Sets the Status (6 bit field)
void	SetStatusStatus (uint16_t usVal)
	For Status data: Sets the Status (4 bit field)
void	SetStatusDpbTs (uint16_t usVal)
	For Status data: Sets the Status (9 bit field)
void	SetCpFlag (bool bVal)
	For Status data: Sets the Status (1 bit field)
bool	IsEmptyMsg () const
	For Empty/End of MS data: Check if this is an empty message (1 bit field)
bool	IsMsErrorFlagOn () const
	For End of MS data: Returns the MS error flag (1 bit field)
uint16_t	GetMsErrorType () const
	For End of MS data: Returns the MS error type field (2 bit field)
void	SetEmptyMsgFlag (bool bVal)
	For Empty/End of MS data data: Sets the Empty message flag (1 bit field)
void	SetMsErrorFlag (bool bVal)
	For End of MS data data: Sets the MS Error flag (1 bit field)
void	SetMsErrorType (uint16_t usVal)
	For End of MS data: Sets the MS error type field (2 bit field)
bool	PrintMess (std::ostream &os, MessagePrintMask ctrl=MessagePrintMask::msg_print_Human, bool bBinning=true) const
	Message ()
	Message (const Message &src)
	Message (uint32_t uDataIn)
	~Message ()
void	assign (const Message &src)
Message &	operator= (const Message &src)
void	reset ()
uint32_t	GetData () const
void	SetData (uint32_t uValue)
uint32_t	GetField (uint32_t uShift, uint32_t uLen) const
uint8_t	GetBit (uint32_t uShift) const
uint32_t	GetFieldBE (uint32_t uShift, uint32_t uLen) const
uint8_t	GetBitBE (uint32_t uShift) const
uint32_t	DataBE () const
void	SetField (uint32_t uShift, uint32_t uLen, uint32_t uValue)
void	SetBit (uint32_t uShift, uint8_t uValue)
uint32_t	GetField (MessField field) const
uint8_t	GetBit (MessField field) const
bool	GetFlag (MessField field) const
uint32_t	GetFieldBE (MessField field) const
uint8_t	GetBitBE (MessField field) const
void	SetField (MessField field, uint32_t uValue)
void	SetBit (MessField field, uint8_t ucValue)
uint16_t	GetLinkIndex () const
	For all data: Returns the (global) index of the eLink on which the message was received (n bit field)
bool	IsHit () const
	Check if the message if a Hit Message.
bool	IsDummy () const
	Check if the message if a Dummy Hit Message.
bool	IsTsMsb () const
	Check if the message if a Ts_Msb.
MessType	GetMessType () const
	Returns the message type, see enum MessType.
uint16_t	GetHitChannel () const
	For Hit data: Returns StsXYTER channel number (7 bit field)
uint16_t	GetHitAdc () const
	For Hit data: Returns ADC value (5 bit field)
uint16_t	GetHitTimeFull () const
	For Hit data: Returns Full timestamp (10 bit field including 2 bits overlap)
uint16_t	GetHitTimeOver () const
	For Hit data: Returns timestamp overlap bits (2 bits field, overlap with 2 LSBs of TS_MSB message)
uint16_t	GetHitTime () const
	For Hit data: Returns timestamp (8 bit field, 2 MSB bits overlap removed)
uint16_t	GetHitTimeBinning () const
uint16_t	GetLinkIndexHitBinning () const
bool	IsHitMissedEvts () const
	For Hit data: Returns Missed event flag (1 bit field)
void	SetHitChannel (uint16_t usVal)
	For Hit data: Sets StsXYTER channel number (7 bit field)
void	SetHitAdc (uint16_t usVal)
	For Hit data: Sets ADC value (5 bit field)
void	SetHitTimeFull (uint16_t usVal)
	For Hit data: Sets Full timestamp (10 bit field including 2 bits overlap)
void	SetHitTimeOver (uint16_t usVal)
	For Hit data: Sets timestamp overlap bits (2 bits field, overlap with 2 LSBs of TS_MSB message)
void	SetHitTime (uint16_t usVal)
	For Hit data: Sets Full timestamp (8 bit field, 2 MSB bits overlap removed)
void	SetHitMissEvtsFlag (bool bVal)
	For Hit data: Sets Missed event flag (1 bit field)
MessSubType	GetSubType () const
	For non-Hit data: Returns subtype (2 bit field)
uint32_t	GetTsMsbVal () const
	For TS MSB data: Returns the TS MSB 22 bit field)
uint32_t	GetTsMsbValBinning () const
	For TS MSB data: Returns the TS MSB 29 bit field)
void	SetTsMsbVal (uint32_t uVal)
	For TS MSB data: Sets the TS MSB (22 bit field)
uint32_t	GetEpochVal () const
	For Epoch data: Returns the Epoch (29 bit field)
void	SetEpochVal (uint32_t uVal)
	For Epoch data: Sets the Epoch (29 bit field)
uint16_t	GetStatusLink () const
	For Status data: Returns the Link Inedx (9 bit field)
uint16_t	GetStatusSxTs () const
	For Status data: Returns the SMX TS from ACK frame (6 bit field)
uint16_t	GetStatusStatus () const
	For Status data: Returns the Status field from ACK frame (4 bit field)
uint16_t	GetStatusDpbTs () const
	For Status data: Returns the DPB TS when frame received (9 bit field)
bool	IsCpFlagOn () const
	For Status data: Returns the CP flag from ACK frame (1 bit field)
void	SetStatusLink (uint16_t usVal)
	For Status data: Sets the Status (9 bit field)
void	SetStatusSxTs (uint16_t usVal)
	For Status data: Sets the Status (6 bit field)
void	SetStatusStatus (uint16_t usVal)
	For Status data: Sets the Status (4 bit field)
void	SetStatusDpbTs (uint16_t usVal)
	For Status data: Sets the Status (9 bit field)
void	SetCpFlag (bool bVal)
	For Status data: Sets the Status (1 bit field)
bool	IsEmptyMsg () const
	For Empty/End of MS data: Check if this is an empty message (1 bit field)
bool	IsMsErrorFlagOn () const
	For End of MS data: Returns the MS error flag (1 bit field)
uint16_t	GetMsErrorType () const
	For End of MS data: Returns the MS error type field (2 bit field)
void	SetEmptyMsgFlag (bool bVal)
	For Empty/End of MS data data: Sets the Empty message flag (1 bit field)
void	SetMsErrorFlag (bool bVal)
	For End of MS data data: Sets the MS Error flag (1 bit field)
void	SetMsErrorType (uint16_t usVal)
	For End of MS data: Sets the MS error type field (2 bit field)
bool	PrintMess (std::ostream &os, MessagePrintMask ctrl=MessagePrintMask::msg_print_Human, bool bBinning=true) const

Static Public Member Functions
static std::string	PrintMessType (MessType type)
static std::string	PrintMessType (MessType type)

Protected Attributes
uint32_t	fuData

Detailed Description

Definition at line 174 of file StsXyterMessage.h.

Constructor & Destructor Documentation

Message() [1/6]

stsxyter::Message::Message ( )

inline

Definition at line 181 of file StsXyterMessage.h.

Message() [2/6]

stsxyter::Message::Message ( const Message &  src )

inline

Definition at line 185 of file StsXyterMessage.h.

Message() [3/6]

stsxyter::Message::Message ( uint32_t  uDataIn )

inline

Definition at line 189 of file StsXyterMessage.h.

~Message() [1/2]

stsxyter::Message::~Message ( )

inline

Definition at line 193 of file StsXyterMessage.h.

Message() [4/6]

stsxyter::Message::Message ( )

inline

Definition at line 181 of file StsXyterMessage.h.

Message() [5/6]

stsxyter::Message::Message ( const Message &  src )

inline

Definition at line 185 of file StsXyterMessage.h.

Message() [6/6]

stsxyter::Message::Message ( uint32_t  uDataIn )

inline

Definition at line 189 of file StsXyterMessage.h.

~Message() [2/2]

stsxyter::Message::~Message ( )

inline

Definition at line 193 of file StsXyterMessage.h.

Member Function Documentation

assign() [1/2]

void stsxyter::Message::assign ( const Message &  src )

inline

Definition at line 195 of file StsXyterMessage.h.

References fuData.

Referenced by operator=().

assign() [2/2]

void stsxyter::Message::assign ( const Message &  src )

inline

Definition at line 195 of file StsXyterMessage.h.

References fuData.

DataBE() [1/2]

uint32_t stsxyter::Message::DataBE ( ) const

inline

Definition at line 221 of file StsXyterMessage.h.

References fuData.

Referenced by GetBitBE(), and GetFieldBE().

DataBE() [2/2]

uint32_t stsxyter::Message::DataBE ( ) const

inline

Definition at line 221 of file StsXyterMessage.h.

References fuData.

GetBit() [1/4]

uint8_t stsxyter::Message::GetBit ( MessField  field ) const

inline

Definition at line 242 of file StsXyterMessage.h.

References stsxyter::MessField::fusPos, and GetBit().

Referenced by GetBit().

GetBit() [2/4]

uint8_t stsxyter::Message::GetBit ( MessField  field ) const

inline

Definition at line 242 of file StsXyterMessage.h.

References GetBit().

Referenced by GetBit().

GetBit() [3/4]

uint8_t stsxyter::Message::GetBit ( uint32_t  uShift ) const

inline

Definition at line 214 of file StsXyterMessage.h.

References fuData.

Referenced by GetFlag(), and GetHitTimeBinning().

GetBit() [4/4]

uint8_t stsxyter::Message::GetBit ( uint32_t  uShift ) const

inline

Definition at line 214 of file StsXyterMessage.h.

References fuData.

GetBitBE() [1/4]

uint8_t stsxyter::Message::GetBitBE ( MessField  field ) const

inline

Definition at line 245 of file StsXyterMessage.h.

References stsxyter::MessField::fusPos, and GetBitBE().

Referenced by GetBitBE().

GetBitBE() [2/4]

uint8_t stsxyter::Message::GetBitBE ( MessField  field ) const

inline

Definition at line 245 of file StsXyterMessage.h.

References GetBitBE().

Referenced by GetBitBE().

GetBitBE() [3/4]

uint8_t stsxyter::Message::GetBitBE ( uint32_t  uShift ) const

inline

Definition at line 220 of file StsXyterMessage.h.

References DataBE().

GetBitBE() [4/4]

uint8_t stsxyter::Message::GetBitBE ( uint32_t  uShift ) const

inline

Definition at line 220 of file StsXyterMessage.h.

References DataBE().

GetData() [1/2]

uint32_t stsxyter::Message::GetData ( ) const

inline

Definition at line 206 of file StsXyterMessage.h.

References fuData.

GetData() [2/2]

uint32_t stsxyter::Message::GetData ( ) const

inline

Definition at line 206 of file StsXyterMessage.h.

References fuData.

GetEpochVal() [1/2]

uint32_t stsxyter::Message::GetEpochVal ( ) const

inline

For Epoch data: Returns the Epoch (29 bit field)

Definition at line 350 of file StsXyterMessage.h.

References GetField().

GetEpochVal() [2/2]

uint32_t stsxyter::Message::GetEpochVal ( ) const

inline

For Epoch data: Returns the Epoch (29 bit field)

Definition at line 350 of file StsXyterMessage.h.

References GetField().

GetField() [1/4]

uint32_t stsxyter::Message::GetField ( MessField  field ) const

inline

Definition at line 241 of file StsXyterMessage.h.

References stsxyter::MessField::fusLen, stsxyter::MessField::fusPos, and GetField().

Referenced by GetField().

GetField() [2/4]

uint32_t stsxyter::Message::GetField ( MessField  field ) const

inline

Definition at line 241 of file StsXyterMessage.h.

References GetField().

Referenced by GetField().

GetField() [3/4]

uint32_t stsxyter::Message::GetField ( uint32_t  uShift, uint32_t  uLen  ) const

inline

Definition at line 209 of file StsXyterMessage.h.

References fuData.

Referenced by GetEpochVal(), GetHitAdc(), GetHitChannel(), GetHitTime(), GetHitTimeBinning(), GetHitTimeFull(), GetHitTimeOver(), GetLinkIndex(), GetLinkIndexHitBinning(), GetMsErrorType(), GetStatusDpbTs(), GetStatusLink(), GetStatusStatus(), GetStatusSxTs(), GetSubType(), GetTsMsbVal(), GetTsMsbValBinning(), IsCpFlagOn(), IsEmptyMsg(), and IsMsErrorFlagOn().

GetField() [4/4]

uint32_t stsxyter::Message::GetField ( uint32_t  uShift, uint32_t  uLen  ) const

inline

Definition at line 209 of file StsXyterMessage.h.

References fuData.

GetFieldBE() [1/4]

uint32_t stsxyter::Message::GetFieldBE ( MessField  field ) const

inline

Definition at line 244 of file StsXyterMessage.h.

References stsxyter::MessField::fusLen, stsxyter::MessField::fusPos, and GetFieldBE().

Referenced by GetFieldBE().

GetFieldBE() [2/4]

uint32_t stsxyter::Message::GetFieldBE ( MessField  field ) const

inline

Definition at line 244 of file StsXyterMessage.h.

References GetFieldBE().

Referenced by GetFieldBE().

GetFieldBE() [3/4]

uint32_t stsxyter::Message::GetFieldBE ( uint32_t  uShift, uint32_t  uLen  ) const

inline

Definition at line 216 of file StsXyterMessage.h.

References DataBE().

GetFieldBE() [4/4]

uint32_t stsxyter::Message::GetFieldBE ( uint32_t  uShift, uint32_t  uLen  ) const

inline

Definition at line 216 of file StsXyterMessage.h.

References DataBE().

GetFlag() [1/2]

bool stsxyter::Message::GetFlag ( MessField  field ) const

inline

Definition at line 243 of file StsXyterMessage.h.

References stsxyter::MessField::fusPos, and GetBit().

Referenced by GetMessType(), IsHit(), and IsHitMissedEvts().

GetFlag() [2/2]

bool stsxyter::Message::GetFlag ( MessField  field ) const

inline

Definition at line 243 of file StsXyterMessage.h.

References GetBit().

GetHitAdc() [1/2]

uint16_t stsxyter::Message::GetHitAdc ( ) const

inline

For Hit data: Returns ADC value (5 bit field)

Definition at line 278 of file StsXyterMessage.h.

References GetField().

Referenced by GetMessType(), and IsDummy().

GetHitAdc() [2/2]

uint16_t stsxyter::Message::GetHitAdc ( ) const

inline

For Hit data: Returns ADC value (5 bit field)

Definition at line 278 of file StsXyterMessage.h.

References GetField().

GetHitChannel() [1/2]

uint16_t stsxyter::Message::GetHitChannel ( ) const

inline

For Hit data: Returns StsXYTER channel number (7 bit field)

Definition at line 275 of file StsXyterMessage.h.

References GetField().

GetHitChannel() [2/2]

uint16_t stsxyter::Message::GetHitChannel ( ) const

inline

For Hit data: Returns StsXYTER channel number (7 bit field)

Definition at line 275 of file StsXyterMessage.h.

References GetField().

GetHitTime() [1/2]

uint16_t stsxyter::Message::GetHitTime ( ) const

inline

For Hit data: Returns timestamp (8 bit field, 2 MSB bits overlap removed)

Definition at line 287 of file StsXyterMessage.h.

References GetField().

GetHitTime() [2/2]

uint16_t stsxyter::Message::GetHitTime ( ) const

inline

For Hit data: Returns timestamp (8 bit field, 2 MSB bits overlap removed)

Definition at line 287 of file StsXyterMessage.h.

References GetField().

GetHitTimeBinning() [1/2]

uint16_t stsxyter::Message::GetHitTimeBinning ( ) const

inline

For Hit data: Returns timestamp (9 bit field + 1b extra on b30) => Quick and dirty hack for binning FW!!!

Definition at line 291 of file StsXyterMessage.h.

References GetBit(), and GetField().

GetHitTimeBinning() [2/2]

uint16_t stsxyter::Message::GetHitTimeBinning ( ) const

inline

For Hit data: Returns timestamp (9 bit field + 1b extra on b30) => Quick and dirty hack for binning FW!!!

Definition at line 291 of file StsXyterMessage.h.

References GetBit(), and GetField().

GetHitTimeFull() [1/2]

uint16_t stsxyter::Message::GetHitTimeFull ( ) const

inline

For Hit data: Returns Full timestamp (10 bit field including 2 bits overlap)

Definition at line 281 of file StsXyterMessage.h.

References GetField().

GetHitTimeFull() [2/2]

uint16_t stsxyter::Message::GetHitTimeFull ( ) const

inline

For Hit data: Returns Full timestamp (10 bit field including 2 bits overlap)

Definition at line 281 of file StsXyterMessage.h.

References GetField().

GetHitTimeOver() [1/2]

uint16_t stsxyter::Message::GetHitTimeOver ( ) const

inline

For Hit data: Returns timestamp overlap bits (2 bits field, overlap with 2 LSBs of TS_MSB message)

Definition at line 284 of file StsXyterMessage.h.

References GetField().

GetHitTimeOver() [2/2]

uint16_t stsxyter::Message::GetHitTimeOver ( ) const

inline

For Hit data: Returns timestamp overlap bits (2 bits field, overlap with 2 LSBs of TS_MSB message)

Definition at line 284 of file StsXyterMessage.h.

References GetField().

GetLinkIndex() [1/2]

uint16_t stsxyter::Message::GetLinkIndex ( ) const

inline

For all data: Returns the (global) index of the eLink on which the message was received (n bit field)

Definition at line 252 of file StsXyterMessage.h.

References GetField().

GetLinkIndex() [2/2]

uint16_t stsxyter::Message::GetLinkIndex ( ) const

inline

For all data: Returns the (global) index of the eLink on which the message was received (n bit field)

Definition at line 252 of file StsXyterMessage.h.

References GetField().

GetLinkIndexHitBinning() [1/2]

uint16_t stsxyter::Message::GetLinkIndexHitBinning ( ) const

inline

For Hit data: Returns (global) index of the eLink on which the message was received (6 bit field) => Quick and dirty hack for binning FW!!!

Definition at line 298 of file StsXyterMessage.h.

References GetField().

GetLinkIndexHitBinning() [2/2]

uint16_t stsxyter::Message::GetLinkIndexHitBinning ( ) const

inline

For Hit data: Returns (global) index of the eLink on which the message was received (6 bit field) => Quick and dirty hack for binning FW!!!

Definition at line 298 of file StsXyterMessage.h.

References GetField().

GetMessType() [1/2]

MessType stsxyter::Message::GetMessType ( ) const

inline

Returns the message type, see enum MessType.

Definition at line 260 of file StsXyterMessage.h.

References stsxyter::Dummy, stsxyter::Empty, stsxyter::EndOfMs, stsxyter::Epoch, GetFlag(), GetHitAdc(), GetSubType(), stsxyter::Hit, IsEmptyMsg(), stsxyter::Status, and stsxyter::TsMsb.

GetMessType() [2/2]

MessType stsxyter::Message::GetMessType ( ) const

inline

Returns the message type, see enum MessType.

Definition at line 260 of file StsXyterMessage.h.

References stsxyter::Dummy, stsxyter::Empty, stsxyter::EndOfMs, stsxyter::Epoch, GetFlag(), GetHitAdc(), GetSubType(), stsxyter::Hit, IsEmptyMsg(), stsxyter::Status, and stsxyter::TsMsb.

GetMsErrorType() [1/2]

uint16_t stsxyter::Message::GetMsErrorType ( ) const

inline

For End of MS data: Returns the MS error type field (2 bit field)

Definition at line 394 of file StsXyterMessage.h.

References GetField().

GetMsErrorType() [2/2]

uint16_t stsxyter::Message::GetMsErrorType ( ) const

inline

For End of MS data: Returns the MS error type field (2 bit field)

Definition at line 394 of file StsXyterMessage.h.

References GetField().

GetStatusDpbTs() [1/2]

uint16_t stsxyter::Message::GetStatusDpbTs ( ) const

inline

For Status data: Returns the DPB TS when frame received (9 bit field)

Definition at line 366 of file StsXyterMessage.h.

References GetField().

GetStatusDpbTs() [2/2]

uint16_t stsxyter::Message::GetStatusDpbTs ( ) const

inline

For Status data: Returns the DPB TS when frame received (9 bit field)

Definition at line 366 of file StsXyterMessage.h.

References GetField().

GetStatusLink() [1/2]

uint16_t stsxyter::Message::GetStatusLink ( ) const

inline

For Status data: Returns the Link Inedx (9 bit field)

Definition at line 357 of file StsXyterMessage.h.

References GetField().

GetStatusLink() [2/2]

uint16_t stsxyter::Message::GetStatusLink ( ) const

inline

For Status data: Returns the Link Inedx (9 bit field)

Definition at line 357 of file StsXyterMessage.h.

References GetField().

GetStatusStatus() [1/2]

uint16_t stsxyter::Message::GetStatusStatus ( ) const

inline

For Status data: Returns the Status field from ACK frame (4 bit field)

Definition at line 363 of file StsXyterMessage.h.

References GetField().

GetStatusStatus() [2/2]

uint16_t stsxyter::Message::GetStatusStatus ( ) const

inline

For Status data: Returns the Status field from ACK frame (4 bit field)

Definition at line 363 of file StsXyterMessage.h.

References GetField().

GetStatusSxTs() [1/2]

uint16_t stsxyter::Message::GetStatusSxTs ( ) const

inline

For Status data: Returns the SMX TS from ACK frame (6 bit field)

Definition at line 360 of file StsXyterMessage.h.

References GetField().

GetStatusSxTs() [2/2]

uint16_t stsxyter::Message::GetStatusSxTs ( ) const

inline

For Status data: Returns the SMX TS from ACK frame (6 bit field)

Definition at line 360 of file StsXyterMessage.h.

References GetField().

GetSubType() [1/2]

MessSubType stsxyter::Message::GetSubType ( ) const

inline

For non-Hit data: Returns subtype (2 bit field)

Definition at line 324 of file StsXyterMessage.h.

References stsxyter::Empty, stsxyter::Epoch, GetField(), stsxyter::Status, and stsxyter::TsMsb.

Referenced by GetMessType(), and IsTsMsb().

GetSubType() [2/2]

MessSubType stsxyter::Message::GetSubType ( ) const

inline

For non-Hit data: Returns subtype (2 bit field)

Definition at line 324 of file StsXyterMessage.h.

References stsxyter::Empty, stsxyter::Epoch, GetField(), stsxyter::Status, and stsxyter::TsMsb.

GetTsMsbVal() [1/2]

uint32_t stsxyter::Message::GetTsMsbVal ( ) const

inline

For TS MSB data: Returns the TS MSB 22 bit field)

Definition at line 340 of file StsXyterMessage.h.

References GetField().

GetTsMsbVal() [2/2]

uint32_t stsxyter::Message::GetTsMsbVal ( ) const

inline

For TS MSB data: Returns the TS MSB 22 bit field)

Definition at line 340 of file StsXyterMessage.h.

References GetField().

GetTsMsbValBinning() [1/2]

uint32_t stsxyter::Message::GetTsMsbValBinning ( ) const

inline

For TS MSB data: Returns the TS MSB 29 bit field)

Definition at line 343 of file StsXyterMessage.h.

References GetField().

GetTsMsbValBinning() [2/2]

uint32_t stsxyter::Message::GetTsMsbValBinning ( ) const

inline

For TS MSB data: Returns the TS MSB 29 bit field)

Definition at line 343 of file StsXyterMessage.h.

References GetField().

IsCpFlagOn() [1/2]

bool stsxyter::Message::IsCpFlagOn ( ) const

inline

For Status data: Returns the CP flag from ACK frame (1 bit field)

Definition at line 369 of file StsXyterMessage.h.

References GetField().

IsCpFlagOn() [2/2]

bool stsxyter::Message::IsCpFlagOn ( ) const

inline

For Status data: Returns the CP flag from ACK frame (1 bit field)

Definition at line 369 of file StsXyterMessage.h.

References GetField().

IsDummy() [1/2]

bool stsxyter::Message::IsDummy ( ) const

inline

Check if the message if a Dummy Hit Message.

Definition at line 256 of file StsXyterMessage.h.

References GetHitAdc(), and IsHit().

IsDummy() [2/2]

bool stsxyter::Message::IsDummy ( ) const

inline

Check if the message if a Dummy Hit Message.

Definition at line 256 of file StsXyterMessage.h.

References GetHitAdc(), and IsHit().

IsEmptyMsg() [1/2]

bool stsxyter::Message::IsEmptyMsg ( ) const

inline

For Empty/End of MS data: Check if this is an empty message (1 bit field)

Definition at line 388 of file StsXyterMessage.h.

References GetField().

Referenced by GetMessType().

IsEmptyMsg() [2/2]

bool stsxyter::Message::IsEmptyMsg ( ) const

inline

For Empty/End of MS data: Check if this is an empty message (1 bit field)

Definition at line 388 of file StsXyterMessage.h.

References GetField().

IsHit() [1/2]

bool stsxyter::Message::IsHit ( ) const

inline

Check if the message if a Hit Message.

Definition at line 254 of file StsXyterMessage.h.

References GetFlag().

Referenced by IsDummy(), and IsTsMsb().

IsHit() [2/2]

bool stsxyter::Message::IsHit ( ) const

inline

Check if the message if a Hit Message.

Definition at line 254 of file StsXyterMessage.h.

References GetFlag().

IsHitMissedEvts() [1/2]

bool stsxyter::Message::IsHitMissedEvts ( ) const

inline

For Hit data: Returns Missed event flag (1 bit field)

Definition at line 301 of file StsXyterMessage.h.

References GetFlag().

IsHitMissedEvts() [2/2]

bool stsxyter::Message::IsHitMissedEvts ( ) const

inline

For Hit data: Returns Missed event flag (1 bit field)

Definition at line 301 of file StsXyterMessage.h.

References GetFlag().

IsMsErrorFlagOn() [1/2]

bool stsxyter::Message::IsMsErrorFlagOn ( ) const

inline

For End of MS data: Returns the MS error flag (1 bit field)

Definition at line 391 of file StsXyterMessage.h.

References GetField().

IsMsErrorFlagOn() [2/2]

bool stsxyter::Message::IsMsErrorFlagOn ( ) const

inline

For End of MS data: Returns the MS error flag (1 bit field)

Definition at line 391 of file StsXyterMessage.h.

References GetField().

IsTsMsb() [1/2]

bool stsxyter::Message::IsTsMsb ( ) const

inline

Check if the message if a Ts_Msb.

Definition at line 258 of file StsXyterMessage.h.

References GetSubType(), IsHit(), and stsxyter::TsMsb.

IsTsMsb() [2/2]

bool stsxyter::Message::IsTsMsb ( ) const

inline

Check if the message if a Ts_Msb.

Definition at line 258 of file StsXyterMessage.h.

References GetSubType(), IsHit(), and stsxyter::TsMsb.

operator=() [1/2]

Message & stsxyter::Message::operator= ( const Message &  src )

inline

Definition at line 197 of file StsXyterMessage.h.

References assign().

operator=() [2/2]

Message & stsxyter::Message::operator= ( const Message &  src )

inline

Definition at line 197 of file StsXyterMessage.h.

References assign().

PrintMess() [1/2]

bool stsxyter::Message::PrintMess	(	std::ostream &	os,
		MessagePrintMask	ctrl = MessagePrintMask::msg_print_Human,
		bool	bBinning = true
	)		const

PrintMess() [2/2]

bool stsxyter::Message::PrintMess	(	std::ostream &	os,
		MessagePrintMask	ctrl = MessagePrintMask::msg_print_Human,
		bool	bBinning = true
	)		const

PrintMessType() [1/2]

static std::string stsxyter::Message::PrintMessType ( MessType  type )

static

PrintMessType() [2/2]

static std::string stsxyter::Message::PrintMessType ( MessType  type )

static

reset() [1/2]

void stsxyter::Message::reset ( )

inline

Definition at line 203 of file StsXyterMessage.h.

References fuData.

reset() [2/2]

void stsxyter::Message::reset ( )

inline

Definition at line 203 of file StsXyterMessage.h.

References fuData.

SetBit() [1/4]

void stsxyter::Message::SetBit ( MessField  field, uint8_t  ucValue  )

inline

Definition at line 248 of file StsXyterMessage.h.

References stsxyter::MessField::fusPos, and SetBit().

Referenced by SetBit().

SetBit() [2/4]

void stsxyter::Message::SetBit ( MessField  field, uint8_t  ucValue  )

inline

Definition at line 248 of file StsXyterMessage.h.

References SetBit().

Referenced by SetBit().

SetBit() [3/4]

void stsxyter::Message::SetBit ( uint32_t  uShift, uint8_t  uValue  )

inline

Definition at line 234 of file StsXyterMessage.h.

References fuData.

Referenced by SetHitMissEvtsFlag().

SetBit() [4/4]

void stsxyter::Message::SetBit ( uint32_t  uShift, uint8_t  uValue  )

inline

Definition at line 234 of file StsXyterMessage.h.

References fuData.

SetCpFlag() [1/2]

void stsxyter::Message::SetCpFlag ( bool  bVal )

inline

For Status data: Sets the Status (1 bit field)

Definition at line 384 of file StsXyterMessage.h.

References SetField().

SetCpFlag() [2/2]

void stsxyter::Message::SetCpFlag ( bool  bVal )

inline

For Status data: Sets the Status (1 bit field)

Definition at line 384 of file StsXyterMessage.h.

References SetField().

SetData() [1/2]

void stsxyter::Message::SetData ( uint32_t  uValue )

inline

Definition at line 207 of file StsXyterMessage.h.

References fuData.

SetData() [2/2]

void stsxyter::Message::SetData ( uint32_t  uValue )

inline

Definition at line 207 of file StsXyterMessage.h.

References fuData.

SetEmptyMsgFlag() [1/2]

void stsxyter::Message::SetEmptyMsgFlag ( bool  bVal )

inline

For Empty/End of MS data data: Sets the Empty message flag (1 bit field)

Definition at line 397 of file StsXyterMessage.h.

References SetField().

SetEmptyMsgFlag() [2/2]

void stsxyter::Message::SetEmptyMsgFlag ( bool  bVal )

inline

For Empty/End of MS data data: Sets the Empty message flag (1 bit field)

Definition at line 397 of file StsXyterMessage.h.

References SetField().

SetEpochVal() [1/2]

void stsxyter::Message::SetEpochVal ( uint32_t  uVal )

inline

For Epoch data: Sets the Epoch (29 bit field)

Definition at line 353 of file StsXyterMessage.h.

References SetField().

SetEpochVal() [2/2]

void stsxyter::Message::SetEpochVal ( uint32_t  uVal )

inline

For Epoch data: Sets the Epoch (29 bit field)

Definition at line 353 of file StsXyterMessage.h.

References SetField().

SetField() [1/4]

void stsxyter::Message::SetField ( MessField  field, uint32_t  uValue  )

inline

Definition at line 247 of file StsXyterMessage.h.

References stsxyter::MessField::fusLen, stsxyter::MessField::fusPos, and SetField().

Referenced by SetField().

SetField() [2/4]

void stsxyter::Message::SetField ( MessField  field, uint32_t  uValue  )

inline

Definition at line 247 of file StsXyterMessage.h.

References SetField().

Referenced by SetField().

SetField() [3/4]

void stsxyter::Message::SetField ( uint32_t  uShift, uint32_t  uLen, uint32_t  uValue  )

inline

Definition at line 228 of file StsXyterMessage.h.

References fuData.

Referenced by SetCpFlag(), SetEmptyMsgFlag(), SetEpochVal(), SetHitAdc(), SetHitChannel(), SetHitTime(), SetHitTimeFull(), SetHitTimeOver(), SetMsErrorFlag(), SetMsErrorType(), SetStatusDpbTs(), SetStatusLink(), SetStatusStatus(), SetStatusSxTs(), and SetTsMsbVal().

SetField() [4/4]

void stsxyter::Message::SetField ( uint32_t  uShift, uint32_t  uLen, uint32_t  uValue  )

inline

Definition at line 228 of file StsXyterMessage.h.

References fuData.

SetHitAdc() [1/2]

void stsxyter::Message::SetHitAdc ( uint16_t  usVal )

inline

For Hit data: Sets ADC value (5 bit field)

Definition at line 307 of file StsXyterMessage.h.

References SetField().

SetHitAdc() [2/2]

void stsxyter::Message::SetHitAdc ( uint16_t  usVal )

inline

For Hit data: Sets ADC value (5 bit field)

Definition at line 307 of file StsXyterMessage.h.

References SetField().

SetHitChannel() [1/2]

void stsxyter::Message::SetHitChannel ( uint16_t  usVal )

inline

For Hit data: Sets StsXYTER channel number (7 bit field)

Definition at line 304 of file StsXyterMessage.h.

References SetField().

SetHitChannel() [2/2]

void stsxyter::Message::SetHitChannel ( uint16_t  usVal )

inline

For Hit data: Sets StsXYTER channel number (7 bit field)

Definition at line 304 of file StsXyterMessage.h.

References SetField().

SetHitMissEvtsFlag() [1/2]

void stsxyter::Message::SetHitMissEvtsFlag ( bool  bVal )

inline

For Hit data: Sets Missed event flag (1 bit field)

Definition at line 319 of file StsXyterMessage.h.

References SetBit().

SetHitMissEvtsFlag() [2/2]

void stsxyter::Message::SetHitMissEvtsFlag ( bool  bVal )

inline

For Hit data: Sets Missed event flag (1 bit field)

Definition at line 319 of file StsXyterMessage.h.

References SetBit().

SetHitTime() [1/2]

void stsxyter::Message::SetHitTime ( uint16_t  usVal )

inline

For Hit data: Sets Full timestamp (8 bit field, 2 MSB bits overlap removed)

Definition at line 316 of file StsXyterMessage.h.

References SetField().

SetHitTime() [2/2]

void stsxyter::Message::SetHitTime ( uint16_t  usVal )

inline

For Hit data: Sets Full timestamp (8 bit field, 2 MSB bits overlap removed)

Definition at line 316 of file StsXyterMessage.h.

References SetField().

SetHitTimeFull() [1/2]

void stsxyter::Message::SetHitTimeFull ( uint16_t  usVal )

inline

For Hit data: Sets Full timestamp (10 bit field including 2 bits overlap)

Definition at line 310 of file StsXyterMessage.h.

References SetField().

SetHitTimeFull() [2/2]

void stsxyter::Message::SetHitTimeFull ( uint16_t  usVal )

inline

For Hit data: Sets Full timestamp (10 bit field including 2 bits overlap)

Definition at line 310 of file StsXyterMessage.h.

References SetField().

SetHitTimeOver() [1/2]

void stsxyter::Message::SetHitTimeOver ( uint16_t  usVal )

inline

For Hit data: Sets timestamp overlap bits (2 bits field, overlap with 2 LSBs of TS_MSB message)

Definition at line 313 of file StsXyterMessage.h.

References SetField().

SetHitTimeOver() [2/2]

void stsxyter::Message::SetHitTimeOver ( uint16_t  usVal )

inline

For Hit data: Sets timestamp overlap bits (2 bits field, overlap with 2 LSBs of TS_MSB message)

Definition at line 313 of file StsXyterMessage.h.

References SetField().

SetMsErrorFlag() [1/2]

void stsxyter::Message::SetMsErrorFlag ( bool  bVal )

inline

For End of MS data data: Sets the MS Error flag (1 bit field)

Definition at line 400 of file StsXyterMessage.h.

References SetField().

SetMsErrorFlag() [2/2]

void stsxyter::Message::SetMsErrorFlag ( bool  bVal )

inline

For End of MS data data: Sets the MS Error flag (1 bit field)

Definition at line 400 of file StsXyterMessage.h.

References SetField().

SetMsErrorType() [1/2]

void stsxyter::Message::SetMsErrorType ( uint16_t  usVal )

inline

For End of MS data: Sets the MS error type field (2 bit field)

Definition at line 403 of file StsXyterMessage.h.

References SetField().

SetMsErrorType() [2/2]

void stsxyter::Message::SetMsErrorType ( uint16_t  usVal )

inline

For End of MS data: Sets the MS error type field (2 bit field)

Definition at line 403 of file StsXyterMessage.h.

References SetField().

SetStatusDpbTs() [1/2]

void stsxyter::Message::SetStatusDpbTs ( uint16_t  usVal )

inline

For Status data: Sets the Status (9 bit field)

Definition at line 381 of file StsXyterMessage.h.

References SetField().

SetStatusDpbTs() [2/2]

void stsxyter::Message::SetStatusDpbTs ( uint16_t  usVal )

inline

For Status data: Sets the Status (9 bit field)

Definition at line 381 of file StsXyterMessage.h.

References SetField().

SetStatusLink() [1/2]

void stsxyter::Message::SetStatusLink ( uint16_t  usVal )

inline

For Status data: Sets the Status (9 bit field)

Definition at line 372 of file StsXyterMessage.h.

References SetField().

SetStatusLink() [2/2]

void stsxyter::Message::SetStatusLink ( uint16_t  usVal )

inline

For Status data: Sets the Status (9 bit field)

Definition at line 372 of file StsXyterMessage.h.

References SetField().

SetStatusStatus() [1/2]

void stsxyter::Message::SetStatusStatus ( uint16_t  usVal )

inline

For Status data: Sets the Status (4 bit field)

Definition at line 378 of file StsXyterMessage.h.

References SetField().

SetStatusStatus() [2/2]

void stsxyter::Message::SetStatusStatus ( uint16_t  usVal )

inline

For Status data: Sets the Status (4 bit field)

Definition at line 378 of file StsXyterMessage.h.

References SetField().

SetStatusSxTs() [1/2]

void stsxyter::Message::SetStatusSxTs ( uint16_t  usVal )

inline

For Status data: Sets the Status (6 bit field)

Definition at line 375 of file StsXyterMessage.h.

References SetField().

SetStatusSxTs() [2/2]

void stsxyter::Message::SetStatusSxTs ( uint16_t  usVal )

inline

For Status data: Sets the Status (6 bit field)

Definition at line 375 of file StsXyterMessage.h.

References SetField().

SetTsMsbVal() [1/2]

void stsxyter::Message::SetTsMsbVal ( uint32_t  uVal )

inline

For TS MSB data: Sets the TS MSB (22 bit field)

Definition at line 346 of file StsXyterMessage.h.

References SetField().

SetTsMsbVal() [2/2]

void stsxyter::Message::SetTsMsbVal ( uint32_t  uVal )

inline

For TS MSB data: Sets the TS MSB (22 bit field)

Definition at line 346 of file StsXyterMessage.h.

References SetField().

Member Data Documentation

fuData

uint32_t stsxyter::Message::fuData

protected

Definition at line 178 of file StsXyterMessage.h.

Referenced by assign(), DataBE(), GetBit(), GetData(), GetField(), reset(), SetBit(), SetData(), and SetField().

---

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

• decoder/fles_cbm/StsXyterMessage.h
• install/include/StsXyterMessage.h