Template Frame for ARS data. More...

#include <frame.hh>

Inheritance diagram for Frame< T >:

Public Types
typedef T	item_type
	item type definition More...

Public Member Functions
const DAQCommonHeader *const	getHeader () const

const char *const	getPayload () const

unsigned int	getSeqNumber () const

unsigned int	getFrameLength () const

unsigned int	getNItems () const

	Frame ()
	Default constructor. More...

Frame< T > &	operator+= (const Frame< T > &object)
	operator += More...

	ClassDef (Frame, 2)
	ROOT class definition. More...

ulonglong	frameTime ()

const unsigned short	lcm_id () const
	get LCM idendifier More...

const unsigned short	ars_id () const
	get ARS idendifier More...

const unsigned short	data_type () const
	get data type More...

const unsigned short	numberOfItems () const
	get number of items More...

virtual const unsigned char *	getdata () const
	Return a pointer to the frame data buffer. More...

virtual const unsigned int	getdatalen () const
	Return the length of the frame data buffer. More...

	ClassDef (DaqFramePreamble, 2)

Static Public Member Functions
static const unsigned int	Length ()
	Return length of an encoded frame preamble in bytes. More...

Public Attributes
unsigned int	frameSize
	Total length of the frame in 4-byte words. More...

unsigned short	dataType
	Data type code (DAQ_xxx) More...

unsigned short	frameTarget
	Unique code representing the shore station for this frame. More...

unsigned int	frameTime1
	Frame 'time stamp' in units of 50ns (MSW) More...

unsigned int	frameTime2
	Frame 'time stamp' in units of 50ns (LSW) More...

unsigned int	frameIndex
	Number of frames since start of the run. More...

unsigned short	status
	Status of frame Xon/Xoff. More...

unsigned short	nbItems
	Number of items actually sent in this frame. More...

unsigned short	LCM_ID
	ID of originating LCM. More...

unsigned short	ARS_ID
	ID of originating ARS. More...

unsigned int	runNumber
	Run-number as given by the RunControl. More...

Private Attributes
unsigned int	m_seqnumber

Friends
class	PuzzledFrame

std::ostream &	operator<< (std::ostream &out, const Frame &object)
	Print ASCII. More...

Detailed Description

template<class T>
class Frame< T >

Template Frame for ARS data.

Author: cpellegrino

Definition at line 12 of file frame.hh.

Member Typedef Documentation

◆ item_type

template<class T>

typedef T Frame< T >::item_type

item type definition

Definition at line 233 of file TimeSlice.hh.

Constructor & Destructor Documentation

◆ Frame()

template<class T>

Frame< T >::Frame ( )

inline

Default constructor.

Definition at line 238 of file TimeSlice.hh.

           :
     DaqFramePreamble()
   {}

Member Function Documentation

◆ getHeader()

template<class T>

const DAQCommonHeader* const Frame< T >::getHeader ( ) const

inline

Definition at line 18 of file frame.hh.

   {
     return static_cast<const DAQCommonHeader* const>(
         static_cast<const void* const>(&front()));
   }

◆ getPayload()

template<class T>

const char* const Frame< T >::getPayload ( ) const

inline

Definition at line 24 of file frame.hh.

   {
     return &front() + sizeof(DAQCommonHeader);
   }

◆ getSeqNumber()

template<class T>

unsigned int Frame< T >::getSeqNumber ( ) const

inline

Definition at line 29 of file frame.hh.

   {
     return m_seqnumber;
   }

◆ getFrameLength()

template<class T>

unsigned int Frame< T >::getFrameLength ( ) const

inline

Definition at line 34 of file frame.hh.

   {
     return size() ? getHeader()->FrameLength : 0;
   }

◆ getNItems()

template<class T>

unsigned int Frame< T >::getNItems ( ) const

inline

Definition at line 39 of file frame.hh.

   {
     return size() ? getHeader()->NumberOfItems : 0;
   }

◆ operator+=()

template<class T>

Frame<T>& Frame< T >::operator+= ( const Frame< T > & object )

inline

operator +=

Parameters

object frame

Returns: this frame

Definition at line 272 of file TimeSlice.hh.

   {
     if ((DaqFramePreamble&) *this == (DaqFramePreamble&) object) {
       for (typename Frame<T>::const_iterator i = object.begin(); i != object.end(); ++i) {
         this->insert(std::lower_bound(Frame<T>::begin(),Frame<T>::end(),*i),*i);
       }
     }
     
     return *this;
   }

◆ ClassDef() [1/2]

template<class T>

Frame< T >::ClassDef	(	Frame< T >	,
		2
	)

ROOT class definition.

◆ frameTime()

ulonglong DaqFramePreamble::frameTime ( )

inlineinherited

Returns: 64 bit frame time

Definition at line 40 of file FramePreamble.hh.

   {
     return ulonglong(frameTime1,frameTime2);
   }

◆ lcm_id()

const unsigned short DaqFramePreamble::lcm_id ( ) const

inlineinherited

get LCM idendifier

Returns: LCM identifier

Definition at line 67 of file FramePreamble.hh.

67 { return LCM_ID; }

◆ ars_id()

const unsigned short DaqFramePreamble::ars_id ( ) const

inlineinherited

get ARS idendifier

Returns: ARS identifier

Definition at line 73 of file FramePreamble.hh.

73 { return ARS_ID; }

◆ data_type()

const unsigned short DaqFramePreamble::data_type ( ) const

inlineinherited

get data type

Returns: data type

Definition at line 79 of file FramePreamble.hh.

79 { return dataType; }

◆ numberOfItems()

const unsigned short DaqFramePreamble::numberOfItems ( ) const

inlineinherited

get number of items

Returns: number of items

Definition at line 85 of file FramePreamble.hh.

85 { return nbItems; }

◆ getdata()

virtual const unsigned char* DaqFramePreamble::getdata ( ) const

inlinevirtualinherited

Return a pointer to the frame data buffer.

The returned value points to the start of the frame preamble.

Returns: pointer to data

Definition at line 92 of file FramePreamble.hh.

92 { return NULL; }

◆ getdatalen()

virtual const unsigned int DaqFramePreamble::getdatalen ( ) const

inlinevirtualinherited

Return the length of the frame data buffer.

The returned value is in bytes (not words), and includes the frame preamble.

Returns: length of data

Definition at line 100 of file FramePreamble.hh.

100 { return Length(); }

◆ Length()

static const unsigned int DaqFramePreamble::Length ( )

inlinestaticinherited

Return length of an encoded frame preamble in bytes.

Definition at line 111 of file FramePreamble.hh.

111 { return 32; }

◆ ClassDef() [2/2]

DaqFramePreamble::ClassDef	(	DaqFramePreamble	,
		2
	)

inherited

Friends And Related Function Documentation

◆ PuzzledFrame

template<class T>

friend class PuzzledFrame

friend

Definition at line 44 of file frame.hh.

◆ operator<<

template<class T>

std::ostream& operator<<	(	std::ostream &	out,
		const Frame< T > &	object
	)

friend

Print ASCII.

Parameters

out	output stream
object	frame

Returns: output stream

Definition at line 249 of file TimeSlice.hh.

   {
     using namespace std;
     
     out << static_cast<const DaqFramePreamble&>(object);
  
     if (!object.empty()) {            
       out << ' ' << *(object. begin());
       out << " ... ";
       out << ' ' << *(object.rbegin());
       out << endl;
     }
  
  
     return out;
   }

Member Data Documentation

◆ m_seqnumber

template<class T>

unsigned int Frame< T >::m_seqnumber

private

Definition at line 14 of file frame.hh.

◆ frameSize

unsigned int DaqFramePreamble::frameSize

inherited

Total length of the frame in 4-byte words.

Definition at line 27 of file FramePreamble.hh.

◆ dataType

unsigned short DaqFramePreamble::dataType

inherited

Data type code (DAQ_xxx)

Definition at line 30 of file FramePreamble.hh.

◆ frameTarget

unsigned short DaqFramePreamble::frameTarget

inherited

Unique code representing the shore station for this frame.

Definition at line 33 of file FramePreamble.hh.

◆ frameTime1

unsigned int DaqFramePreamble::frameTime1

inherited

Frame 'time stamp' in units of 50ns (MSW)

Definition at line 36 of file FramePreamble.hh.

◆ frameTime2

unsigned int DaqFramePreamble::frameTime2

inherited

Frame 'time stamp' in units of 50ns (LSW)

Definition at line 38 of file FramePreamble.hh.

◆ frameIndex

unsigned int DaqFramePreamble::frameIndex

inherited

Number of frames since start of the run.

Definition at line 46 of file FramePreamble.hh.

◆ status

unsigned short DaqFramePreamble::status

inherited

Status of frame Xon/Xoff.

Definition at line 49 of file FramePreamble.hh.

◆ nbItems

unsigned short DaqFramePreamble::nbItems

inherited

Number of items actually sent in this frame.

Definition at line 52 of file FramePreamble.hh.

◆ LCM_ID

unsigned short DaqFramePreamble::LCM_ID

inherited

ID of originating LCM.

Definition at line 55 of file FramePreamble.hh.

◆ ARS_ID

unsigned short DaqFramePreamble::ARS_ID

inherited

ID of originating ARS.

Definition at line 58 of file FramePreamble.hh.

◆ runNumber

unsigned int DaqFramePreamble::runNumber

inherited

Run-number as given by the RunControl.

Definition at line 61 of file FramePreamble.hh.

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Attributes

Friends

Detailed Description

template<class T> class Frame< T >

Member Typedef Documentation

◆ item_type

Constructor & Destructor Documentation

◆ Frame()

Member Function Documentation

◆ getHeader()

◆ getPayload()

◆ getSeqNumber()

◆ getFrameLength()

◆ getNItems()

◆ operator+=()

◆ ClassDef() [1/2]

◆ frameTime()

◆ lcm_id()

◆ ars_id()

◆ data_type()

◆ numberOfItems()

◆ getdata()

◆ getdatalen()

◆ Length()

◆ ClassDef() [2/2]

Friends And Related Function Documentation

◆ PuzzledFrame

◆ operator<<

Member Data Documentation

◆ m_seqnumber

◆ frameSize

◆ dataType

◆ frameTarget

◆ frameTime1

◆ frameTime2

◆ frameIndex

◆ status

◆ nbItems

◆ LCM_ID

◆ ARS_ID

◆ runNumber

template<class T>
class Frame< T >