eformat::old::ROBFragment Class Reference

#include <ROBFragment.h>

Inheritance diagram for eformat::old::ROBFragment:

Public Member Functions
	ROBFragment (const uint32_t *it)
virtual	~ROBFragment ()
virtual bool	check () const
bool	check_tree () const
uint32_t	lvl1_id () const
uint32_t	bc_id () const
uint32_t	lvl1_trigger_type () const
uint32_t	detev_type () const
eformat::old::RODFragment	rod (size_t n) const
	ROBFragment (const uint32_t *it)
virtual	~ROBFragment ()
virtual bool	check () const
bool	check_tree () const
uint32_t	lvl1_id () const
uint32_t	bc_id () const
uint32_t	lvl1_trigger_type () const
uint32_t	detev_type () const
eformat::old::RODFragment	rod (size_t n) const
	ROBFragment (const uint32_t *it)
virtual	~ROBFragment ()
virtual bool	check () const
bool	check_tree () const
uint32_t	lvl1_id () const
uint32_t	bc_id () const
uint32_t	lvl1_trigger_type () const
uint32_t	detev_type () const
eformat::old::RODFragment	rod (size_t n) const
Public Member Functions inherited from eformat::old::Header
	Header (const uint32_t *it, uint32_t match)
virtual	~Header ()
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	run_no () const
uint32_t	nstatus () const
const uint32_t *	status () const
uint32_t	noffset () const
const uint32_t *	offset (void) const
uint32_t	nspecific () const
const uint32_t *	specific_header (void) const
const uint32_t *	child (size_t n) const
	Header (const uint32_t *it, uint32_t match)
virtual	~Header ()
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	run_no () const
uint32_t	nstatus () const
const uint32_t *	status () const
uint32_t	noffset () const
const uint32_t *	offset (void) const
uint32_t	nspecific () const
const uint32_t *	specific_header (void) const
const uint32_t *	child (size_t n) const
	Header (const uint32_t *it, uint32_t match)
virtual	~Header ()
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	run_no () const
uint32_t	nstatus () const
const uint32_t *	status () const
uint32_t	noffset () const
const uint32_t *	offset (void) const
uint32_t	nspecific () const
const uint32_t *	specific_header (void) const
const uint32_t *	child (size_t n) const

Detailed Description

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/old/ROBFragment.h.

Constructor & Destructor Documentation

ROBFragment() [1/3]

eformat::old::ROBFragment::ROBFragment

(

const uint32_t *

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 18 of file ROBFragment24.cxx.

    : eformat::old::Header( it, eformat::ROB ), m_start( specific_header() ) {}

~ROBFragment() [1/3]

virtual eformat::old::ROBFragment::~ROBFragment ( )

inlinevirtual

Destructor virtualisation

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

{}

ROBFragment() [2/3]

eformat::old::ROBFragment::ROBFragment

(

const uint32_t *

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.

~ROBFragment() [2/3]

virtual eformat::old::ROBFragment::~ROBFragment ( )

inlinevirtual

Destructor virtualisation

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

{}

ROBFragment() [3/3]

eformat::old::ROBFragment::ROBFragment

(

const uint32_t *

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.

~ROBFragment() [3/3]

virtual eformat::old::ROBFragment::~ROBFragment ( )

inlinevirtual

Destructor virtualisation

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

{}

Member Function Documentation

bc_id() [1/3]

uint32_t eformat::old::ROBFragment::bc_id ( ) const

inline

Returns the bunch crossing identifier

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

{ return m_start[1]; }

bc_id() [2/3]

uint32_t eformat::old::ROBFragment::bc_id ( ) const

inline

Returns the bunch crossing identifier

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

{ return m_start[1]; }

bc_id() [3/3]

uint32_t eformat::old::ROBFragment::bc_id ( ) const

inline

Returns the bunch crossing identifier

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

{ return m_start[1]; }

check() [1/3]

bool eformat::old::ROBFragment::check ( ) const

virtual

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

Reimplemented from eformat::old::Header.

Definition at line 21 of file ROBFragment24.cxx.

                                        {
  eformat::old::Header::check(); //< first do a generic check
  if ( nspecific() != 4 ) throw EFORMAT_SIZE_CHECK( 4, nspecific() );
  return true;
}

Referenced by check_tree(), and rod().

check() [2/3]

virtual bool eformat::old::ROBFragment::check ( ) const

virtual

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

Reimplemented from eformat::old::Header.

check() [3/3]

virtual bool eformat::old::ROBFragment::check ( ) const

virtual

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

Reimplemented from eformat::old::Header.

check_tree() [1/3]

bool eformat::old::ROBFragment::check_tree

(

)

const

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

Definition at line 27 of file ROBFragment24.cxx.

                                             {
  check(); // check myself
  for ( size_t i = 0; i < noffset(); ++i )
  {
    size_t rod_size = 0;
    // typical
    if ( noffset() == 1 ) rod_size = fragment_size_word() - header_size_word();
    else
    { // more atypical, have to calculate
      if ( i != noffset() - 1 ) rod_size = ( 0xffffff & offset()[i + 1] );
      else rod_size = fragment_size_word();
      rod_size -= ( 0xffffff & offset()[i] );
    }
    eformat::old::RODFragment f( child( i ), rod_size );
    f.check();
  }
  return true;
}

Referenced by eformat::old::ROSFragment::check_tree().

check_tree() [2/3]

bool eformat::old::ROBFragment::check_tree

(

)

const

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

check_tree() [3/3]

bool eformat::old::ROBFragment::check_tree

(

)

const

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

detev_type() [1/3]

uint32_t eformat::old::ROBFragment::detev_type ( ) const

inline

Returns the detector event type

Definition at line 72 of file Event/eformat/include/eformat/old/ROBFragment.h.

{ return m_start[3]; }

detev_type() [2/3]

uint32_t eformat::old::ROBFragment::detev_type ( ) const

inline

Returns the detector event type

Definition at line 72 of file InstallArea/x86_64-el9-gcc13-dbg/include/eformat/old/ROBFragment.h.

{ return m_start[3]; }

detev_type() [3/3]

uint32_t eformat::old::ROBFragment::detev_type ( ) const

inline

Returns the detector event type

Definition at line 72 of file InstallArea/x86_64-el9-gcc13-opt/include/eformat/old/ROBFragment.h.

{ return m_start[3]; }

lvl1_id() [1/3]

uint32_t eformat::old::ROBFragment::lvl1_id ( ) const

inline

Returns the lvl1 identifier

Definition at line 57 of file Event/eformat/include/eformat/old/ROBFragment.h.

{ return m_start[0]; }

lvl1_id() [2/3]

uint32_t eformat::old::ROBFragment::lvl1_id ( ) const

inline

Returns the lvl1 identifier

Definition at line 57 of file InstallArea/x86_64-el9-gcc13-dbg/include/eformat/old/ROBFragment.h.

{ return m_start[0]; }

lvl1_id() [3/3]

uint32_t eformat::old::ROBFragment::lvl1_id ( ) const

inline

Returns the lvl1 identifier

Definition at line 57 of file InstallArea/x86_64-el9-gcc13-opt/include/eformat/old/ROBFragment.h.

{ return m_start[0]; }

lvl1_trigger_type() [1/3]

uint32_t eformat::old::ROBFragment::lvl1_trigger_type ( ) const

inline

Returns the lvl1 trigger type

Definition at line 67 of file Event/eformat/include/eformat/old/ROBFragment.h.

{ return m_start[2]; }

lvl1_trigger_type() [2/3]

uint32_t eformat::old::ROBFragment::lvl1_trigger_type ( ) const

inline

Returns the lvl1 trigger type

Definition at line 67 of file InstallArea/x86_64-el9-gcc13-dbg/include/eformat/old/ROBFragment.h.

{ return m_start[2]; }

lvl1_trigger_type() [3/3]

uint32_t eformat::old::ROBFragment::lvl1_trigger_type ( ) const

inline

Returns the lvl1 trigger type

Definition at line 67 of file InstallArea/x86_64-el9-gcc13-opt/include/eformat/old/ROBFragment.h.

{ return m_start[2]; }

rod() [1/3]

eformat::old::RODFragment eformat::old::ROBFragment::rod

(

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.

Definition at line 46 of file ROBFragment24.cxx.

                                                                 {
  check();
  size_t rod_size = 0;
  // typical
  if ( noffset() == 1 ) rod_size = fragment_size_word() - header_size_word();
  else
  { // more atypical, have to calculate
    if ( n != noffset() - 1 ) rod_size = ( 0xffffff & offset()[n + 1] );
    else rod_size = fragment_size_word();
    rod_size -= ( 0xffffff & offset()[n] );
  }
  eformat::old::RODFragment f( child( n ), rod_size );
  f.check();
  return f;
}

Referenced by eformat::old::convert(), and convert_ros().

rod() [2/3]

eformat::old::RODFragment eformat::old::ROBFragment::rod

(

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.

rod() [3/3]

eformat::old::RODFragment eformat::old::ROBFragment::rod

(

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.

---

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

• Event/eformat/include/eformat/old/ROBFragment.h
• InstallArea/x86_64-el9-gcc13-dbg/include/eformat/old/ROBFragment.h
• InstallArea/x86_64-el9-gcc13-opt/include/eformat/old/ROBFragment.h
• ROBFragment24.cxx