Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

eformat::old::Header Class Reference

#include <Header.h>

Inheritance diagram for eformat::old::Header:

eformat::old::FullEventFragment eformat::old::FullEventFragment eformat::old::ROBFragment eformat::old::ROBFragment eformat::old::ROSFragment eformat::old::ROSFragment eformat::old::SubDetectorFragment eformat::old::SubDetectorFragment List of all members.

Public Member Functions

virtual bool check () const
virtual bool check () const
const uint32_t * child (size_t n) const
const uint32_t * child (size_t n) const
uint32_t fragment_size_word () const
uint32_t fragment_size_word () const
 Header (const uint32_t *it, uint32_t match)
 Header (const uint32_t *it, uint32_t match)
uint32_t header_size_word () const
uint32_t header_size_word () const
uint32_t marker () const
uint32_t marker () const
uint32_t noffset () const
uint32_t noffset () const
uint32_t nspecific () const
uint32_t nspecific () const
uint32_t nstatus () const
uint32_t nstatus () const
const uint32_t * offset (void) const
const uint32_t * offset (void) const
uint32_t run_no () const
uint32_t run_no () const
uint32_t source_id () const
uint32_t source_id () const
const uint32_t * specific_header (void) const
const uint32_t * specific_header (void) const
const uint32_t * status () const
const uint32_t * status () const
uint32_t version () const
uint32_t version () const
virtual ~Header ()
virtual ~Header ()

Private Attributes

const uint32_t * m_start
 my start word
const uint32_t * m_start
 my start word

Detailed Description

Contains the information on the Header of a fragment as described by the original note. The header is a composite entity, build from two parts:

  1. The generic part, containing the header type, size and version information;
  2. The specific part, containing data that is specific for a particular fragment.


Constructor & Destructor Documentation

eformat::old::Header::Header const uint32_t *  it,
uint32_t  match
 

To build a header given the containing buffer. I need to know where the header starts in order to do that.

Parameters:
it The exact position where this header should start.
match The word that this header should match.
00022   : m_start(it)
00023 {
00024   //get endiannesso
00025   uint32_t m = marker();
00026   if (m != match) throw EFORMAT_WRONG_MARKER(m, match);
00027 }

virtual eformat::old::Header::~Header  )  [inline, virtual]
 

Destructor virtualisation

00056 {}

eformat::old::Header::Header const uint32_t *  it,
uint32_t  match
 

To build a header given the containing buffer. I need to know where the header starts in order to do that.

Parameters:
it The exact position where this header should start.
match The word that this header should match.

virtual eformat::old::Header::~Header  )  [inline, virtual]
 

Destructor virtualisation

00056 {}


Member Function Documentation

virtual bool eformat::old::Header::check  )  const [virtual]
 

Says if the generic part of the header is valid. This may throw exceptions.

Reimplemented in eformat::old::FullEventFragment, eformat::old::ROBFragment, eformat::old::ROSFragment, eformat::old::SubDetectorFragment, eformat::old::FullEventFragment, eformat::old::ROBFragment, eformat::old::ROSFragment, and eformat::old::SubDetectorFragment.

bool eformat::old::Header::check  )  const [virtual]
 

Says if the generic part of the header is valid. This may throw exceptions.

Reimplemented in eformat::old::FullEventFragment, eformat::old::ROBFragment, eformat::old::ROSFragment, eformat::old::SubDetectorFragment, eformat::old::FullEventFragment, eformat::old::ROBFragment, eformat::old::ROSFragment, and eformat::old::SubDetectorFragment.

00030 {
00031   if ( version() >> 16 != eformat::MAJOR_OLD_VERSION )
00032     throw EFORMAT_BAD_VERSION(version() >> 16, eformat::MAJOR_OLD_VERSION);
00033   if ( header_size_word() != (9 + nstatus() + noffset() + nspecific()) )
00034     throw EFORMAT_SIZE_CHECK(header_size_word(),
00035                              (9 + nstatus() + noffset() + nspecific()));
00036   return true;
00037 }

const uint32_t* eformat::old::Header::child size_t  n  )  const
 

Returns the nth child fragment. If the nth fragment doesn't exist, an exception is thrown.

Parameters:
n The fragment position, starting at zero, of the child fragment you would like to get.

const uint32_t * eformat::old::Header::child size_t  n  )  const
 

Returns the nth child fragment. If the nth fragment doesn't exist, an exception is thrown.

Parameters:
n The fragment position, starting at zero, of the child fragment you would like to get.
00040 {
00041   if (n >= noffset()) throw EFORMAT_NO_SUCH_CHILD(n, noffset());
00042   return &m_start[0xffffff & offset()[n]];
00043 }

uint32_t eformat::old::Header::fragment_size_word  )  const [inline]
 

Returns the size, in words, of the current fragment.

00072 { return m_start[1]; }

uint32_t eformat::old::Header::fragment_size_word  )  const [inline]
 

Returns the size, in words, of the current fragment.

00072 { return m_start[1]; }

uint32_t eformat::old::Header::header_size_word  )  const [inline]
 

Returns the size, in words, of the current header. That does include the specific part of the header.

00078 { return m_start[2]; }

uint32_t eformat::old::Header::header_size_word  )  const [inline]
 

Returns the size, in words, of the current header. That does include the specific part of the header.

00078 { return m_start[2]; }

uint32_t eformat::old::Header::marker  )  const [inline]
 

Returns the fragment type.

00067 { return m_start[0]; }

uint32_t eformat::old::Header::marker  )  const [inline]
 

Returns the fragment type.

00067 { return m_start[0]; }

uint32_t eformat::old::Header::noffset  )  const [inline]
 

Returns the number of offset words available. This will also determine the number of child fragments available to this super-fragment.

00110 { return m_start[7 + nstatus()]; }

uint32_t eformat::old::Header::noffset  )  const [inline]
 

Returns the number of offset words available. This will also determine the number of child fragments available to this super-fragment.

00110 { return m_start[7 + nstatus()]; }

uint32_t eformat::old::Header::nspecific  )  const [inline]
 

Returns the number of specific words available in the specific header part

00124       { return m_start[8 + nstatus() + noffset()]; }

uint32_t eformat::old::Header::nspecific  )  const [inline]
 

Returns the number of specific words available in the specific header part

00124       { return m_start[8 + nstatus() + noffset()]; }

uint32_t eformat::old::Header::nstatus void   )  const [inline]
 

Returns the number of status words available

00098 { return m_start[6]; }

uint32_t eformat::old::Header::nstatus  )  const [inline]
 

Returns the number of status words available

00098 { return m_start[6]; }

const uint32_t* eformat::old::Header::offset void   )  const [inline]
 

Returns the offset words, as an iterator to the offset words available.

00117       { return &m_start[8 + nstatus()]; }

const uint32_t* eformat::old::Header::offset void   )  const [inline]
 

Returns the offset words, as an iterator to the offset words available.

00117       { return &m_start[8 + nstatus()]; }

uint32_t eformat::old::Header::run_no  )  const [inline]
 

Returns the current run number.

00093 { return m_start[5]; }

uint32_t eformat::old::Header::run_no  )  const [inline]
 

Returns the current run number.

00093 { return m_start[5]; }

uint32_t eformat::old::Header::source_id void   )  const [inline]
 

Returns the full source identifier.

00088 { return m_start[4]; }

uint32_t eformat::old::Header::source_id  )  const [inline]
 

Returns the full source identifier.

00088 { return m_start[4]; }

const uint32_t* eformat::old::Header::specific_header void   )  const [inline]
 

Returns an iterator to the start of the specific header part (this includes the number of specific header fragments)

00131       { return &m_start[9 + nstatus() + noffset()]; }

const uint32_t* eformat::old::Header::specific_header void   )  const [inline]
 

Returns an iterator to the start of the specific header part (this includes the number of specific header fragments)

00131       { return &m_start[9 + nstatus() + noffset()]; }

const uint32_t* eformat::old::Header::status void   )  const [inline]
 

Returns the status words, as an iterator to the status words available.

00104 { return &m_start[7]; }

const uint32_t* eformat::old::Header::status  )  const [inline]
 

Returns the status words, as an iterator to the status words available.

00104 { return &m_start[7]; }

uint32_t eformat::old::Header::version  )  const [inline]
 

Returns the formatting version.

00083 { return m_start[3]; }

uint32_t eformat::old::Header::version  )  const [inline]
 

Returns the formatting version.

00083 { return m_start[3]; }


Member Data Documentation

const uint32_t* eformat::old::Header::m_start [private]
 

my start word

Reimplemented in eformat::old::FullEventFragment, eformat::old::ROBFragment, eformat::old::ROSFragment, eformat::old::SubDetectorFragment, eformat::old::FullEventFragment, eformat::old::ROBFragment, eformat::old::ROSFragment, and eformat::old::SubDetectorFragment.

const uint32_t* eformat::old::Header::m_start [private]
 

my start word

Reimplemented in eformat::old::FullEventFragment, eformat::old::ROBFragment, eformat::old::ROSFragment, eformat::old::SubDetectorFragment, eformat::old::FullEventFragment, eformat::old::ROBFragment, eformat::old::ROSFragment, and eformat::old::SubDetectorFragment.


The documentation for this class was generated from the following files:
Generated on Wed Feb 2 19:18:50 2011 for BOSS6.5.5 by  doxygen 1.3.9.1