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...
	ClassDef (JDAQPreamble, 1)
int	getLength () const
	Get length. More...
int	getDataType () const
	Get data type. More...
	ClassDefNV (JDAQAbstractPreamble, 1)

Static Public Member Functions
template<class T >
static JDAQPreamble	getDAQPreamble (const T &object)
	Get DAQ preamble. More...

Protected Member Functions
template<class T >
	JDAQPreamble (const JDAQType< T > &type)
	Constructor. More...

Protected Attributes
int	length
int	type

Friends
size_t	getSizeof ()
	Definition of method to get size of data type. More...
JReader &	operator>> (JReader &, JDAQPreamble &)
	Read DAQ preamble from input. More...
JWriter &	operator<< (JWriter &, const JDAQPreamble &)
	Write DAQ preamble to output. More...
std::ostream &	operator<< (std::ostream &out, const JDAQPreamble &preamble)
	Print DAQ preamble. More...

Detailed Description

DAQ preamble.

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 this object can be used for RTTI.

Definition at line 26 of file JDAQPreamble.hh.

Constructor & Destructor Documentation

template<class T >

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

inlineprotected

Constructor.

Parameters

type	data type of derived class

Definition at line 38 of file JDAQPreamble.hh.

                                          :
      JDAQAbstractPreamble(type)
    {}

KM3NETDAQ::JDAQPreamble::JDAQPreamble ( )

inline

Default constructor.

Definition at line 51 of file JDAQPreamble.hh.

                   :
      JDAQAbstractPreamble()
    {}

virtual KM3NETDAQ::JDAQPreamble::~JDAQPreamble ( )

inlinevirtual

Virtual destructor.

Definition at line 59 of file JDAQPreamble.hh.

    {}

Member Function Documentation

template<class T >

static JDAQPreamble KM3NETDAQ::JDAQPreamble::getDAQPreamble ( const T &  object )

inlinestatic

Get DAQ preamble.

This method should be used for binary I/O to get the actual data for the given object.
To this end, the following method should be overloaded for the corresponding data type.

   size_t  getSizeof(const T&);

Parameters

object

object

Returns

preamble

Definition at line 76 of file JDAQPreamble.hh.

    {
      static JDAQPreamble preamble;

      preamble.length = getSizeof(object);
      preamble.type   = KM3NETDAQ::getDataType<T>();

      return preamble;
    }

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

int KM3NETDAQ::JDAQAbstractPreamble::getLength ( ) const

inlineinherited

Get length.

Returns

number of bytes

Definition at line 49 of file JDAQAbstractPreamble.hh.

    { 
      return length;
    }

int KM3NETDAQ::JDAQAbstractPreamble::getDataType ( ) const

inlineinherited

Get data type.

Returns

data type

Definition at line 60 of file JDAQAbstractPreamble.hh.

    { 
      return type; 
    }

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

inherited

Friends And Related Function Documentation

size_t getSizeof ( )

friend

Definition of method to get size of data type.

This method should be specialised for each desired data type with fixed length.

Returns

number of bytes

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

friend

Read DAQ preamble from input.

Note that JDAQAbstractPreamble::length is read first.

Parameters

in	reader
preamble	DAQ preamble

Returns

reader

Definition at line 35 of file JDAQPreambleIO.hh.

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

    return in;
  }

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

friend

Write DAQ preamble to output.

Note that JDAQPreamble::getSize() is written first.

Parameters

out	writer
preamble	DAQ preamble

Returns

writer

Definition at line 53 of file JDAQPreambleIO.hh.

  {
    out << preamble.length;
    out << preamble.type;

    return out;
  }

std::ostream& operator<< ( std::ostream &  out, const JDAQPreamble &  preamble  )

friend

Print DAQ preamble.

Parameters

out	output stream
preamble	JDAQPreamble

Returns

output stream

Definition at line 94 of file JDAQPreamble.hh.

    {
      using namespace std;

      out << setw(8) << preamble.length;
      out << ' ';
      out << setw(6) << preamble.type;

      return out;
    }

Member Data Documentation

int KM3NETDAQ::JDAQAbstractPreamble::length

protectedinherited

Definition at line 69 of file JDAQAbstractPreamble.hh.

int KM3NETDAQ::JDAQAbstractPreamble::type

protectedinherited

Definition at line 70 of file JDAQAbstractPreamble.hh.

---

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

• JDAQPreamble.hh