Jpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
KM3NETDAQ::JDAQPreamble Class Reference

DAQ preamble. More...

#include <JDAQPreamble.hh>

Inheritance diagram for KM3NETDAQ::JDAQPreamble:
KM3NETDAQ::JDAQAbstractPreamble TObject KM3NETDAQ::JDAQEvent KM3NETDAQ::JDAQSummaryslice KM3NETDAQ::JDAQSuperFrame KM3NETDAQ::JDAQTimeslice JTRIGGER::JTriggeredEvent JSUPPORT::JSummaryslice KM3NETDAQ::JDAQTimesliceL0 KM3NETDAQ::JDAQTimesliceL1 KM3NETDAQ::JDAQTimesliceL2 KM3NETDAQ::JDAQTimesliceSN KM3NETDAQ::JEventTimeslice KM3NETDAQ::JRandomTimeslice

Public Member Functions

 JDAQPreamble ()
 Default constructor. More...
 
virtual ~JDAQPreamble ()
 Virtual destructor. More...
 
virtual int getSize () const
 Get size of object. More...
 
 ClassDef (JDAQPreamble, 1)
 
int getLength () const
 Get length. More...
 
int getDataType () const
 Get data type. More...
 
 ClassDefNV (JDAQAbstractPreamble, 1)
 

Static Public Member Functions

static int sizeOf ()
 Get size of object. More...
 

Protected Member Functions

template<class T >
 JDAQPreamble (JDAQType< T > type)
 Constructor. More...
 
void setLength ()
 Set length. More...
 

Protected Attributes

int length
 
int type
 

Friends

JReaderoperator>> (JReader &in, JDAQPreamble &preamble)
 Read DAQ preamble from input. More...
 
JWriteroperator<< (JWriter &out, const JDAQPreamble &preamble)
 Write DAQ preamble to output. More...
 

Detailed Description

DAQ preamble.

Note that for I/O, the data member length is read whereas the return value of the virtual method getSize() is written.

Any derived class should provide for an implementation of method getSize() so that the actual size of the object is written.

The data type is determined by the return value of method getDataType(). This method should be overloaded so that each data type is uniquely mapped to an integer value.

The size and type information of the (abstract) object can be used for RTTI.

Definition at line 39 of file JDAQPreamble.hh.

Constructor & Destructor Documentation

template<class T >
KM3NETDAQ::JDAQPreamble::JDAQPreamble ( JDAQType< T >  type)
inlineprotected

Constructor.

Parameters
typedata type of derived class

Definition at line 51 of file JDAQPreamble.hh.

KM3NETDAQ::JDAQPreamble::JDAQPreamble ( )
inline

Default constructor.

Definition at line 60 of file JDAQPreamble.hh.

60  :
62 
63  {}
JDAQAbstractPreamble()
Default constuctor.
virtual KM3NETDAQ::JDAQPreamble::~JDAQPreamble ( )
inlinevirtual

Virtual destructor.

Definition at line 69 of file JDAQPreamble.hh.

70  {}

Member Function Documentation

static int KM3NETDAQ::JDAQPreamble::sizeOf ( )
inlinestatic

Get size of object.

Returns
number of bytes

Definition at line 110 of file JDAQPreamble.hh.

111  {
113  }
static int sizeOf()
Get size of object.
virtual int KM3NETDAQ::JDAQPreamble::getSize ( ) const
inlinevirtual

Get size of object.

Returns
number of bytes

Reimplemented in KM3NETDAQ::JDAQEvent, KM3NETDAQ::JDAQTimeslice, KM3NETDAQ::JDAQSuperFrame, and KM3NETDAQ::JDAQSummaryslice.

Definition at line 121 of file JDAQPreamble.hh.

122  {
123  return JDAQPreamble::sizeOf();
124  }
static int sizeOf()
Get size of object.
KM3NETDAQ::JDAQPreamble::ClassDef ( JDAQPreamble  ,
 
)
void KM3NETDAQ::JDAQPreamble::setLength ( )
inlineprotected

Set length.

Definition at line 134 of file JDAQPreamble.hh.

135  {
136  length = getSize();
137  }
virtual int getSize() const
Get size of object.
int KM3NETDAQ::JDAQAbstractPreamble::getLength ( ) const
inlineinherited

Get length.

Returns
number of bytes

Definition at line 48 of file JDAQAbstractPreamble.hh.

49  {
50  return length;
51  }
int KM3NETDAQ::JDAQAbstractPreamble::getDataType ( ) const
inlineinherited

Get data type.

Returns
data type

Definition at line 59 of file JDAQAbstractPreamble.hh.

60  {
61  return type;
62  }
KM3NETDAQ::JDAQAbstractPreamble::ClassDefNV ( JDAQAbstractPreamble  ,
 
)
inherited

Friends And Related Function Documentation

JReader& operator>> ( JReader in,
JDAQPreamble preamble 
)
friend

Read DAQ preamble from input.

Parameters
inJReader
preambleJDAQPreamble
Returns
JReader

Definition at line 80 of file JDAQPreamble.hh.

81  {
82  in >> preamble.length;
83  in >> preamble.type;
84 
85  return in;
86  }
JWriter& operator<< ( JWriter out,
const JDAQPreamble preamble 
)
friend

Write DAQ preamble to output.

Parameters
outJWriter
preambleJDAQPreamble
Returns
JWriter

Definition at line 96 of file JDAQPreamble.hh.

97  {
98  out << preamble.getSize();
99  out << preamble.type;
100 
101  return out;
102  }

Member Data Documentation

int KM3NETDAQ::JDAQAbstractPreamble::length
protectedinherited

Definition at line 79 of file JDAQAbstractPreamble.hh.

int KM3NETDAQ::JDAQAbstractPreamble::type
protectedinherited

Definition at line 80 of file JDAQAbstractPreamble.hh.


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