eformat::ROSFragment< TPointer > Class Template Reference

#include <ROSFragment.h>

Inheritance diagram for eformat::ROSFragment< TPointer >:

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
	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
Public Member Functions inherited from eformat::Header< TPointer >
	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
	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::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 Event/eformat/eformat-00-00-04/eformat/ROSFragment.h.

Constructor & Destructor Documentation

ROSFragment() [1/6]

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 Event/eformat/eformat-00-00-04/eformat/ROSFragment.h.

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

ROSFragment() [2/6]

template<class TPointer >

eformat::ROSFragment< TPointer >::ROSFragment ( )

inline

Builds an empty, otherwise useless ROSFragment

Definition at line 43 of file Event/eformat/eformat-00-00-04/eformat/ROSFragment.h.

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

ROSFragment() [3/6]

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 Event/eformat/eformat-00-00-04/eformat/ROSFragment.h.

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

~ROSFragment() [1/2]

template<class TPointer >

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

inlinevirtual

Destructor virtualisation

Definition at line 56 of file Event/eformat/eformat-00-00-04/eformat/ROSFragment.h.

{}

ROSFragment() [4/6]

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.

ROSFragment() [5/6]

template<class TPointer >

eformat::ROSFragment< TPointer >::ROSFragment ( )

inline

Builds an empty, otherwise useless ROSFragment

Definition at line 43 of file InstallArea/include/eformat/eformat/ROSFragment.h.

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

ROSFragment() [6/6]

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 InstallArea/include/eformat/eformat/ROSFragment.h.

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

~ROSFragment() [2/2]

template<class TPointer >

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

inlinevirtual

Destructor virtualisation

Definition at line 56 of file InstallArea/include/eformat/eformat/ROSFragment.h.

{}

Member Function Documentation

assign() [1/2]

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 Event/eformat/eformat-00-00-04/eformat/ROSFragment.h.

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

assign() [2/2]

template<class TPointer >

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

(

const TPointer &

it

)

Manual re-assignment

Parameters

it	The position pointing the first word of this fragment

bc_id() [1/2]

template<class TPointer >

uint32_t eformat::ROSFragment< TPointer >::bc_id ( ) const

inline

Returns the bunch crossing identifier

Definition at line 96 of file Event/eformat/eformat-00-00-04/eformat/ROSFragment.h.

{ return m_start[2]; }

bc_id() [2/2]

template<class TPointer >

uint32_t eformat::ROSFragment< TPointer >::bc_id ( ) const

inline

Returns the bunch crossing identifier

Definition at line 96 of file InstallArea/include/eformat/eformat/ROSFragment.h.

{ return m_start[2]; }

check() [1/2]

template<class TPointer >

bool eformat::ROSFragment< TPointer >::check

virtual

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

Reimplemented from eformat::Header< TPointer >.

Definition at line 133 of file Event/eformat/eformat-00-00-04/eformat/ROSFragment.h.

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

check() [2/2]

template<class TPointer >

virtual bool eformat::ROSFragment< TPointer >::check ( ) const

virtual

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

Reimplemented from eformat::Header< TPointer >.

check_tree() [1/2]

template<class TPointer >

bool eformat::ROSFragment< TPointer >::check_tree

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

Definition at line 143 of file Event/eformat/eformat-00-00-04/eformat/ROSFragment.h.

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

Referenced by main().

check_tree() [2/2]

template<class TPointer >

bool eformat::ROSFragment< TPointer >::check_tree

(

)

const

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

lvl1_id() [1/2]

template<class TPointer >

uint32_t eformat::ROSFragment< TPointer >::lvl1_id ( ) const

inline

Returns the lvl1 identifier

Definition at line 91 of file Event/eformat/eformat-00-00-04/eformat/ROSFragment.h.

{ return m_start[1]; }

Referenced by main().

lvl1_id() [2/2]

template<class TPointer >

uint32_t eformat::ROSFragment< TPointer >::lvl1_id ( ) const

inline

Returns the lvl1 identifier

Definition at line 91 of file InstallArea/include/eformat/eformat/ROSFragment.h.

{ return m_start[1]; }

operator=() [1/2]

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 Event/eformat/eformat-00-00-04/eformat/ROSFragment.h.

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

operator=() [2/2]

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 InstallArea/include/eformat/eformat/ROSFragment.h.

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

run_no() [1/2]

template<class TPointer >

uint32_t eformat::ROSFragment< TPointer >::run_no ( ) const

inline

Returns the run number

Definition at line 86 of file Event/eformat/eformat-00-00-04/eformat/ROSFragment.h.

{ return m_start[0]; }

run_no() [2/2]

template<class TPointer >

uint32_t eformat::ROSFragment< TPointer >::run_no ( ) const

inline

Returns the run number

Definition at line 86 of file InstallArea/include/eformat/eformat/ROSFragment.h.

{ return m_start[0]; }

---

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

• Event/eformat/eformat-00-00-04/eformat/ROSFragment.h
• InstallArea/include/eformat/eformat/ROSFragment.h