Class representing data record for time-of-flight detectors. More...

#include <AFP_ToFRawData_v2.h>

Inheritance diagram for AFP_ToFRawData_v2:

Collaboration diagram for AFP_ToFRawData_v2:

Public Member Functions
	AFP_ToFRawData_v2 ()

	AFP_ToFRawData_v2 (const AFP_ToFRawData_v2 &copy)

uint16_t	header () const
	Value of 9-11 (HPTDC) or 9 (picoTDC) most significant bit(s) More...

void	setHeader (const uint16_t header)

uint16_t	edge () const
	Value of 12 most significant bit. More...

void	setEdge (const uint16_t edge)

uint16_t	channel () const
	Value of 13-17 (HPTDC) or 14-19 (picoTDC) most significant bits. More...

void	setChannel (const uint16_t channel)

void	setTrigger ()

bool	isTrigger () const

uint32_t	time () const
	Value of 10 (HPTDC) or 13 (picoTDC) least significant bits for time; value of 14-16 (picoTDC) most significant bits for delayed trigger. More...

void	setTime (const uint32_t time)

uint32_t	pulseLength () const
	Value of 11-16 (HPTDC) or 13 (picoTDC) least significant bits for signal lenght; value of 16 (picoTDC) least significant bits for trigger pattern. More...

void	setPulseLength (const uint32_t pulseLength)

uint16_t	delayedTrigger () const
	Value of 10 (HPTDC) or 13 (picoTDC) least significant bits for time; value of 14-16 (picoTDC) most significant bits for delayed trigger. More...

void	setDelayedTrigger (const uint32_t delayedTrigger)

uint32_t	triggerPattern () const
	Value of 11-16 (HPTDC) or 13 (picoTDC) least significant bits for signal lenght; value of 16 (picoTDC) least significant bits for trigger pattern. More...

void	setTriggerPattern (const uint32_t triggerPattern)

uint16_t	hitDiscConfig () const
	Value of third and forth most significant bits. More...

void	setHitDiscConfig (const uint16_t hitDiscConfig)

uint16_t	link () const

void	setLink (const uint16_t outlink)

bool	msgLvl (const MSG::Level lvl) const
	Test the output level. More...

MsgStream &	msg () const
	The standard message stream. More...

MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream. More...

void	setLevel (MSG::Level lvl)
	Change the current logging level. More...

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
uint16_t	m_header = 0U
	Value of 9-11 (HPTDC) or 9 (picoTDC) most significant bit(s) More...

uint16_t	m_edge = 0U
	Value of 12 most significant bit. More...

uint16_t	m_channel = 0U
	Value of 13-17 (HPTDC) or 14-19 (picoTDC) most significant bits. More...

const uint16_t	m_triggerChannel = 65535
	Special value for channel number, denoting the entry is actually a trigger word. More...

uint32_t	m_time_or_delayedTrigger = 0U
	Value of 10 (HPTDC) or 13 (picoTDC) least significant bits for time; value of 14-16 (picoTDC) most significant bits for delayed trigger. More...

uint32_t	m_pulseLength_or_triggerPattern = 0U
	Value of 11-16 (HPTDC) or 13 (picoTDC) least significant bits for signal lenght; value of 16 (picoTDC) least significant bits for trigger pattern. More...

uint16_t	m_hitDiscConfig = 0
	Value of third and forth most significant bits. More...

uint16_t	m_link = 0
	Values of the 5-8 most significant bits. More...

std::string	m_nm
	Message source name. More...

boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels) More...

std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer. More...

std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level. More...

std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging) More...

Detailed Description

Class representing data record for time-of-flight detectors.

Documentation of the format is available in the twiki page: https://twiki.cern.ch/twiki/bin/view/Atlas/AFPHPTDC#Data_Encoding

Definition at line 21 of file AFP_ToFRawData_v2.h.

Constructor & Destructor Documentation

◆ AFP_ToFRawData_v2() [1/2]

AFP_ToFRawData_v2::AFP_ToFRawData_v2 ( )

Definition at line 9 of file AFP_ToFRawData_v2.cxx.

                                     : AFP_RawDataCommonHead(),
   AthMessaging(Gaudi::svcLocator()->service< IMessageSvc >("MessageSvc"),"AFP_ToFRawData_v2")
 {}

◆ AFP_ToFRawData_v2() [2/2]

AFP_ToFRawData_v2::AFP_ToFRawData_v2 ( const AFP_ToFRawData_v2 & copy )

Definition at line 14 of file AFP_ToFRawData_v2.cxx.

                                                                  : AFP_RawDataCommonHead(copy),
   AthMessaging(Gaudi::svcLocator()->service< IMessageSvc >("MessageSvc"),"AFP_ToFRawData_v2")
 {
   m_header=copy.m_header;
   m_edge=copy.m_edge;
   m_channel=copy.m_channel;
   m_time_or_delayedTrigger=copy.m_time_or_delayedTrigger;
   m_pulseLength_or_triggerPattern=copy.m_pulseLength_or_triggerPattern;
 }

Member Function Documentation

◆ channel()

uint16_t AFP_ToFRawData_v2::channel ( ) const

inline

Value of 13-17 (HPTDC) or 14-19 (picoTDC) most significant bits.

In the following records: HPTDC 2017: xxxx xxxx xxxx CCCC xxxx xxxx xxxx xxxx picoTDC #1+#2: xxxx xxxx xxxx xCCC CCCx xxxx xxxx xxxx it means bits marked with C. Contains information about channel of the time measurement.

Definition at line 38 of file AFP_ToFRawData_v2.h.

38 {return m_channel;}

◆ delayedTrigger()

uint16_t AFP_ToFRawData_v2::delayedTrigger ( ) const

Value of 10 (HPTDC) or 13 (picoTDC) least significant bits for time; value of 14-16 (picoTDC) most significant bits for delayed trigger.

In the following records: HPTDC 2017: xxxx xxxx xxxx xxxx xxxx xxtt tttt tttt picoTDC #1: xxxx xxxx xxxx xxxx xxxt tttt tttt tttt Trigger: xxxx xxxx xxxx xTTT xxxx xxxx xxxx xxxx it means bits marked with t or T. Contains information about time (t) or about delayed trigger (T).

Definition at line 69 of file AFP_ToFRawData_v2.cxx.

 {
   if(!this->isTrigger())
   {
     ATH_MSG_WARNING("asking for delayedTrigger but this is not a trigger word, returning 0");
     return 0;
   }
   return m_time_or_delayedTrigger;
 }

◆ edge()

uint16_t AFP_ToFRawData_v2::edge ( ) const

inline

Value of 12 most significant bit.

In the following record: xxxx xxxx xxxE xxxx xxxx xxxx xxxx xxxx it means bits marked with E. Contains information about signal beginning or end. Always set to 0 for picoTDC.

Definition at line 34 of file AFP_ToFRawData_v2.h.

34 {return m_edge;}

◆ header()

uint16_t AFP_ToFRawData_v2::header ( ) const

inline

Value of 9-11 (HPTDC) or 9 (picoTDC) most significant bit(s)

In the following records: HPTDC 2017: xxxx xxxx hhhx xxxx xxxx xxxx xxxx xxxx picoTDC: xxxx xxxx hxxx xxxx xxxx xxxx xxxx xxxx it means bits marked with h. Contains information about time-of-flight data type or error:

value 0 means HPTDC header
value 1 meas picoTDC header
value 2 means hit measurement (only HPTDC)
value 3 is per event error (only HPTDC)

Definition at line 30 of file AFP_ToFRawData_v2.h.

30 {return m_header;}

◆ hitDiscConfig()

uint16_t AFP_RawDataCommonHead::hitDiscConfig ( ) const

inlineinherited

Value of third and forth most significant bits.

In the following record: xxdd xxxx xxxx xxxx xxxx xxxx xxxx xxxx it means bits marked with d.

values 0-2 are used by silicon detectors
value 3 represent time-of-flight detector

Definition at line 20 of file AFP_RawDataCommonHead.h.

20 {return m_hitDiscConfig;};

◆ initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

 {
   m_imsg = Athena::getMessageSvc();
   m_lvl = m_imsg ?
     static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
     MSG::INFO;
 }

◆ isTrigger()

bool AFP_ToFRawData_v2::isTrigger ( ) const

inline

Definition at line 41 of file AFP_ToFRawData_v2.h.

41 {return m_channel==m_triggerChannel;}

◆ link()

uint16_t AFP_RawDataCommonHead::link ( ) const

inlineinherited

Definition at line 23 of file AFP_RawDataCommonHead.h.

23 {return m_link;};

◆ msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 164 of file AthMessaging.h.

 {
   MsgStream* ms = m_msg_tls.get();
   if (!ms) {
     if (!m_initialized.test_and_set()) initMessaging();
     ms = new MsgStream(m_imsg,m_nm);
     m_msg_tls.reset( ms );
   }
  
   ms->setLevel (m_lvl);
   return *ms;
 }

◆ msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 179 of file AthMessaging.h.

180 { return msg() << lvl; }

◆ msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns: boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

 {
   if (!m_initialized.test_and_set()) initMessaging();
   if (m_lvl <= lvl) {
     msg() << lvl;
     return true;
   } else {
     return false;
   }
 }

◆ pulseLength()

uint32_t AFP_ToFRawData_v2::pulseLength ( ) const

Value of 11-16 (HPTDC) or 13 (picoTDC) least significant bits for signal lenght; value of 16 (picoTDC) least significant bits for trigger pattern.

In the following record: HPTDC 2017: xxxx xxxx xxxx xxxx LLLL LLxx xxxx xxxx picoTDC #2: xxxx xxxx xxxx xxxx xxxx LLLL LLLL LLLL Trigger: xxxx xxxx xxxx xxxx PPPP PPPP PPPP PPPP it means bits marked with L or P. Contains information how long signal from the bar was above threshold (L) or information about the trigger pattern (P).

Definition at line 47 of file AFP_ToFRawData_v2.cxx.

 {
   if(this->isTrigger())
   {
     ATH_MSG_WARNING("asking for pulseLength but this is a trigger word, returning 0");
     return 0;
   }
   return m_pulseLength_or_triggerPattern;
 }

◆ setChannel()

void AFP_ToFRawData_v2::setChannel ( const uint16_t channel )

inline

Definition at line 39 of file AFP_ToFRawData_v2.h.

39 {m_channel = channel;}

◆ setDelayedTrigger()

void AFP_ToFRawData_v2::setDelayedTrigger ( const uint32_t delayedTrigger )

Definition at line 80 of file AFP_ToFRawData_v2.cxx.

 {
   if(!this->isTrigger())
   {
     ATH_MSG_WARNING("trying to set delayedTrigger but this is not a trigger word, not setting anything");
     return;
   }
   m_time_or_delayedTrigger = delayedTrigger;
 }

◆ setEdge()

void AFP_ToFRawData_v2::setEdge ( const uint16_t edge )

inline

Definition at line 35 of file AFP_ToFRawData_v2.h.

35 {m_edge = edge;}

◆ setHeader()

void AFP_ToFRawData_v2::setHeader ( const uint16_t header )

inline

Definition at line 31 of file AFP_ToFRawData_v2.h.

31 {m_header = header;}

◆ setHitDiscConfig()

void AFP_RawDataCommonHead::setHitDiscConfig ( const uint16_t hitDiscConfig )

inlineinherited

Definition at line 21 of file AFP_RawDataCommonHead.h.

21 {m_hitDiscConfig = hitDiscConfig;}

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

 {
   m_lvl = lvl;
 }

◆ setLink()

void AFP_RawDataCommonHead::setLink ( const uint16_t outlink )

inlineinherited

Definition at line 24 of file AFP_RawDataCommonHead.h.

24 {m_link = outlink;}

◆ setPulseLength()

void AFP_ToFRawData_v2::setPulseLength ( const uint32_t pulseLength )

Definition at line 58 of file AFP_ToFRawData_v2.cxx.

 {
   if(this->isTrigger())
   {
     ATH_MSG_WARNING("trying to set pulseLength but this is a trigger word, not setting anything");
     return;
   }
   m_pulseLength_or_triggerPattern = pulseLength;
 }

◆ setTime()

void AFP_ToFRawData_v2::setTime ( const uint32_t time )

Definition at line 36 of file AFP_ToFRawData_v2.cxx.

 {
   if(this->isTrigger())
   {
     ATH_MSG_WARNING("trying to set time but this is a trigger word, not setting anything");
     return;
   }
   m_time_or_delayedTrigger = time;
 }

◆ setTrigger()

void AFP_ToFRawData_v2::setTrigger ( )

inline

Definition at line 40 of file AFP_ToFRawData_v2.h.

40 {m_channel=m_triggerChannel;}

◆ setTriggerPattern()

void AFP_ToFRawData_v2::setTriggerPattern ( const uint32_t triggerPattern )

Definition at line 102 of file AFP_ToFRawData_v2.cxx.

 {
   if(!this->isTrigger())
   {
     ATH_MSG_WARNING("trying to set triggerPattern but this is not a trigger word, not setting anything");
     return;
   }
   m_pulseLength_or_triggerPattern = triggerPattern;
 }

◆ time()

uint32_t AFP_ToFRawData_v2::time ( ) const

Value of 10 (HPTDC) or 13 (picoTDC) least significant bits for time; value of 14-16 (picoTDC) most significant bits for delayed trigger.

In the following records: HPTDC 2017: xxxx xxxx xxxx xxxx xxxx xxtt tttt tttt picoTDC #1: xxxx xxxx xxxx xxxx xxxt tttt tttt tttt Trigger: xxxx xxxx xxxx xTTT xxxx xxxx xxxx xxxx it means bits marked with t or T. Contains information about time (t) or about delayed trigger (T).

Definition at line 25 of file AFP_ToFRawData_v2.cxx.

 {
   if(this->isTrigger())
   {
     ATH_MSG_WARNING("asking for time but this is a trigger word, returning 0");
     return 0;
   }
   return m_time_or_delayedTrigger;
 }

◆ triggerPattern()

uint32_t AFP_ToFRawData_v2::triggerPattern ( ) const

Value of 11-16 (HPTDC) or 13 (picoTDC) least significant bits for signal lenght; value of 16 (picoTDC) least significant bits for trigger pattern.

In the following record: HPTDC 2017: xxxx xxxx xxxx xxxx LLLL LLxx xxxx xxxx picoTDC #2: xxxx xxxx xxxx xxxx xxxx LLLL LLLL LLLL Trigger: xxxx xxxx xxxx xxxx PPPP PPPP PPPP PPPP it means bits marked with L or P. Contains information how long signal from the bar was above threshold (L) or information about the trigger pattern (P).

Definition at line 91 of file AFP_ToFRawData_v2.cxx.

 {
   if(!this->isTrigger())
   {
     ATH_MSG_WARNING("asking for triggerPattern but this is not a trigger word, returning 0");
     return 0;
   }
   return m_pulseLength_or_triggerPattern;
 }

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

◆ m_channel

uint16_t AFP_ToFRawData_v2::m_channel = 0U

private

Value of 13-17 (HPTDC) or 14-19 (picoTDC) most significant bits.

In the following records: HPTDC 2017: xxxx xxxx xxxx CCCC xxxx xxxx xxxx xxxx picoTDC #1+#2: xxxx xxxx xxxx xCCC CCCx xxxx xxxx xxxx it means bits marked with C. Contains information about channel of the time measurement.

Definition at line 86 of file AFP_ToFRawData_v2.h.

◆ m_edge

uint16_t AFP_ToFRawData_v2::m_edge = 0U

private

Value of 12 most significant bit.

In the following record: xxxx xxxx xxxE xxxx xxxx xxxx xxxx xxxx it means bits marked with E. Contains information about signal beginning or end. Always set to 0 for picoTDC.

Definition at line 77 of file AFP_ToFRawData_v2.h.

◆ m_header

uint16_t AFP_ToFRawData_v2::m_header = 0U

private

Value of 9-11 (HPTDC) or 9 (picoTDC) most significant bit(s)

In the following records: HPTDC 2017: xxxx xxxx hhhx xxxx xxxx xxxx xxxx xxxx picoTDC: xxxx xxxx hxxx xxxx xxxx xxxx xxxx xxxx it means bits marked with h. Contains information about time-of-flight data type or error:

value 0 means HPTDC header
value 1 meas picoTDC header
value 2 means hit measurement (only HPTDC)
value 3 is per event error (only HPTDC)

Definition at line 70 of file AFP_ToFRawData_v2.h.

◆ m_hitDiscConfig

uint16_t AFP_RawDataCommonHead::m_hitDiscConfig = 0

privateinherited

Value of third and forth most significant bits.

In the following record: xxdd xxxx xxxx xxxx xxxx xxxx xxxx xxxx it means bits marked with d.

values 0-2 are used by silicon detectors
value 3 represent time-of-flight detector

Definition at line 33 of file AFP_RawDataCommonHead.h.

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

◆ m_link

uint16_t AFP_RawDataCommonHead::m_link = 0

privateinherited

Values of the 5-8 most significant bits.

In the following record: xxxx LLLL xxxx xxxx xxxx xxxx xxxx xxxx it means bits marked with L.

Definition at line 39 of file AFP_RawDataCommonHead.h.

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

◆ m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

◆ m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_pulseLength_or_triggerPattern

uint32_t AFP_ToFRawData_v2::m_pulseLength_or_triggerPattern = 0U

private

Value of 11-16 (HPTDC) or 13 (picoTDC) least significant bits for signal lenght; value of 16 (picoTDC) least significant bits for trigger pattern.

In the following record: HPTDC 2017: xxxx xxxx xxxx xxxx LLLL LLxx xxxx xxxx picoTDC #2: xxxx xxxx xxxx xxxx xxxx LLLL LLLL LLLL Trigger: xxxx xxxx xxxx xxxx PPPP PPPP PPPP PPPP it means bits marked with L or P. Contains information how long signal from the bar was above threshold (L) or information about the trigger pattern (P).

Definition at line 110 of file AFP_ToFRawData_v2.h.

◆ m_time_or_delayedTrigger

uint32_t AFP_ToFRawData_v2::m_time_or_delayedTrigger = 0U

private

Value of 10 (HPTDC) or 13 (picoTDC) least significant bits for time; value of 14-16 (picoTDC) most significant bits for delayed trigger.

In the following records: HPTDC 2017: xxxx xxxx xxxx xxxx xxxx xxtt tttt tttt picoTDC #1: xxxx xxxx xxxx xxxx xxxt tttt tttt tttt Trigger: xxxx xxxx xxxx xTTT xxxx xxxx xxxx xxxx it means bits marked with t or T. Contains information about time (t) or about delayed trigger (T).

Definition at line 100 of file AFP_ToFRawData_v2.h.

◆ m_triggerChannel

const uint16_t AFP_ToFRawData_v2::m_triggerChannel = 65535

private

Special value for channel number, denoting the entry is actually a trigger word.

Data cannot have this channel number as there are no more than 6 bit, meaning maximum channel number is 63

Definition at line 91 of file AFP_ToFRawData_v2.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AFP_ToFRawData_v2() [1/2]

◆ AFP_ToFRawData_v2() [2/2]

Member Function Documentation

◆ channel()

◆ delayedTrigger()

◆ edge()

◆ header()

◆ hitDiscConfig()

◆ initMessaging()

◆ isTrigger()

◆ link()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ pulseLength()

◆ setChannel()

◆ setDelayedTrigger()

◆ setEdge()

◆ setHeader()

◆ setHitDiscConfig()

◆ setLevel()

◆ setLink()

◆ setPulseLength()

◆ setTime()

◆ setTrigger()

◆ setTriggerPattern()

◆ time()

◆ triggerPattern()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_channel

◆ m_edge

◆ m_header

◆ m_hitDiscConfig

◆ m_imsg

◆ m_link

◆ m_lvl

◆ m_msg_tls

◆ m_nm

◆ m_pulseLength_or_triggerPattern

◆ m_time_or_delayedTrigger

◆ m_triggerChannel