KM3NETDAQ::JDAQPreamble Class Reference

DAQ preamble. More...

#include <JDAQPreamble.hh>

Inheritance diagram for KM3NETDAQ::JDAQPreamble:

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
JReader &	operator>> (JReader &in, JDAQPreamble &preamble)
	Read DAQ preamble from input. More...
JWriter &	operator<< (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

JDAQPreamble() [1/2]

template<class T >

KM3NETDAQ::JDAQPreamble::JDAQPreamble ( JDAQType< T >  type )

inlineprotected

Constructor.

Parameters

type	data type of derived class

Definition at line 51 of file JDAQPreamble.hh.

                                   :
      JDAQAbstractPreamble(type)
    {}

JDAQPreamble() [2/2]

KM3NETDAQ::JDAQPreamble::JDAQPreamble ( )

inline

Default constructor.

Definition at line 60 of file JDAQPreamble.hh.

                   :
      JDAQAbstractPreamble()
    
    {}

~JDAQPreamble()

virtual KM3NETDAQ::JDAQPreamble::~JDAQPreamble ( )

inlinevirtual

Virtual destructor.

Definition at line 69 of file JDAQPreamble.hh.

    {}

Member Function Documentation

sizeOf()

static int KM3NETDAQ::JDAQPreamble::sizeOf ( )

inlinestatic

Get size of object.

Returns

number of bytes

Definition at line 110 of file JDAQPreamble.hh.

    {
      return JDAQAbstractPreamble::sizeOf();
    }

getSize()

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.

    { 
      return JDAQPreamble::sizeOf(); 
    }

ClassDef()

KM3NETDAQ::JDAQPreamble::ClassDef	(	JDAQPreamble	,
		1
	)

setLength()

void KM3NETDAQ::JDAQPreamble::setLength ( )

inlineprotected

Set length.

Definition at line 134 of file JDAQPreamble.hh.

    { 
      length = getSize();
    }

getLength()

int KM3NETDAQ::JDAQAbstractPreamble::getLength ( ) const

inlineinherited

Get length.

Returns

number of bytes

Definition at line 48 of file JDAQAbstractPreamble.hh.

    { 
      return length;
    }

getDataType()

int KM3NETDAQ::JDAQAbstractPreamble::getDataType ( ) const

inlineinherited

Get data type.

Returns

data type

Definition at line 59 of file JDAQAbstractPreamble.hh.

    { 
      return type; 
    }

ClassDefNV()

KM3NETDAQ::JDAQAbstractPreamble::ClassDefNV ( JDAQAbstractPreamble  , 1    )

inherited

Friends And Related Function Documentation

operator>>

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

friend

Read DAQ preamble from input.

Parameters

in	JReader
preamble	JDAQPreamble

Returns

JReader

Definition at line 80 of file JDAQPreamble.hh.

    {
      in >> preamble.length;
      in >> preamble.type;
 
      return in;
    }

operator<<

JWriter& operator<< ( JWriter &  out, const JDAQPreamble &  preamble  )

friend

Write DAQ preamble to output.

Parameters

out	JWriter
preamble	JDAQPreamble

Returns

JWriter

Definition at line 96 of file JDAQPreamble.hh.

    {
      out << preamble.getSize();
      out << preamble.type;
 
      return out;
    }

Member Data Documentation

length

int KM3NETDAQ::JDAQAbstractPreamble::length

protectedinherited

Definition at line 79 of file JDAQAbstractPreamble.hh.

type

int KM3NETDAQ::JDAQAbstractPreamble::type

protectedinherited

Definition at line 80 of file JDAQAbstractPreamble.hh.

---

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

• JDAQPreamble.hh