offline_eformat::v40::ROBFragment Class Reference

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

#include <v40_ROBFragment.h>

Inheritance diagram for offline_eformat::v40::ROBFragment:

Collaboration diagram for offline_eformat::v40::ROBFragment:

Public Member Functions
	ROBFragment (const uint32_t *it)
	To build a fragment given the containing buffer.
	ROBFragment (const ROBFragment &other)
	Copy constructor.
	ROBFragment ()
	Builds an empty, otherwise useless ROBFragment.
	ROBFragment (const eformat::helper::u32list &blob)
	Constructor that only works with T=<real pointer>.
	ROBFragment (const eformat::helper::u32slice &blob)
	Constructor that only works with T=<real pointer>.
virtual	~ROBFragment ()
	Destructor virtualisation.
ROBFragment &	operator= (const ROBFragment &other)
	Assignment.
ROBFragment &	assign (const uint32_t *it)
	Manual re-assignment.
bool	check_rob (const uint16_t version=eformat::MAJOR_V40_VERSION) const
	Says if the ROB fragment is valid.
bool	check_rob_noex (const uint16_t version=eformat::MAJOR_V40_VERSION) const
	Says if the ROB fragment is valid.
bool	check_rob_impl (const uint16_t version=eformat::MAJOR_V40_VERSION, const bool exc=true) const
	Says if the ROB fragment is valid.
bool	check_rod_noex (const uint16_t rod_version=eformat::MAJOR_V31_VERSION) const
	Says if the underlying ROD fragment is valid.
bool	check_rod (const uint16_t rod_version=eformat::MAJOR_V31_VERSION) const
	Says if the underlying ROD fragment is valid.
bool	check_rod_impl (const uint16_t rod_version=eformat::MAJOR_V31_VERSION, const bool exc=true) const
	Says if the underlying ROD fragmentis valid.
bool	check (const uint16_t version=eformat::MAJOR_V40_VERSION, const uint16_t rod_version=eformat::MAJOR_V31_VERSION) const
	Says if the fragment is valid.
bool	check_noex (const uint16_t version=eformat::MAJOR_V40_VERSION, const uint16_t rod_version=eformat::MAJOR_V31_VERSION) const
	Says if the fragment is valid.
bool	check_impl (const uint16_t version=eformat::MAJOR_V40_VERSION, const uint16_t rod_version=eformat::MAJOR_V31_VERSION, const bool exc=true) const
	Says if the fragment is valid.
void	problems (std::vector< eformat::FragmentProblem > &p, const uint16_t version=eformat::MAJOR_V40_VERSION, const uint16_t rod_version=eformat::MAJOR_V31_VERSION) const
	Tells which problemS the current fragment has.
void	rob_problems (std::vector< eformat::FragmentProblem > &p, const uint16_t version=eformat::MAJOR_V40_VERSION) const
	Tells which problemS the current ROB fragment has.
void	rod_problems (std::vector< eformat::FragmentProblem > &p, const uint16_t version=eformat::MAJOR_V31_VERSION) const
	Tells which problemS the underlying ROD fragment has.
uint32_t	rob_source_id () const
	Gets the source_id of the ROB fragment itself.
const uint32_t *	rod_start () const
	Sets the given pointer to the ROD fragment start.
void	rod_start (const uint32_t *&it) const
uint32_t	rod_marker () const
	Returns the fragment type.
uint32_t	rod_fragment_size_word () const
	Returns the total fragment size.
uint32_t	rod_header_size_word () const
	Returns the size, in words, of the current header.
uint32_t	rod_trailer_size_word () const
	Returns the size, in words, of the trailer.
uint32_t	rod_version () const
	Returns the formatting version for the ROD fragment.
uint32_t	rod_source_id () const
	Returns the source identifier of the ROD fragment.
uint32_t	rod_run_no () const
	Returns the current run number.
uint32_t	rod_lvl1_id () const
	Returns the lvl1 identifier.
uint32_t	rod_bc_id () const
	Returns the bunch crossing identifier.
uint32_t	rod_lvl1_trigger_type () const
	Returns the lvl1 trigger type.
uint32_t	rod_detev_type () const
	Returns the detector event type.
uint32_t	rod_nstatus () const
	Returns the number of status words available.
const uint32_t *	rod_status () const
	Returns the status words, as an iterator to the status words available.
void	rod_status (const uint32_t *&it) const
uint32_t	rod_ndata () const
	Returns the number of data words available.
const uint32_t *	rod_data () const
	Returns a pointer to the first data word.
void	rod_data (const uint32_t *&it) const
uint32_t	rod_status_position () const
	Returns the status block position.
virtual uint32_t	nchildren () const
	Returns the number of children available.
const uint32_t *	child (size_t n) const
	Returns the nth child fragment.
virtual void	child (const uint32_t *&p, size_t n) const
virtual uint32_t	children (const uint32_t **p, size_t max) const
	Returns all the children of this fragment.
void	throws (bool b)
	If you set this parameter, objects of this type will throw exceptions.
bool	throws () const
	Says if we are supposed to throw exceptions or not.
uint32_t	marker () const
	Returns the fragment type.
uint32_t	fragment_size_word () const
	Returns the size, in words, of the current fragment.
uint32_t	header_size_word () const
	Returns the size, in words, of the current header.
uint32_t	version () const
	Returns the formatting version.
uint32_t	source_id () const
	Returns the full source identifier.
uint32_t	nstatus () const
	Returns the number of status words available.
const uint32_t *	start () const
	Sets the pointer to my start.
void	start (const uint32_t *&it) const
const uint32_t *	payload () const
	Sets the pointer to where the payload starts.
void	payload (const uint32_t *&it) const
const uint32_t *	end () const
	Sets the pointer to one-past my end position.
void	end (const uint32_t *&it) const
uint32_t	payload_size_word (void) const
	Returns the payload size.
const uint32_t *	status () const
	Returns the status words, as an iterator to the status words available.
void	status (const uint32_t *&it) const
uint32_t	checksum_type () const
	Returns the check-sum type entry.
uint32_t	nspecific () const
	Returns the number of specific words available in the specific header part.
const uint32_t *	specific_header () const
	Returns an iterator to the start of the specific header part.
void	specific_header (const uint32_t *&it) const
uint32_t	checksum_value (void) const
	Access the check sum value of this fragment, if any.
uint32_t	eval_checksum (void) const
	Evaluates the current (supposed) checksum for this fragment, taking into consideration the current setting for the checksum type.
bool	checksum (void) const
	This will actually re-calculate the checksum and verify that the payload of the current fragment matches that.

Private Attributes
const uint32_t *	m_start
	my one-after-the-last word
const uint32_t *	m_top
	< representation

Detailed Description

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

Definition at line 35 of file v40_ROBFragment.h.

Constructor & Destructor Documentation

ROBFragment() [1/5]

offline_eformat::v40::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 16 of file v40_ROBFragment.cxx.

  : Header(it),
    m_start()
{
  Header::specific_header(m_start);
}

ROBFragment() [2/5]

offline_eformat::v40::ROBFragment::ROBFragment

(

const ROBFragment &

other

)

Copy constructor.

Parameters

other

The fragment to be copied

Definition at line 23 of file v40_ROBFragment.cxx.

  : Header(other), m_start(other.m_start)
{
}

ROBFragment() [3/5]

offline_eformat::v40::ROBFragment::ROBFragment

(

)

Builds an empty, otherwise useless ROBFragment.

Definition at line 29 of file v40_ROBFragment.cxx.

  : Header(), m_start()
{
}

ROBFragment() [4/5]

offline_eformat::v40::ROBFragment::ROBFragment

(

const eformat::helper::u32list &

blob

)

Constructor that only works with T=<real pointer>.

This constructor is pretty much like the one with the pointer, but it will fetch the pointer from the u32 blob. It is only used in the python bindings.

Parameters

blob	The blob which contains the block of data this fragment is in.

Definition at line 34 of file v40_ROBFragment.cxx.

  : Header(blob.ptr()),
    m_start()
{
  Header::specific_header(m_start);
}

ROBFragment() [5/5]

offline_eformat::v40::ROBFragment::ROBFragment

(

const eformat::helper::u32slice &

blob

)

Constructor that only works with T=<real pointer>.

This constructor is pretty much like the one with the pointer, but it will fetch the pointer from the u32 blob. It is only used in the python bindings.

Parameters

blob	The blob which contains the block of data this fragment is in.

Definition at line 41 of file v40_ROBFragment.cxx.

  : Header(blob.ptr()),
    m_start()
{
  Header::specific_header(m_start);
}

~ROBFragment()

offline_eformat::v40::ROBFragment::~ROBFragment ( )

virtual

Destructor virtualisation.

Definition at line 48 of file v40_ROBFragment.cxx.

{
}

Member Function Documentation

assign()

offline_eformat::v40::ROBFragment & offline_eformat::v40::ROBFragment::assign

(

const uint32_t *

it

)

Manual re-assignment.

Parameters

it	The position pointing the first word of this fragment

Definition at line 63 of file v40_ROBFragment.cxx.

{
  Header::assign(it);
  Header::specific_header(m_start);
  return *this;
}

check()

bool offline_eformat::v40::ROBFragment::check	(	const uint16_t	version = eformat::MAJOR_V40_VERSION,
		const uint16_t	rod_version = eformat::MAJOR_V31_VERSION ) const

Says if the fragment is valid.

This method will throw exceptions.

Definition at line 174 of file v40_ROBFragment.cxx.

{
  return this->check_impl(version, rod_version, true);
}

check_impl()

bool offline_eformat::v40::ROBFragment::check_impl	(	const uint16_t	version = eformat::MAJOR_V40_VERSION,
		const uint16_t	rod_version = eformat::MAJOR_V31_VERSION,
		const bool	exc = true ) const

Says if the fragment is valid.

Exception behaviour is controllable.

Definition at line 157 of file v40_ROBFragment.cxx.

{
  return this->check_rob_impl(version, exc) && 
    this->check_rod_impl(rod_version, exc);
}

check_noex()

bool offline_eformat::v40::ROBFragment::check_noex	(	const uint16_t	version = eformat::MAJOR_V40_VERSION,
		const uint16_t	rod_version = eformat::MAJOR_V31_VERSION ) const

Says if the fragment is valid.

This method does not throw exceptions.

Definition at line 167 of file v40_ROBFragment.cxx.

{
  return this->check_impl(version, rod_version, false);
}

check_rob()

bool offline_eformat::v40::ROBFragment::check_rob

(

const uint16_t

version = eformat::MAJOR_V40_VERSION

)

const

Says if the ROB fragment is valid.

This method will throw exceptions.

Definition at line 107 of file v40_ROBFragment.cxx.

{
    return this->check_rob_impl(version, true);
}

check_rob_impl()

bool offline_eformat::v40::ROBFragment::check_rob_impl	(	const uint16_t	version = eformat::MAJOR_V40_VERSION,
		const bool	exc = true ) const

Says if the ROB fragment is valid.

Exception behaviour is controllable.

Definition at line 71 of file v40_ROBFragment.cxx.

{
  bool result = true;
 
  try{
    if (Header::marker() != eformat::ROB) {
      throw EFORMAT_WRONG_MARKER(marker(), eformat::ROB);
    }
    if (Header::version() >> 16 != version) {
      throw EFORMAT_BAD_VERSION(Header::version() >> 16, version);
    }
    uint32_t calculated = 7 + Header::nstatus();
    if (Header::header_size_word() != calculated) {
      throw EFORMAT_SIZE_CHECK(calculated, Header::header_size_word());
    }
  }catch(eformat::WrongMarkerIssue &ex){
    if(exc) throw ex;
    result = false;
  }catch(eformat::SizeCheckIssue &ex){
    if(exc) throw ex;
    result = false;
  }catch(eformat::BadVersionIssue &ex){
    if(exc) throw ex;
    result = false;
  }
  
  return result;
}

check_rob_noex()

bool offline_eformat::v40::ROBFragment::check_rob_noex

(

const uint16_t

version = eformat::MAJOR_V40_VERSION

)

const

Says if the ROB fragment is valid.

Does not throw exceptions.

Definition at line 102 of file v40_ROBFragment.cxx.

{
  return this->check_rob_impl(version, false);
}

check_rod()

bool offline_eformat::v40::ROBFragment::check_rod

(

const uint16_t

rod_version = eformat::MAJOR_V31_VERSION

)

const

Says if the underlying ROD fragment is valid.

Throws exceptions.

Definition at line 150 of file v40_ROBFragment.cxx.

{
  return this->check_rod_impl(version, true);
}

check_rod_impl()

bool offline_eformat::v40::ROBFragment::check_rod_impl	(	const uint16_t	rod_version = eformat::MAJOR_V31_VERSION,
		const bool	exc = true ) const

Says if the underlying ROD fragmentis valid.

Exception behaviour is controllable.

Definition at line 114 of file v40_ROBFragment.cxx.

{
  bool result = true;
 
  try{
    if ( rod_version() >> 16 != version ) {
      throw EFORMAT_BAD_ROD_VERSION(rod_version() >> 16, version);
    }
    if ( rod_header_size_word() != 9 ) {
      throw EFORMAT_SIZE_CHECK(9, rod_header_size_word());
    }
    if ( rod_fragment_size_word() != 12 + rod_nstatus() + rod_ndata() ) {
      throw EFORMAT_ROD_SIZE_CHECK(rod_fragment_size_word(),
                   (12 + rod_nstatus() + rod_ndata()));
    }
  }catch(eformat::RODSizeCheckIssue &ex){
    if(exc) throw ex;
    result = false;
  }catch(eformat::SizeCheckIssue &ex){
    if(exc) throw ex;
    result = false;
  }catch(eformat::BadRodVersionIssue &ex){
    if(exc) throw ex;
    result = false;
  }
 
  return result;
}

check_rod_noex()

bool offline_eformat::v40::ROBFragment::check_rod_noex

(

const uint16_t

rod_version = eformat::MAJOR_V31_VERSION

)

const

Says if the underlying ROD fragment is valid.

Does not throw exceptions.

Definition at line 145 of file v40_ROBFragment.cxx.

{
  return this->check_rod_impl(version, false);
}

checksum()

bool offline_eformat::v40::Header::checksum ( void ) const

inherited

This will actually re-calculate the checksum and verify that the payload of the current fragment matches that.

Only works with contiguous memory templates.

Definition at line 128 of file v40_Header.cxx.

{
  return (eval_checksum() == checksum_value());
}

checksum_type()

uint32_t offline_eformat::v40::Header::checksum_type ( ) const

inherited

Returns the check-sum type entry.

Definition at line 97 of file v40_Header.cxx.

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

checksum_value()

uint32_t offline_eformat::v40::Header::checksum_value ( void ) const

inherited

Access the check sum value of this fragment, if any.

Understand that if, checksum_type() resolves to eformat::NO_CHECKSUM, the returned value will have no meaning.

Definition at line 112 of file v40_Header.cxx.

{ 
  return (checksum_type()?m_top[fragment_size_word()-1]:0); 
}

child() [1/2]

virtual void offline_eformat::v40::ROBFragment::child ( const uint32_t *& p, size_t n ) const

inlinevirtual

Definition at line 296 of file v40_ROBFragment.h.

    { p = child(n); }

child() [2/2]

const uint32_t * offline_eformat::v40::ROBFragment::child

(

size_t

n

)

const

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 225 of file v40_ROBFragment.cxx.

{
  if (n == 0) return m_start;
  return 0;
}

children()

uint32_t offline_eformat::v40::ROBFragment::children ( const uint32_t ** 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 231 of file v40_ROBFragment.cxx.

{
  if (max == 0) return 0;
  p[0] = m_start;
  return 1;
}

end() [1/2]

const uint32_t * offline_eformat::v40::Header::end ( ) const

inherited

Sets the pointer to one-past my end position.

Parameters

it	The pointer to set

Definition at line 82 of file v40_Header.cxx.

{ 
  return m_top + fragment_size_word();
}

end() [2/2]

void offline_eformat::v40::Header::end ( const uint32_t *& it ) const

inlineinherited

Definition at line 144 of file v40_Header.h.

{ it = end(); } //legacy

eval_checksum()

uint32_t offline_eformat::v40::Header::eval_checksum ( void ) const

inherited

Evaluates the current (supposed) checksum for this fragment, taking into consideration the current setting for the checksum type.

Please note this value may be different from the actual checksum_value() if for any reason the fragment is corrupted.

Definition at line 123 of file v40_Header.cxx.

{
  return eformat::helper::checksum(checksum_type(), payload(), payload_size_word());
}

fragment_size_word()

uint32_t offline_eformat::v40::Header::fragment_size_word ( ) const

inherited

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

Definition at line 47 of file v40_Header.cxx.

{ 
  return m_top[1]; 
}

header_size_word()

uint32_t offline_eformat::v40::Header::header_size_word ( ) const

inherited

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

That does include the specific part of the header.

Definition at line 52 of file v40_Header.cxx.

{ 
  return m_top[2]; 
}

marker()

uint32_t offline_eformat::v40::Header::marker ( ) const

inherited

Returns the fragment type.

Definition at line 42 of file v40_Header.cxx.

{ 
  return m_top[0]; 
}

nchildren()

uint32_t offline_eformat::v40::ROBFragment::nchildren ( ) const

virtual

Returns the number of children available.

Definition at line 319 of file v40_ROBFragment.cxx.

{ 
  return 1; 
}

nspecific()

uint32_t offline_eformat::v40::Header::nspecific ( ) const

inherited

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

Definition at line 102 of file v40_Header.cxx.

{ 
  return header_size_word() - ( 7 + nstatus() );
}

nstatus()

uint32_t offline_eformat::v40::Header::nstatus ( ) const

inherited

Returns the number of status words available.

Definition at line 67 of file v40_Header.cxx.

{ 
  return m_top[5]; 
}

operator=()

offline_eformat::v40::ROBFragment & offline_eformat::v40::ROBFragment::operator=

(

const ROBFragment &

other

)

Assignment.

Parameters

other

The fragment to be copied

Definition at line 52 of file v40_ROBFragment.cxx.

{
  if (this != &other) {
    Header::operator=(other); 
    m_start=other.m_start;
  }
  return *this; 
}

payload() [1/2]

const uint32_t * offline_eformat::v40::Header::payload ( ) const

inherited

Sets the pointer to where the payload starts.

Parameters

it	The pointer to set

Definition at line 77 of file v40_Header.cxx.

{ 
  return m_top + header_size_word();
}

payload() [2/2]

void offline_eformat::v40::Header::payload ( const uint32_t *& it ) const

inlineinherited

Definition at line 136 of file v40_Header.h.

{ it = payload(); } //legacy

payload_size_word()

uint32_t offline_eformat::v40::Header::payload_size_word ( void ) const

inherited

Returns the payload size.

Definition at line 87 of file v40_Header.cxx.

{ 
  return fragment_size_word() - (header_size_word() + (checksum_type()?1:0)); 
}

problems()

void offline_eformat::v40::ROBFragment::problems	(	std::vector< eformat::FragmentProblem > &	p,
		const uint16_t	version = eformat::MAJOR_V40_VERSION,
		const uint16_t	rod_version = eformat::MAJOR_V31_VERSION ) const

Tells which problemS the current fragment has.

Definition at line 205 of file v40_ROBFragment.cxx.

{
  rob_problems(p, version);
  rod_problems(p, rod_version);
}

rob_problems()

void offline_eformat::v40::ROBFragment::rob_problems	(	std::vector< eformat::FragmentProblem > &	p,
		const uint16_t	version = eformat::MAJOR_V40_VERSION ) const

Tells which problemS the current ROB fragment has.

Definition at line 180 of file v40_ROBFragment.cxx.

{
  //ROB checking
  if (Header::marker() != eformat::ROB)
    p.push_back(eformat::WRONG_MARKER);
  if ( Header::version() >> 16 != version )
    p.push_back(eformat::UNSUPPORTED_VERSION);
  uint32_t calculated = 7 + Header::nstatus();
  if (Header::header_size_word() != calculated)
    p.push_back(eformat::WRONG_FRAGMENT_SIZE);
}

rob_source_id()

uint32_t offline_eformat::v40::ROBFragment::rob_source_id

(

)

const

Gets the source_id of the ROB fragment itself.

Definition at line 254 of file v40_ROBFragment.cxx.

{ 
  return Header::source_id(); 
}

rod_bc_id()

uint32_t offline_eformat::v40::ROBFragment::rod_bc_id

(

)

const

Returns the bunch crossing identifier.

Definition at line 304 of file v40_ROBFragment.cxx.

{ 
  return m_start[6]; 
}

rod_data() [1/2]

const uint32_t * offline_eformat::v40::ROBFragment::rod_data

(

)

const

Returns a pointer to the first data word.

Parameters

it	An updateable iterator you should provide.

Definition at line 219 of file v40_ROBFragment.cxx.

{
  if (!rod_status_position()) return m_start + 9 + rod_nstatus();
  return m_start + 9;
}

rod_data() [2/2]

void offline_eformat::v40::ROBFragment::rod_data ( const uint32_t *& it ) const

inline

Definition at line 272 of file v40_ROBFragment.h.

    { it = rod_data(); }

rod_detev_type()

uint32_t offline_eformat::v40::ROBFragment::rod_detev_type

(

)

const

Returns the detector event type.

Definition at line 314 of file v40_ROBFragment.cxx.

{ 
  return m_start[8]; 
}

rod_fragment_size_word()

uint32_t offline_eformat::v40::ROBFragment::rod_fragment_size_word

(

)

const

Returns the total fragment size.

Definition at line 269 of file v40_ROBFragment.cxx.

{ 
  return Header::payload_size_word();
}

rod_header_size_word()

uint32_t offline_eformat::v40::ROBFragment::rod_header_size_word

(

)

const

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

That does not include the trailer.

Definition at line 274 of file v40_ROBFragment.cxx.

{ 
  return m_start[1]; 
}

rod_lvl1_id()

uint32_t offline_eformat::v40::ROBFragment::rod_lvl1_id

(

)

const

Returns the lvl1 identifier.

Definition at line 299 of file v40_ROBFragment.cxx.

{ 
  return m_start[5]; 
}

rod_lvl1_trigger_type()

uint32_t offline_eformat::v40::ROBFragment::rod_lvl1_trigger_type

(

)

const

Returns the lvl1 trigger type.

Definition at line 309 of file v40_ROBFragment.cxx.

{ 
  return m_start[7]; 
}

rod_marker()

uint32_t offline_eformat::v40::ROBFragment::rod_marker

(

)

const

Returns the fragment type.

Definition at line 264 of file v40_ROBFragment.cxx.

{ 
  return m_start[0]; 
}

rod_ndata()

uint32_t offline_eformat::v40::ROBFragment::rod_ndata

(

)

const

Returns the number of data words available.

Definition at line 244 of file v40_ROBFragment.cxx.

{ 
  return m_start[Header::payload_size_word()-2];
}

rod_nstatus()

uint32_t offline_eformat::v40::ROBFragment::rod_nstatus

(

)

const

Returns the number of status words available.

Definition at line 239 of file v40_ROBFragment.cxx.

{ 
  return m_start[Header::payload_size_word()-3];
}

rod_problems()

void offline_eformat::v40::ROBFragment::rod_problems	(	std::vector< eformat::FragmentProblem > &	p,
		const uint16_t	version = eformat::MAJOR_V31_VERSION ) const

Tells which problemS the underlying ROD fragment has.

Definition at line 193 of file v40_ROBFragment.cxx.

{
  //ROD stuff
  if (rod_marker() != eformat::ROD) p.push_back(eformat::WRONG_ROD_MARKER); 
  if (rod_version() >> 16 != version)
    p.push_back(eformat::UNSUPPORTED_ROD_VERSION);
  if (rod_header_size_word() != 9) p.push_back(eformat::WRONG_ROD_HEADER_SIZE);
  if (rod_fragment_size_word() != 12 + rod_nstatus() + rod_ndata())
    p.push_back(eformat::WRONG_ROD_FRAGMENT_SIZE);
}

rod_run_no()

uint32_t offline_eformat::v40::ROBFragment::rod_run_no

(

)

const

Returns the current run number.

Definition at line 294 of file v40_ROBFragment.cxx.

{ 
  return m_start[4]; 
}

rod_source_id()

uint32_t offline_eformat::v40::ROBFragment::rod_source_id

(

)

const

Returns the source identifier of the ROD fragment.

Definition at line 289 of file v40_ROBFragment.cxx.

{ 
  return m_start[3]; 
}

rod_start() [1/2]

const uint32_t * offline_eformat::v40::ROBFragment::rod_start

(

)

const

Sets the given pointer to the ROD fragment start.

Parameters

it	The pointer to be set to the ROD fragment start

Definition at line 259 of file v40_ROBFragment.cxx.

{ 
  return m_start; 
}

rod_start() [2/2]

void offline_eformat::v40::ROBFragment::rod_start ( const uint32_t *& it ) const

inline

Definition at line 187 of file v40_ROBFragment.h.

    { it = rod_start(); }

rod_status() [1/2]

const uint32_t * offline_eformat::v40::ROBFragment::rod_status

(

)

const

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

Parameters

it	An updateable iterator you should provide.

Definition at line 213 of file v40_ROBFragment.cxx.

{
  if (rod_status_position()) return m_start + 9 + rod_ndata();
  return m_start + 9;
}

rod_status() [2/2]

void offline_eformat::v40::ROBFragment::rod_status ( const uint32_t *& it ) const

inline

Definition at line 258 of file v40_ROBFragment.h.

    { it = rod_status(); }

rod_status_position()

uint32_t offline_eformat::v40::ROBFragment::rod_status_position

(

)

const

Returns the status block position.

A value of zero indicates that the status block preceeds the data block. A value of one means the contrary.

Definition at line 249 of file v40_ROBFragment.cxx.

{ 
  return m_start[Header::payload_size_word()-1];
}

rod_trailer_size_word()

uint32_t offline_eformat::v40::ROBFragment::rod_trailer_size_word

(

)

const

Returns the size, in words, of the trailer.

Definition at line 279 of file v40_ROBFragment.cxx.

{ 
  return 3; 
}

rod_version()

uint32_t offline_eformat::v40::ROBFragment::rod_version

(

)

const

Returns the formatting version for the ROD fragment.

Definition at line 284 of file v40_ROBFragment.cxx.

{ 
  return m_start[2]; 
}

source_id()

uint32_t offline_eformat::v40::Header::source_id ( ) const

inherited

Returns the full source identifier.

Definition at line 62 of file v40_Header.cxx.

{ 
  return m_top[4]; 
}

specific_header() [1/2]

const uint32_t * offline_eformat::v40::Header::specific_header ( ) const

inherited

Returns an iterator to the start of the specific header part.

Parameters

it	An updateable iterator you should provide.

Definition at line 107 of file v40_Header.cxx.

{ 
  return m_top + 7 + nstatus(); 
}

specific_header() [2/2]

void offline_eformat::v40::Header::specific_header ( const uint32_t *& it ) const

inlineinherited

Definition at line 176 of file v40_Header.h.

    { it = specific_header(); }

start() [1/2]

const uint32_t * offline_eformat::v40::Header::start ( ) const

inherited

Sets the pointer to my start.

Parameters

it	The pointer to set

Definition at line 72 of file v40_Header.cxx.

{ 
  return m_top;
}

start() [2/2]

void offline_eformat::v40::Header::start ( const uint32_t *& it ) const

inlineinherited

Definition at line 128 of file v40_Header.h.

{ it = start(); } //legacy

status() [1/2]

const uint32_t * offline_eformat::v40::Header::status ( ) const

inherited

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

Parameters

it	An updateable iterator you should provide.

Definition at line 92 of file v40_Header.cxx.

{ 
  return m_top + 6;
}

status() [2/2]

void offline_eformat::v40::Header::status ( const uint32_t *& it ) const

inlineinherited

Definition at line 157 of file v40_Header.h.

{ it = status(); } //legacy

throws() [1/2]

bool offline_eformat::v40::Header::throws ( ) const

inherited

Says if we are supposed to throw exceptions or not.

throws() [2/2]

void offline_eformat::v40::Header::throws ( bool b )

inherited

If you set this parameter, objects of this type will throw exceptions.

The default behavior is to throw.

version()

uint32_t offline_eformat::v40::Header::version ( ) const

inherited

Returns the formatting version.

Definition at line 57 of file v40_Header.cxx.

{ 
  return m_top[3]; 
}

Member Data Documentation

m_start

const uint32_t* offline_eformat::v40::ROBFragment::m_start

private

my one-after-the-last word

Definition at line 313 of file v40_ROBFragment.h.

m_top

const uint32_t* offline_eformat::v40::Header::m_top

privateinherited

< representation

my start word

Definition at line 203 of file v40_Header.h.

---

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

• v40_ROBFragment.h
• v40_ROBFragment.cxx