eformat::Header< TPointer > Class Template Reference

#include <Header.h>

Inheritance diagram for eformat::Header< TPointer >:

Public Member Functions
	Header (const TPointer &it, uint32_t match)
	Header ()
	Header (const Header &other)
virtual	~Header ()
Header &	operator= (const Header &other)
Header &	assign (const TPointer &it, uint32_t match)
virtual bool	check () const
uint32_t	marker () const
uint32_t	fragment_size_word () const
uint32_t	header_size_word () const
uint32_t	version () const
uint32_t	source_id () const
uint32_t	nstatus () const
void	start (TPointer &it) const
void	payload (TPointer &it) const
void	end (TPointer &it) const
uint32_t	payload_size_word (void) const
void	status (TPointer &it) const
uint32_t	nspecific () const
void	specific_header (TPointer &it) const
virtual uint32_t	nchildren () const
virtual void	child (TPointer &p, size_t n) const
virtual void	child_check (TPointer &p, size_t n) const
virtual uint32_t	children (TPointer *p, size_t max) const

Detailed Description

template<class TPointer>
class eformat::Header< TPointer >

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.

Definition at line 40 of file Header.h.

Constructor & Destructor Documentation

Header() [1/3]

template<class TPointer>

eformat::Header< TPointer >::Header	(	const TPointer &	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.

Definition at line 224 of file Header.h.

  : m_start(it)
{
  ERS_DEBUG_3("Building header 0x%x from iterator", match);
  if (marker() != match) {
    throw EFORMAT_WRONG_MARKER(marker(), match);
  }
  ERS_DEBUG_1("Initialized header with source identifier = %s",
          eformat::helper::SourceIdentifier(match).human().c_str());
}

Referenced by eformat::FullEventFragment< TPointer >::FullEventFragment(), eformat::FullEventFragment< const uint32_t * >::FullEventFragment(), eformat::FullEventFragment< const uint32_t * >::FullEventFragment(), Header(), operator=(), eformat::ROBFragment< TPointer >::ROBFragment(), eformat::ROBFragment< TPointer >::ROBFragment(), eformat::ROBFragment< TPointer >::ROBFragment(), eformat::ROSFragment< TPointer >::ROSFragment(), eformat::ROSFragment< TPointer >::ROSFragment(), eformat::ROSFragment< TPointer >::ROSFragment(), eformat::SubDetectorFragment< TPointer >::SubDetectorFragment(), eformat::SubDetectorFragment< const uint32_t * >::SubDetectorFragment(), and eformat::SubDetectorFragment< const uint32_t * >::SubDetectorFragment().

Header() [2/3]

template<class TPointer>

eformat::Header< TPointer >::Header ( )

inline

Builds an empty, otherwise useless Header

Definition at line 56 of file Header.h.

: m_start() {}

Header() [3/3]

template<class TPointer>

eformat::Header< TPointer >::Header ( const Header< TPointer > & other )

inline

Copy constructor

Parameters

other

The other header to construct from

Definition at line 63 of file Header.h.

: m_start(other.m_start) {}

~Header()

template<class TPointer>

virtual eformat::Header< TPointer >::~Header ( )

inlinevirtual

Destructor virtualisation

Definition at line 68 of file Header.h.

{}

Member Function Documentation

assign()

template<class TPointer>

eformat::Header< TPointer > & eformat::Header< TPointer >::assign	(	const TPointer &	it,
		uint32_t	match )

Reassign this header

Parameters

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

Definition at line 236 of file Header.h.

{
  ERS_DEBUG_3("Rebuilding header 0x%x from iterator", match);
  m_start = it;
  if (marker() != match) {
    throw EFORMAT_WRONG_MARKER(marker(), match);
  }
  ERS_DEBUG_1("Re-initialized header with source identifier = %s",
          eformat::helper::SourceIdentifier(match).human().c_str());
  return *this;
}

Referenced by eformat::FullEventFragment< TPointer >::assign(), eformat::ROBFragment< TPointer >::assign(), eformat::ROSFragment< TPointer >::assign(), and eformat::SubDetectorFragment< TPointer >::assign().

check()

template<class TPointer>

bool eformat::Header< TPointer >::check ( ) const

virtual

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

Reimplemented in eformat::FullEventFragment< TPointer >, eformat::FullEventFragment< const uint32_t * >, eformat::FullEventFragment< const uint32_t * >, eformat::ROBFragment< TPointer >, eformat::ROSFragment< TPointer >, eformat::SubDetectorFragment< TPointer >, eformat::SubDetectorFragment< const uint32_t * >, and eformat::SubDetectorFragment< const uint32_t * >.

Definition at line 249 of file Header.h.

{
  ERS_DEBUG_2("Checking for consistency of fragment of type %s [%s]",
          eformat::marker2string(marker()).c_str(),
          eformat::helper::SourceIdentifier(source_id()).human().c_str());
  if ( version() >> 16 != eformat::MAJOR_DEFAULT_VERSION )
    throw EFORMAT_BAD_VERSION(version() >> 16, eformat::MAJOR_DEFAULT_VERSION);
  if ( header_size_word() != (7 + nstatus() + nspecific()) )
    throw EFORMAT_SIZE_CHECK(header_size_word(),
                 (7 + nstatus() + nspecific()));
  return true;
}

Referenced by eformat::FullEventFragment< TPointer >::check(), eformat::ROBFragment< TPointer >::check(), eformat::ROSFragment< TPointer >::check(), and eformat::SubDetectorFragment< TPointer >::check().

child()

template<class TPointer>

void eformat::Header< TPointer >::child ( TPointer & p, size_t n ) const

virtual

Returns the nth child fragment. If the nth fragment doesn't exist, the behaviour is undefined.

Parameters

p	A preallocated pointer you should provide.
n	The fragment position, starting at zero, of the child fragment you would like to get.

Definition at line 272 of file Header.h.

{
  ERS_DEBUG_2("User asked for child %ud of fragment type %s [%s]", n,
          eformat::marker2string(marker()).c_str(),
          eformat::helper::SourceIdentifier(source_id()).human().c_str());
  TPointer next;
  payload(next);
  for (size_t i=0; i<n; ++i) next += next[1];
  ERS_DEBUG_3("Set user object");
  p = next;
}

Referenced by eformat::FullEventFragment< TPointer >::check_tree(), eformat::ROSFragment< TPointer >::check_tree(), eformat::SubDetectorFragment< TPointer >::check_tree(), and child_check().

child_check()

template<class TPointer>

void eformat::Header< TPointer >::child_check ( TPointer & p, size_t n ) const

virtual

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

Warning

Use this method with care, it is slower than the equivalent method that doesn't check.

Parameters

p	A preallocated pointer you should provide.
n	The fragment position, starting at zero, of the child fragment you would like to get.

Definition at line 285 of file Header.h.

{
  uint32_t total = nchildren();
  if (n >= total) throw EFORMAT_NO_SUCH_CHILD(n, total);
  child(p, n);
}

children()

template<class TPointer>

uint32_t eformat::Header< TPointer >::children ( TPointer * p, size_t max ) const

virtual

Returns all the children of this fragment. The input to this method is a valid set of iterators to existing, pre-allocated pointers

Parameters

p	A pointer to a set of preallocated TPointer's to set to the position of the children of this fragment.
max	The maximum number of children, p can point to.

Returns

The number of children found on this fragment

Definition at line 293 of file Header.h.

{
  ERS_DEBUG_2("Retrieving all children...");
  TPointer payload_start;
  payload(payload_start);
  try {
    return find_fragments(child_marker(static_cast<HeaderMarker>(marker())),
              payload_start, payload_size_word(), p, max);
  }
  catch (WrongMarkerIssue& ex) {
    //This normally means the fragment size is wrong...
    throw EFORMAT_WRONG_SIZE(fragment_size_word());
  }
  return 0;
}

Referenced by components(), eformat::get_robs(), main(), and nchildren().

end()

template<class TPointer>

void eformat::Header< TPointer >::end ( TPointer & it ) const

inline

Sets the pointer to one-past my end position

Parameters

it	The pointer to set

Definition at line 143 of file Header.h.

    { it = m_start; it += fragment_size_word(); }

fragment_size_word()

template<class TPointer>

uint32_t eformat::Header< TPointer >::fragment_size_word ( ) const

inline

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

Definition at line 100 of file Header.h.

{ return m_start[1]; }

Referenced by children(), end(), EFEventLoopMgr::executeEvent(), and payload_size_word().

header_size_word()

template<class TPointer>

uint32_t eformat::Header< TPointer >::header_size_word ( ) const

inline

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

Definition at line 106 of file Header.h.

{ return m_start[2]; }

Referenced by check(), payload(), and payload_size_word().

marker()

template<class TPointer>

uint32_t eformat::Header< TPointer >::marker ( ) const

inline

Returns the fragment type.

Definition at line 95 of file Header.h.

{ return m_start[0]; }

Referenced by assign(), check(), child(), children(), Header(), and nchildren().

nchildren()

template<class TPointer>

uint32_t eformat::Header< TPointer >::nchildren ( ) const

virtual

Returns the number of children available.

Definition at line 263 of file Header.h.

{
  ERS_DEBUG_2("User asked for number of children of fragment type %s [%s]",
          eformat::marker2string(marker()).c_str(),
          eformat::helper::SourceIdentifier(source_id()).human().c_str());
  return children(0,0);
}

Referenced by eformat::FullEventFragment< TPointer >::check_tree(), eformat::ROSFragment< TPointer >::check_tree(), eformat::SubDetectorFragment< TPointer >::check_tree(), child_check(), components(), and EFEventLoopMgr::executeEvent().

nspecific()

template<class TPointer>

uint32_t eformat::Header< TPointer >::nspecific ( ) const

inline

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

Definition at line 164 of file Header.h.

{ return m_start[6 + nstatus()]; }

Referenced by eformat::FullEventFragment< TPointer >::check(), check(), eformat::ROBFragment< TPointer >::check(), eformat::ROSFragment< TPointer >::check(), eformat::SubDetectorFragment< TPointer >::check(), and RawDataInputSvc::nextEvent().

nstatus()

template<class TPointer>

uint32_t eformat::Header< TPointer >::nstatus ( ) const

inline

Returns the number of status words available

Definition at line 121 of file Header.h.

{ return m_start[5]; }

Referenced by check(), nspecific(), and specific_header().

operator=()

template<class TPointer>

Header & eformat::Header< TPointer >::operator= ( const Header< TPointer > & other )

inline

Assigment operator

Parameters

other

The other header to assign from

Definition at line 75 of file Header.h.

    { m_start = other.m_start; return *this; }

Referenced by eformat::FullEventFragment< const uint32_t * >::operator=(), eformat::ROBFragment< TPointer >::operator=(), eformat::ROSFragment< TPointer >::operator=(), and eformat::SubDetectorFragment< const uint32_t * >::operator=().

payload()

template<class TPointer>

void eformat::Header< TPointer >::payload ( TPointer & it ) const

inline

Sets the pointer to where the payload starts

Parameters

it	The pointer to set

Definition at line 135 of file Header.h.

    { it = m_start; it+= header_size_word(); }

Referenced by child(), and children().

payload_size_word()

template<class TPointer>

uint32_t eformat::Header< TPointer >::payload_size_word ( void ) const

inline

Returns the payload size

Definition at line 149 of file Header.h.

    { return fragment_size_word() - header_size_word(); }

Referenced by children(), eformat::ROBFragment< TPointer >::rod_fragment_size_word(), eformat::ROBFragment< TPointer >::rod_ndata(), eformat::ROBFragment< TPointer >::rod_nstatus(), and eformat::ROBFragment< TPointer >::rod_status_position().

source_id()

template<class TPointer>

uint32_t eformat::Header< TPointer >::source_id ( ) const

inline

Returns the full source identifier.

Definition at line 116 of file Header.h.

{ return m_start[4]; }

Referenced by eformat::FullEventFragment< TPointer >::assign(), eformat::ROBFragment< TPointer >::assign(), eformat::ROSFragment< TPointer >::assign(), eformat::SubDetectorFragment< TPointer >::assign(), check(), eformat::ROBFragment< TPointer >::check(), child(), eformat::get_robs(), nchildren(), RawDataInputSvc::nextEvent(), and eformat::ROBFragment< TPointer >::ROBFragment().

specific_header()

template<class TPointer>

void eformat::Header< TPointer >::specific_header ( TPointer & it ) const

inline

Returns an iterator to the start of the specific header part (this does not include the number of specific header fragments)

Parameters

it	An updateable iterator you should provide.

Definition at line 172 of file Header.h.

    { it = m_start; it += 7 + nstatus(); }

Referenced by eformat::FullEventFragment< TPointer >::assign(), eformat::ROSFragment< TPointer >::assign(), eformat::SubDetectorFragment< TPointer >::assign(), eformat::FullEventFragment< TPointer >::FullEventFragment(), RawDataInputSvc::nextEvent(), eformat::ROBFragment< TPointer >::ROBFragment(), eformat::ROSFragment< TPointer >::ROSFragment(), and eformat::SubDetectorFragment< TPointer >::SubDetectorFragment().

start()

template<class TPointer>

void eformat::Header< TPointer >::start ( TPointer & it ) const

inline

Sets the pointer to my start

Parameters

it	The pointer to set

Definition at line 128 of file Header.h.

{ it = m_start; }

status()

template<class TPointer>

void eformat::Header< TPointer >::status ( TPointer & it ) const

inline

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

Parameters

it	An updateable iterator you should provide.

Definition at line 157 of file Header.h.

{ it = m_start; it += 6; }

version()

template<class TPointer>

uint32_t eformat::Header< TPointer >::version ( ) const

inline

Returns the formatting version.

Definition at line 111 of file Header.h.

{ return m_start[3]; }

Referenced by check().

---

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

• Header.h