eformat::ROSFragment< TPointer > Class Template Reference

#include <ROSFragment.h>

Inheritance diagram for eformat::ROSFragment< TPointer >:

List of all members.

Public Member Functions
	ROSFragment (const TPointer &it)
	ROSFragment ()
	ROSFragment (const ROSFragment &other)
virtual	~ROSFragment ()
ROSFragment &	operator= (const ROSFragment &other)
ROSFragment &	assign (const TPointer &it)
virtual bool	check () const
bool	check_tree () const
uint32_t	run_no () const
uint32_t	lvl1_id () const
uint32_t	bc_id () const
Header &	assign (const TPointer &it, uint32_t match)
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
Private Attributes
TPointer	m_start
	my start word
Static Private Attributes
static const uint32_t	NSPECIFIC = 3

---

Detailed Description

template<class TPointer>
class eformat::ROSFragment< TPointer >

Describes how to access the contents of a subdetector fragment, as prescribed by the event format note.

Definition at line 28 of file ROSFragment.h.

---

Constructor & Destructor Documentation

template<class TPointer>

eformat::ROSFragment< TPointer >::ROSFragment

(

const TPointer &

it

)

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

Parameters:

it

The exact position where this fragment should start.

Definition at line 114 of file ROSFragment.h.

References eformat::ROSFragment< TPointer >::m_start, and eformat::Header< TPointer >::specific_header().

  : eformat::Header<TPointer>(it, eformat::ROS),
    m_start()
{
  specific_header(m_start);
}

template<class TPointer>

eformat::ROSFragment< TPointer >::ROSFragment

(

)

[inline]

Builds an empty, otherwise useless ROSFragment

Definition at line 43 of file ROSFragment.h.

: Header<TPointer>(), m_start() {}

template<class TPointer>

eformat::ROSFragment< TPointer >::ROSFragment

(

const ROSFragment< TPointer > &

other

)

[inline]

Copy constructor

Parameters:

other

The fragment to be copied

Definition at line 50 of file ROSFragment.h.

      : Header<TPointer>(other), m_start(other.m_start) {}

template<class TPointer>

virtual eformat::ROSFragment< TPointer >::~ROSFragment

(

)

[inline, virtual]

Destructor virtualisation

Definition at line 56 of file ROSFragment.h.

{}

---

Member Function Documentation

template<class TPointer>

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

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.

References EvtCyclic3::c_str(), EFORMAT_WRONG_MARKER, ERS_DEBUG_1, ERS_DEBUG_3, eformat::Header< TPointer >::m_start, and eformat::Header< TPointer >::marker().

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

{
  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;
}

template<class TPointer>

eformat::ROSFragment< TPointer > & eformat::ROSFragment< TPointer >::assign

(

const TPointer &

it

)

Manual re-assignment

Parameters:

it

The position pointing the first word of this fragment

Definition at line 122 of file ROSFragment.h.

References eformat::Header< TPointer >::assign(), EvtCyclic3::c_str(), ERS_DEBUG_1, ERS_DEBUG_3, eformat::ROSFragment< TPointer >::m_start, eformat::ROS, eformat::Header< TPointer >::source_id(), and eformat::Header< TPointer >::specific_header().

{
  ERS_DEBUG_3("Re-building ROSFragment from pointer");
  eformat::Header<TPointer>::assign(it, eformat::ROS);
  specific_header(m_start);
  ERS_DEBUG_1("Initialized header with source identifier = %s",
              eformat::helper::SourceIdentifier(source_id()).human().c_str());
  return *this;
}

template<class TPointer>

uint32_t eformat::ROSFragment< TPointer >::bc_id

(

)

const [inline]

Returns the bunch crossing identifier

Definition at line 96 of file ROSFragment.h.

References eformat::ROSFragment< TPointer >::m_start.

{ return m_start[2]; }

template<class TPointer>

bool eformat::ROSFragment< TPointer >::check

(

)

const [virtual]

Says if the the fragment is valid. This may throw exceptions.

Reimplemented from eformat::Header< TPointer >.

Definition at line 133 of file ROSFragment.h.

References eformat::Header< TPointer >::check(), EFORMAT_SIZE_CHECK, ERS_DEBUG_2, and eformat::ROSFragment< TPointer >::NSPECIFIC.

Referenced by eformat::ROSFragment< TPointer >::check_tree().

{
  ERS_DEBUG_2("Checking for consistency of ROSFragment");
  eformat::Header<TPointer>::check(); //< first do a generic check
  if (eformat::Header<TPointer>::nspecific() != NSPECIFIC)
    throw EFORMAT_SIZE_CHECK(NSPECIFIC, this->nspecific());
  return true;
}

template<class TPointer>

bool eformat::ROSFragment< TPointer >::check_tree

(

)

const

Says if the the fragment is valid. This may throw exceptions.

Definition at line 143 of file ROSFragment.h.

References eformat::ROSFragment< TPointer >::check(), eformat::ROBFragment< TPointer >::check_tree(), eformat::Header< TPointer >::child(), ERS_DEBUG_2, genRecEmupikp::i, eformat::Header< TPointer >::nchildren(), and showlog::total.

Referenced by eformat::SubDetectorFragment< TPointer >::check_tree().

{
  ERS_DEBUG_2("Checking recursively for consistency of ROSFragment");
  check(); // check myself
  uint32_t total = this->nchildren();
  for (size_t i=0; i<total; ++i) {
    TPointer fp;
    child(fp, i);
    eformat::ROBFragment<TPointer> f(fp);
    f.check_tree();
  }
  return true;
}

template<class TPointer>

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

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.

References EvtCyclic3::c_str(), ERS_DEBUG_2, ERS_DEBUG_3, genRecEmupikp::i, eformat::Header< TPointer >::marker(), eformat::marker2string(), next, eformat::Header< TPointer >::payload(), and eformat::Header< TPointer >::source_id().

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

{
  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;
}

template<class TPointer>

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

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.

References eformat::Header< TPointer >::child(), EFORMAT_NO_SUCH_CHILD, eformat::Header< TPointer >::nchildren(), and showlog::total.

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

template<class TPointer>

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

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.

References eformat::child_marker(), EFORMAT_WRONG_SIZE, ERS_DEBUG_2, eformat::find_fragments(), eformat::Header< TPointer >::fragment_size_word(), eformat::Header< TPointer >::marker(), eformat::Header< TPointer >::payload(), and eformat::Header< TPointer >::payload_size_word().

Referenced by components(), eformat::get_robs(), eformat::Header< TPointer >::nchildren(), and RawDataInputSvc::nextEvent().

{
  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;
}

template<class TPointer>

void eformat::Header< TPointer >::end

(

TPointer &

it

)

const [inline, inherited]

Sets the pointer to one-past my end position

Parameters:

it

The pointer to set

Definition at line 143 of file Header.h.

References eformat::Header< TPointer >::fragment_size_word(), and eformat::Header< TPointer >::m_start.

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

template<class TPointer>

uint32_t eformat::Header< TPointer >::fragment_size_word

(

)

const [inline, inherited]

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

Definition at line 100 of file Header.h.

References eformat::Header< TPointer >::m_start.

Referenced by eformat::Header< TPointer >::children(), eformat::Header< TPointer >::end(), EFEventLoopMgr::executeEvent(), MixerAlg::nextEvent(), and eformat::Header< TPointer >::payload_size_word().

{ return m_start[1]; }

template<class TPointer>

uint32_t eformat::Header< TPointer >::header_size_word

(

)

const [inline, inherited]

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.

References eformat::Header< TPointer >::m_start.

Referenced by eformat::Header< TPointer >::check(), eformat::Header< TPointer >::payload(), and eformat::Header< TPointer >::payload_size_word().

{ return m_start[2]; }

template<class TPointer>

uint32_t eformat::ROSFragment< TPointer >::lvl1_id

(

)

const [inline]

Returns the lvl1 identifier

Definition at line 91 of file ROSFragment.h.

References eformat::ROSFragment< TPointer >::m_start.

{ return m_start[1]; }

template<class TPointer>

uint32_t eformat::Header< TPointer >::marker

(

)

const [inline, inherited]

Returns the fragment type.

Definition at line 95 of file Header.h.

References eformat::Header< TPointer >::m_start.

Referenced by eformat::Header< TPointer >::assign(), eformat::Header< TPointer >::check(), eformat::Header< TPointer >::child(), eformat::Header< TPointer >::children(), eformat::Header< TPointer >::Header(), and eformat::Header< TPointer >::nchildren().

{ return m_start[0]; }

template<class TPointer>

uint32_t eformat::Header< TPointer >::nchildren

(

)

const [virtual, inherited]

Returns the number of children available.

Definition at line 263 of file Header.h.

References EvtCyclic3::c_str(), eformat::Header< TPointer >::children(), ERS_DEBUG_2, eformat::Header< TPointer >::marker(), eformat::marker2string(), and eformat::Header< TPointer >::source_id().

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

{
  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);
}

template<class TPointer>

uint32_t eformat::Header< TPointer >::nspecific

(

)

const [inline, inherited]

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

Definition at line 164 of file Header.h.

References eformat::Header< TPointer >::m_start, and eformat::Header< TPointer >::nstatus().

Referenced by eformat::Header< TPointer >::check().

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

template<class TPointer>

uint32_t eformat::Header< TPointer >::nstatus

(

)

const [inline, inherited]

Returns the number of status words available

Definition at line 121 of file Header.h.

References eformat::Header< TPointer >::m_start.

Referenced by eformat::Header< TPointer >::check(), eformat::Header< TPointer >::nspecific(), and eformat::Header< TPointer >::specific_header().

{ return m_start[5]; }

template<class TPointer>

ROSFragment& eformat::ROSFragment< TPointer >::operator=

(

const ROSFragment< TPointer > &

other

)

[inline]

Copy operator

Parameters:

other

The fragment to be copied

Definition at line 63 of file ROSFragment.h.

References eformat::ROSFragment< TPointer >::m_start, and EvtCyclic3::other().

    { Header<TPointer>::operator=(other); m_start=other.m_start; return *this; }

template<class TPointer>

void eformat::Header< TPointer >::payload

(

TPointer &

it

)

const [inline, inherited]

Sets the pointer to where the payload starts

Parameters:

it

The pointer to set

Definition at line 135 of file Header.h.

References eformat::Header< TPointer >::header_size_word(), and eformat::Header< TPointer >::m_start.

Referenced by eformat::Header< TPointer >::child(), and eformat::Header< TPointer >::children().

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

template<class TPointer>

uint32_t eformat::Header< TPointer >::payload_size_word

(

void

)

const [inline, inherited]

Returns the payload size

Definition at line 149 of file Header.h.

References eformat::Header< TPointer >::fragment_size_word(), and eformat::Header< TPointer >::header_size_word().

Referenced by eformat::Header< TPointer >::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().

    { return fragment_size_word() - header_size_word(); }

template<class TPointer>

uint32_t eformat::ROSFragment< TPointer >::run_no

(

)

const [inline]

Returns the run number

Definition at line 86 of file ROSFragment.h.

References eformat::ROSFragment< TPointer >::m_start.

{ return m_start[0]; }

template<class TPointer>

uint32_t eformat::Header< TPointer >::source_id

(

)

const [inline, inherited]

Returns the full source identifier.

Definition at line 116 of file Header.h.

References eformat::Header< TPointer >::m_start.

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

{ return m_start[4]; }

template<class TPointer>

void eformat::Header< TPointer >::specific_header

(

TPointer &

it

)

const [inline, inherited]

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.

References eformat::Header< TPointer >::m_start, and eformat::Header< TPointer >::nstatus().

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

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

template<class TPointer>

void eformat::Header< TPointer >::start

(

TPointer &

it

)

const [inline, inherited]

Sets the pointer to my start

Parameters:

it

The pointer to set

Definition at line 128 of file Header.h.

References eformat::Header< TPointer >::m_start.

{ it = m_start; }

template<class TPointer>

void eformat::Header< TPointer >::status

(

TPointer &

it

)

const [inline, inherited]

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.

References eformat::Header< TPointer >::m_start.

{ it = m_start; it += 6; }

template<class TPointer>

uint32_t eformat::Header< TPointer >::version

(

)

const [inline, inherited]

Returns the formatting version.

Definition at line 111 of file Header.h.

References eformat::Header< TPointer >::m_start.

Referenced by eformat::Header< TPointer >::check().

{ return m_start[3]; }

---

Member Data Documentation

template<class TPointer>

TPointer eformat::ROSFragment< TPointer >::m_start [private]

my start word

Reimplemented from eformat::Header< TPointer >.

Definition at line 104 of file ROSFragment.h.

Referenced by eformat::ROSFragment< TPointer >::assign(), eformat::ROSFragment< TPointer >::bc_id(), eformat::ROSFragment< TPointer >::lvl1_id(), eformat::ROSFragment< TPointer >::operator=(), eformat::ROSFragment< TPointer >::ROSFragment(), and eformat::ROSFragment< TPointer >::run_no().

template<class TPointer>

const uint32_t eformat::ROSFragment< TPointer >::NSPECIFIC = 3 [static, private]

Definition at line 100 of file ROSFragment.h.

Referenced by eformat::ROSFragment< TPointer >::check().

---