eformat::SubDetectorFragment< TPointer > Class Template Reference

#include <SubDetectorFragment.h>

Inheritance diagram for eformat::SubDetectorFragment< TPointer >:

Public Member Functions
	SubDetectorFragment (const TPointer &it)
	SubDetectorFragment ()
	SubDetectorFragment (const SubDetectorFragment &other)
virtual	~SubDetectorFragment ()
SubDetectorFragment &	operator= (const SubDetectorFragment &other)
SubDetectorFragment &	assign (const TPointer &it)
virtual bool	check () const
bool	check_tree () const
	SubDetectorFragment (const TPointer &it)
	SubDetectorFragment ()
	SubDetectorFragment (const SubDetectorFragment &other)
virtual	~SubDetectorFragment ()
SubDetectorFragment &	operator= (const SubDetectorFragment &other)
SubDetectorFragment &	assign (const TPointer &it)
virtual bool	check () const
bool	check_tree () const
	SubDetectorFragment (const TPointer &it)
	SubDetectorFragment ()
	SubDetectorFragment (const SubDetectorFragment &other)
virtual	~SubDetectorFragment ()
SubDetectorFragment &	operator= (const SubDetectorFragment &other)
SubDetectorFragment &	assign (const TPointer &it)
virtual bool	check () const
bool	check_tree () 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)
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)
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)
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::SubDetectorFragment< 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/include/eformat/SubDetectorFragment.h.

Constructor & Destructor Documentation

SubDetectorFragment() [1/9]

template<class TPointer>

eformat::SubDetectorFragment< TPointer >::SubDetectorFragment

(

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 97 of file Event/eformat/include/eformat/SubDetectorFragment.h.

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

SubDetectorFragment() [2/9]

template<class TPointer>

eformat::SubDetectorFragment< TPointer >::SubDetectorFragment ( )

inline

Builds an empty, otherwise useless SubDetectorFragment

Definition at line 42 of file Event/eformat/include/eformat/SubDetectorFragment.h.

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

SubDetectorFragment() [3/9]

template<class TPointer>

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

inline

Copy constructor

Parameters

other

The fragment to be copied

Definition at line 49 of file Event/eformat/include/eformat/SubDetectorFragment.h.

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

~SubDetectorFragment() [1/3]

template<class TPointer>

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

inlinevirtual

Destructor virtualisation

Definition at line 55 of file Event/eformat/include/eformat/SubDetectorFragment.h.

{}

SubDetectorFragment() [4/9]

template<class TPointer>

eformat::SubDetectorFragment< TPointer >::SubDetectorFragment

(

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.

SubDetectorFragment() [5/9]

template<class TPointer>

eformat::SubDetectorFragment< TPointer >::SubDetectorFragment ( )

inline

Builds an empty, otherwise useless SubDetectorFragment

Definition at line 42 of file InstallArea/x86_64-el9-gcc13-dbg/include/eformat/SubDetectorFragment.h.

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

SubDetectorFragment() [6/9]

template<class TPointer>

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

inline

Copy constructor

Parameters

other

The fragment to be copied

Definition at line 49 of file InstallArea/x86_64-el9-gcc13-dbg/include/eformat/SubDetectorFragment.h.

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

~SubDetectorFragment() [2/3]

template<class TPointer>

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

inlinevirtual

Destructor virtualisation

Definition at line 55 of file InstallArea/x86_64-el9-gcc13-dbg/include/eformat/SubDetectorFragment.h.

{}

SubDetectorFragment() [7/9]

template<class TPointer>

eformat::SubDetectorFragment< TPointer >::SubDetectorFragment

(

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.

SubDetectorFragment() [8/9]

template<class TPointer>

eformat::SubDetectorFragment< TPointer >::SubDetectorFragment ( )

inline

Builds an empty, otherwise useless SubDetectorFragment

Definition at line 42 of file InstallArea/x86_64-el9-gcc13-opt/include/eformat/SubDetectorFragment.h.

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

SubDetectorFragment() [9/9]

template<class TPointer>

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

inline

Copy constructor

Parameters

other

The fragment to be copied

Definition at line 49 of file InstallArea/x86_64-el9-gcc13-opt/include/eformat/SubDetectorFragment.h.

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

~SubDetectorFragment() [3/3]

template<class TPointer>

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

inlinevirtual

Destructor virtualisation

Definition at line 55 of file InstallArea/x86_64-el9-gcc13-opt/include/eformat/SubDetectorFragment.h.

{}

Member Function Documentation

assign() [1/3]

template<class TPointer>

eformat::SubDetectorFragment< TPointer > & eformat::SubDetectorFragment< TPointer >::assign

(

const TPointer &

it

)

Manual re-assignment

Parameters

it	The position pointing the first word of this fragment

Definition at line 104 of file Event/eformat/include/eformat/SubDetectorFragment.h.

                                                                 {
  ERS_DEBUG_3( "Re-building SubDetectorFragment from pointer" );
  eformat::Header<TPointer>::assign( it, eformat::SUB_DETECTOR );
  eformat::Header<TPointer>::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/3]

template<class TPointer>

SubDetectorFragment & eformat::SubDetectorFragment< TPointer >::assign

(

const TPointer &

it

)

Manual re-assignment

Parameters

it	The position pointing the first word of this fragment

assign() [3/3]

template<class TPointer>

SubDetectorFragment & eformat::SubDetectorFragment< TPointer >::assign

(

const TPointer &

it

)

Manual re-assignment

Parameters

it	The position pointing the first word of this fragment

check() [1/3]

template<class TPointer>

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

virtual

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

Reimplemented from eformat::Header< TPointer >.

Definition at line 113 of file Event/eformat/include/eformat/SubDetectorFragment.h.

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

Referenced by check_tree().

check() [2/3]

template<class TPointer>

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

virtual

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

Reimplemented from eformat::Header< TPointer >.

check() [3/3]

template<class TPointer>

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

virtual

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

Reimplemented from eformat::Header< TPointer >.

check_tree() [1/3]

template<class TPointer>

bool eformat::SubDetectorFragment< TPointer >::check_tree

(

)

const

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

Definition at line 121 of file Event/eformat/include/eformat/SubDetectorFragment.h.

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

check_tree() [2/3]

template<class TPointer>

bool eformat::SubDetectorFragment< TPointer >::check_tree

(

)

const

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

check_tree() [3/3]

template<class TPointer>

bool eformat::SubDetectorFragment< TPointer >::check_tree

(

)

const

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

operator=() [1/3]

template<class TPointer>

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

inline

Copy operator

Parameters

other

The fragment to be copied

Definition at line 62 of file Event/eformat/include/eformat/SubDetectorFragment.h.

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

operator=() [2/3]

template<class TPointer>

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

inline

Copy operator

Parameters

other

The fragment to be copied

Definition at line 62 of file InstallArea/x86_64-el9-gcc13-dbg/include/eformat/SubDetectorFragment.h.

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

operator=() [3/3]

template<class TPointer>

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

inline

Copy operator

Parameters

other

The fragment to be copied

Definition at line 62 of file InstallArea/x86_64-el9-gcc13-opt/include/eformat/SubDetectorFragment.h.

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

---

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

• Event/eformat/include/eformat/SubDetectorFragment.h
• InstallArea/x86_64-el9-gcc13-dbg/include/eformat/SubDetectorFragment.h
• InstallArea/x86_64-el9-gcc13-opt/include/eformat/SubDetectorFragment.h