This object holds the information from the 'preamble' of a data frame.
More...
#include <FramePreamble.hh>
|
static const unsigned int | Length () |
| Return length of an encoded frame preamble in bytes. More...
|
|
This object holds the information from the 'preamble' of a data frame.
Definition at line 23 of file FramePreamble.hh.
◆ DaqFramePreamble()
DaqFramePreamble::DaqFramePreamble |
( |
| ) |
|
|
inline |
◆ ~DaqFramePreamble()
virtual DaqFramePreamble::~DaqFramePreamble |
( |
| ) |
|
|
inlinevirtual |
◆ frameTime()
◆ lcm_id()
const unsigned short DaqFramePreamble::lcm_id |
( |
| ) |
const |
|
inline |
◆ ars_id()
const unsigned short DaqFramePreamble::ars_id |
( |
| ) |
const |
|
inline |
◆ data_type()
const unsigned short DaqFramePreamble::data_type |
( |
| ) |
const |
|
inline |
◆ numberOfItems()
const unsigned short DaqFramePreamble::numberOfItems |
( |
| ) |
const |
|
inline |
get number of items
- Returns
- number of items
Definition at line 85 of file FramePreamble.hh.
◆ getdata()
virtual const unsigned char* DaqFramePreamble::getdata |
( |
| ) |
const |
|
inlinevirtual |
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.
◆ getdatalen()
virtual const unsigned int DaqFramePreamble::getdatalen |
( |
| ) |
const |
|
inlinevirtual |
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.
◆ Length()
static const unsigned int DaqFramePreamble::Length |
( |
| ) |
|
|
inlinestatic |
Return length of an encoded frame preamble in bytes.
Definition at line 111 of file FramePreamble.hh.
◆ ClassDef()
◆ operator<<
std::ostream& operator<< |
( |
std::ostream & |
out, |
|
|
const DaqFramePreamble & |
object |
|
) |
| |
|
friend |
Print ASCII.
- Parameters
-
out | output stream |
object | frame preamble |
- Returns
- output stream
Definition at line 120 of file FramePreamble.hh.
124 out <<
"frameSize " <<
object.frameSize << endl;
125 out <<
"dataType " <<
object.dataType << endl;
126 out <<
"frameTarget " <<
object.frameTarget << endl;
127 out <<
"frameTime1 " <<
object.frameTime1 << endl;
128 out <<
"frameTime2 " <<
object.frameTime2 << endl;
129 out <<
"frameIndex " <<
object.frameIndex << endl;
130 out <<
"status " <<
object.status << endl;
131 out <<
"nbItems " <<
object.nbItems << endl;
132 out <<
"LCM_ID " <<
object.LCM_ID << endl;
133 out <<
"ARS_ID " <<
object.ARS_ID << endl;
134 out <<
"runNumber " <<
object.runNumber << endl;
◆ frameSize
unsigned int DaqFramePreamble::frameSize |
Total length of the frame in 4-byte words.
Definition at line 27 of file FramePreamble.hh.
◆ dataType
unsigned short DaqFramePreamble::dataType |
◆ frameTarget
unsigned short DaqFramePreamble::frameTarget |
Unique code representing the shore station for this frame.
Definition at line 33 of file FramePreamble.hh.
◆ frameTime1
unsigned int DaqFramePreamble::frameTime1 |
◆ frameTime2
unsigned int DaqFramePreamble::frameTime2 |
◆ frameIndex
unsigned int DaqFramePreamble::frameIndex |
◆ status
unsigned short DaqFramePreamble::status |
◆ nbItems
unsigned short DaqFramePreamble::nbItems |
Number of items actually sent in this frame.
Definition at line 52 of file FramePreamble.hh.
◆ LCM_ID
unsigned short DaqFramePreamble::LCM_ID |
◆ ARS_ID
unsigned short DaqFramePreamble::ARS_ID |
◆ runNumber
unsigned int DaqFramePreamble::runNumber |
The documentation for this class was generated from the following file: