eformat::write::ROSFragment Class Reference

forward More...

#include <ROSFragment.h>

List of all members.

Public Member Functions
	ROSFragment (uint32_t source_id, uint32_t run_no, uint32_t lvl1_id, uint32_t bc_id)
	ROSFragment (uint32_t *ros)
	ROSFragment (eformat::write::node_t *ros)
	ROSFragment ()
	ROSFragment (const ROSFragment &other)
virtual	~ROSFragment ()
ROSFragment &	operator= (const ROSFragment &other)
void	status (uint32_t n, const uint32_t *status)
uint32_t	nstatus (void) const
const uint32_t *	status (void) const
void	minor_version (uint16_t v)
uint16_t	minor_version (void) const
void	source_id (uint32_t s)
uint32_t	source_id (void) const
void	run_no (uint32_t s)
uint32_t	run_no (void) const
void	lvl1_id (uint32_t s)
uint32_t	lvl1_id (void) const
void	bc_id (uint32_t s)
uint32_t	bc_id (void) const
uint32_t	meta_size_word (void) const
uint32_t	size_word (void) const
void	append (eformat::write::ROBFragment *rob)
const ROBFragment *	first_child (void) const
void	size_change (uint32_t o, uint32_t n)
const SubDetectorFragment *	parent (void) const
void	parent (eformat::write::SubDetectorFragment *sd)
const ROSFragment *	next (void) const
void	next (const ROSFragment *n)
uint32_t	page_count (void) const
const eformat::write::node_t *	bind (void)
const eformat::write::node_t *	extra (void)
Private Attributes
uint32_t	m_header [10]
	The ROS Header.
eformat::write::node_t	m_node [3]
	Node representation.
eformat::write::SubDetectorFragment *	m_parent
	my parent
eformat::write::ROBFragment *	m_child
	my ROB children
eformat::write::ROBFragment *	m_last
	my last ROB child
const eformat::write::ROSFragment *	m_next
	Next sibling.
eformat::write::node_t	m_extra
	Extra pages I may have.
uint32_t	m_extra_count
	How many extra pages I have.

---

Detailed Description

forward

Defines a helper class to aid the creation of ROS fragments.

Definition at line 27 of file ROSFragment.h.

---

Constructor & Destructor Documentation

eformat::write::ROSFragment::ROSFragment	(	uint32_t	source_id,
		uint32_t	run_no,
		uint32_t	lvl1_id,
		uint32_t	bc_id
	)

Builds a new ROS fragment from scratch

Parameters:

	source_id	The source identifier to be using for this ROS
	run_no	The run number for this ROS
	lvl1_id	The LVL1 identifier for this ROS
	bc_id	The bunch crossing identifier for this ROS

Definition at line 20 of file ROSFragment.cxx.

References eformat::DEFAULT_STATUS, eformat::DEFAULT_VERSION, ERS_DEBUG_3, eformat::ROS, and eformat::write::set().

  : m_parent(0),
    m_child(0),
    m_last(0),
    m_next(0),
    m_extra_count(0)
{
  m_header[0] = eformat::ROS; //marker
  m_header[1] = 11; //this header size + status size
  m_header[2] = 11; //this header size + status size
  m_header[3] = eformat::DEFAULT_VERSION; //format version
  m_header[4] = source_id;
  m_header[5] = 1; //number of status
  m_header[6] = 3; //number of fragment specific
  m_header[7] = run_no;
  m_header[8] = lvl1_id;
  m_header[9] = bc_id;

  //now initialize pages
  set(m_node[0], m_header, 6, &m_node[1]);
  set(m_node[1], &eformat::DEFAULT_STATUS, 1, &m_node[2]);
  set(m_node[2], &m_header[6], 4, 0);
  ERS_DEBUG_3("%s Source Id. = 0x%x., LVL1 Id. = %d, Run Number = %d", 
              "Built (write) ros fragment from scratch, with", 
              ROSFragment::source_id(), ROSFragment::lvl1_id(), 
              ROSFragment::run_no());
}

eformat::write::ROSFragment::ROSFragment

(

uint32_t *

ros

)

Builds a new ROS fragment from an existing ROS fragment in contiguous memory.

Parameters:

ros

The existing ROS fragment

Definition at line 48 of file ROSFragment.cxx.

References ERS_DEBUG_3, lvl1_id(), m_extra, m_extra_count, m_node, run_no(), eformat::write::set(), and source_id().

  : m_parent(0),
    m_child(0),
    m_last(0),
    m_next(0),
    m_extra_count(0)
{
  //now initialize pages
  set(m_node[0], ros, 6, &m_node[1]);
  set(m_node[1], &ros[6], ros[5], &m_node[2]);
  set(m_node[2], &ros[6+ros[5]], 4, &m_extra);
  eformat::write::set(m_extra, &ros[10+ros[5]], ros[1]-ros[2]);
  ++m_extra_count;
  ERS_DEBUG_3("%s Source Id. = 0x%x., LVL1 Id. = %d, Run Number = %d", 
              "Built (write) ros fragment from contiguous memory, with", 
              source_id(), lvl1_id(), run_no());
}

eformat::write::ROSFragment::ROSFragment

(

eformat::write::node_t *

ros

)

Builds a new ROS fragment from an existing ROS fragment in non-contiguous memory. The top-level fragment header is expected to be on a contiguous area of memory, together with the first word of the first child fragment (i.e. the ROB header marker). The following data can be spread around.

Parameters:

ros

The existing ROS fragment, as a list of nodes, pre-concatenated by the caller.

Definition at line 66 of file ROSFragment.cxx.

References eformat::write::node_t::base, eformat::write::count(), ERS_DEBUG_3, lvl1_id(), m_extra, m_extra_count, m_node, eformat::write::node_t::next, run_no(), eformat::write::set(), eformat::write::node_t::size_word, and source_id().

  : m_parent(0),
    m_child(0),
    m_last(0),
    m_next(0),
    m_extra_count(0)
{
  //now initialize pages
  set(m_node[0], ros->base, 6, &m_node[1]);
  set(m_node[1], &ros->base[6], ros->base[5], &m_node[2]);
  set(m_node[2], &ros->base[6+ros->base[5]], 4, &m_extra);
  eformat::write::set(m_extra, &ros->base[10+ros->base[5]],
                      ros->size_word - ros->base[2], ros->next);
  m_extra_count += eformat::write::count(m_extra);
  ERS_DEBUG_3("%s Source Id. = 0x%x., LVL1 Id. = %d, Run Number = %d", 
              "Built (write) ros fragment from paged memory, with", 
              source_id(), lvl1_id(), run_no());
}

eformat::write::ROSFragment::ROSFragment

(

)

Builds a new empty ROS fragment, otherwise invalid. This is useful for array builds and standard containers.

Definition at line 85 of file ROSFragment.cxx.

References eformat::DEFAULT_STATUS, eformat::DEFAULT_VERSION, ERS_DEBUG_3, lvl1_id(), m_header, m_node, eformat::ROS, run_no(), eformat::write::set(), and source_id().

  : m_parent(0),
    m_child(0),
    m_last(0),
    m_next(0),
    m_extra_count(0)
{
  m_header[0] = eformat::ROS; //marker
  m_header[1] = 11; //this header size + status size
  m_header[2] = 11; //this header size + status size
  m_header[3] = eformat::DEFAULT_VERSION; //format version
  m_header[4] = 0; //source identifier
  m_header[5] = 1; //number of status
  m_header[6] = 3; //number of fragment specific
  m_header[7] = 0; //run number
  m_header[8] = 0; //LVL1 identifier
  m_header[9] = 0; //bunch crossing identifier

  //now initialize pages
  set(m_node[0], m_header, 6, &m_node[1]);
  set(m_node[1], &eformat::DEFAULT_STATUS, 1, &m_node[2]);
  set(m_node[2], &m_header[6], 4, 0);
  ERS_DEBUG_3("%s Source Id. = 0x%x., LVL1 Id. = %d, Run Number = %d", 
              "Built empty (write) ros fragment from scratch, with", 
              ROSFragment::source_id(), ROSFragment::lvl1_id(), 
              ROSFragment::run_no());
}

eformat::write::ROSFragment::ROSFragment

(

const ROSFragment &

other

)

Copy constructor. This will only copy the meta data, not the fragment relationships and block-data (children, parent and status block) contained in the to-be-copied fragment. If you wish this fragment has the same parents, and children of the copied fragment, you have to do this operation manually, after copying. If you wish to make a copy of the status as well, do it manually and then assign it to this fragment using the status() method.

Parameters:

other

The other fragment to take the meta data from.

Definition at line 114 of file ROSFragment.cxx.

References ERS_DEBUG_3, lvl1_id(), EvtCyclic3::other(), run_no(), and source_id().

  : m_parent(0),
    m_child(0),
    m_last(0),
    m_next(0),
    m_extra_count(0)
{
  *this = other;
  ERS_DEBUG_3("%s Source Id. = 0x%x., LVL1 Id. = %d, Run Number = %d", 
              "Built (write) ros fragment from copy, with", 
              ROSFragment::source_id(), ROSFragment::lvl1_id(),
              ROSFragment::run_no());
}

virtual eformat::write::ROSFragment::~ROSFragment

(

)

[inline, virtual]

Base destructor

Definition at line 84 of file ROSFragment.h.

{}

---

Member Function Documentation

void eformat::write::ROSFragment::append

(

eformat::write::ROBFragment *

rob

)

Appends a new ROB fragment to this ROS fragment.

Warning:

This will change the page structure of the last ROB fragment inserted here, in order to concatenate the ROB fragments together. Please note that this operation is not compatible with multiple threads of operation, if you would like to share eformat::write::ROBFragment's between threads. A better strategy would be create, for every thread of operation, a proper ROBFragment instead.

Parameters:

rob

The ROB fragment to be appended to myself

Definition at line 169 of file ROSFragment.cxx.

References eformat::write::node_t::base, ERS_DEBUG_3, m_child, m_last, m_node, m_parent, eformat::write::ROBFragment::next(), eformat::write::ROBFragment::parent(), eformat::write::SubDetectorFragment::size_change(), eformat::write::ROBFragment::size_word(), source_id(), and eformat::write::ROBFragment::source_id().

Referenced by Builder::append2event(), and eformat::old::convert().

{
  ERS_DEBUG_3("%s Source Id. = 0x%x to ros fragment with Source Id. = 0x%x", 
              "Appending rob fragment with",
              rob->source_id(), source_id());
  rob->parent(this);
  uint32_t old_size = m_node[0].base[1];
  m_node[0].base[1] += rob->size_word();

  //adjust `m_last' and `m_child' to point to the new last ROB
  if (m_last) m_last->next(rob);
  else m_child = rob;
  m_last = rob;

  //propagate changes to my parent
  if (m_parent) m_parent->size_change(old_size, m_node[0].base[1]);
}

uint32_t eformat::write::ROSFragment::bc_id

(

void

)

const [inline]

Returns the bunch crossing identifier for this fragment

Definition at line 185 of file ROSFragment.h.

References eformat::write::node_t::base, and m_node.

      { return m_node[2].base[3]; }

void eformat::write::ROSFragment::bc_id

(

uint32_t

s

)

[inline]

Changes the bunch crossing identifier in this fragment

Parameters:

s

The new value to set

Definition at line 179 of file ROSFragment.h.

References eformat::write::node_t::base, and m_node.

      { m_node[2].base[3] = s; }

const eformat::write::node_t * eformat::write::ROSFragment::bind

(

void

)

Returns the first node of a list of nodes that represent the fragment you have constructed. To make use of it, just browse the list as defined in node.h

Definition at line 195 of file ROSFragment.cxx.

References m_child, m_extra, m_extra_count, m_node, eformat::write::ROBFragment::next(), and eformat::write::node_t::next.

{
  //the header is already concatenated by construction
  eformat::write::node_t* last = &m_node[2];
  if (m_extra_count) {
    last = &m_extra;
    while (last->next) last = last->next;
  }
  for (const ROBFragment* curr = m_child; curr; curr = curr->next()) {
    last->next = const_cast<eformat::write::node_t*>(curr->bind());
    while (last->next) last = last->next; //advance until end
  }
  return m_node;
}

const eformat::write::node_t* eformat::write::ROSFragment::extra

(

void

)

[inline]

Return the extra node of the fragment for OHFiller_write. lifei

Definition at line 281 of file ROSFragment.h.

{return & m_extra;};

const ROBFragment* eformat::write::ROSFragment::first_child

(

void

)

const [inline]

This returns the first child of this fragment. The system operates as a concatenated list of fragments. From this child you can get to the next.

Definition at line 222 of file ROSFragment.h.

References m_child.

Referenced by PackedRawDataCnvSvc::commitOutput().

{ return m_child; }

uint32_t eformat::write::ROSFragment::lvl1_id

(

void

)

const [inline]

Returns the lvl1 identifier for this fragment

Definition at line 171 of file ROSFragment.h.

References eformat::write::node_t::base, and m_node.

Referenced by operator=(), and ROSFragment().

      { return m_node[2].base[2]; }

void eformat::write::ROSFragment::lvl1_id

(

uint32_t

s

)

[inline]

Changes the lvl1 identifier in this fragment

Parameters:

s

The new value to set

Definition at line 165 of file ROSFragment.h.

References eformat::write::node_t::base, and m_node.

      { m_node[2].base[2] = s; }

uint32_t eformat::write::ROSFragment::meta_size_word

(

void

)

const [inline]

Returns the total size for the meta data (everything that does not encompass the contents of the m_data pointer in the private representation of this class) in the fragment, in words

Definition at line 193 of file ROSFragment.h.

References eformat::write::node_t::base, and m_node.

      { return m_node[0].base[2]; }

uint16_t eformat::write::ROSFragment::minor_version

(

void

)

const [inline]

Returns the minor version number of the fragment

Definition at line 129 of file ROSFragment.h.

References eformat::write::node_t::base, and m_node.

      { return 0xffff & m_node[0].base[3]; }

void eformat::write::ROSFragment::minor_version

(

uint16_t

v

)

[inline]

Changes the minor version number of the fragment

Parameters:

v

The new minor version for this header

Definition at line 123 of file ROSFragment.h.

References eformat::write::node_t::base, eformat::DEFAULT_VERSION, and m_node.

Referenced by eformat::old::convert().

      { m_node[0].base[3] = eformat::DEFAULT_VERSION | v; }

void eformat::write::ROSFragment::next

(

const ROSFragment *

n

)

[inline]

Sets the next sibling

Parameters:

n

The sibling following this fragment

Definition at line 257 of file ROSFragment.h.

References m_next.

{ m_next = n; }

const ROSFragment* eformat::write::ROSFragment::next

(

void

)

const [inline]

Returns the next sibling

Definition at line 250 of file ROSFragment.h.

References m_next.

Referenced by PackedRawDataCnvSvc::commitOutput(), and eformat::write::SubDetectorFragment::page_count().

{ return m_next; }

uint32_t eformat::write::ROSFragment::nstatus

(

void

)

const [inline]

Returns the number of status wors in this fragment

Definition at line 111 of file ROSFragment.h.

References eformat::write::node_t::base, and m_node.

{ return m_node[0].base[5]; }

eformat::write::ROSFragment & eformat::write::ROSFragment::operator=

(

const ROSFragment &

other

)

Assigment operator. This will only copy the meta data, not the fragment relationships and block-data (children and parent and status block) contained in the to-be-copied fragment. If you wish this fragment has the same parents, and children of the copied fragment, you have to do this operation manually, after copying. If you wish to make a copy of the status as well, do it manually and then assign it to this fragment using the status() method.

Parameters:

other

The other fragment to take the meta data from.

Definition at line 129 of file ROSFragment.cxx.

References ERS_DEBUG_3, lvl1_id(), EvtCyclic3::other(), run_no(), eformat::write::set(), and source_id().

{
  memcpy(reinterpret_cast<void*>(m_header),
         reinterpret_cast<const void*>(other.m_node[0].base), 
         6*sizeof(uint32_t));
  memcpy(reinterpret_cast<void*>(m_header+6),
         reinterpret_cast<const void*>(other.m_node[2].base),
         4*sizeof(uint32_t));

  //now initialize pages
  set(m_node[0], m_header, 6, &m_node[1]);
  set(m_node[1], other.m_node[1].base, other.m_node[1].size_word, &m_node[2]);
  set(m_node[2], &m_header[6], 4, 0);
  ERS_DEBUG_3("%s Source Id. = 0x%x., LVL1 Id. = %d, Run Number = %d", 
              "Copied (write) ros fragment, with", 
              ROSFragment::source_id(), ROSFragment::lvl1_id(),
              ROSFragment::run_no());
  return *this;
}

uint32_t eformat::write::ROSFragment::page_count

(

void

)

const

Returns the total number of (raw memory) pages this fragment is composed of.

Warning:

This operation navigates at a potentially large list of child page nodes (for a full ATLAS event this should be bigger than 2,000 pages when built from scratch). If you don't do your bookkeeping, avoid calling this too often.

Definition at line 187 of file ROSFragment.cxx.

References m_child, m_extra_count, and eformat::write::ROBFragment::next().

{
  uint32_t retval = 3 + m_extra_count;
  for (const ROBFragment* curr = m_child; curr; curr = curr->next())
    retval += curr->page_count();
  return retval;
}

void eformat::write::ROSFragment::parent

(

eformat::write::SubDetectorFragment *

sd

)

[inline]

This sets the parent fragment

Parameters:

sd

The SubDetectorFragment parent fragment of this ROS

Definition at line 244 of file ROSFragment.h.

References m_parent.

      { m_parent = sd; }

const SubDetectorFragment* eformat::write::ROSFragment::parent

(

void

)

const [inline]

This returns the parent fragment

Definition at line 236 of file ROSFragment.h.

References m_parent.

Referenced by eformat::write::SubDetectorFragment::append().

      { return m_parent; }

uint32_t eformat::write::ROSFragment::run_no

(

void

)

const [inline]

Returns the run number for this fragment

Definition at line 157 of file ROSFragment.h.

References eformat::write::node_t::base, and m_node.

Referenced by operator=(), and ROSFragment().

      { return m_node[2].base[1]; }

void eformat::write::ROSFragment::run_no

(

uint32_t

s

)

[inline]

Changes the run number

Parameters:

s

The new value to set

Definition at line 151 of file ROSFragment.h.

References eformat::write::node_t::base, and m_node.

      { m_node[2].base[1] = s; }

void eformat::write::ROSFragment::size_change	(	uint32_t	o,
		uint32_t	n
	)

This method is used by children of this fragment to notify fragment size changes.

Parameters:

	o	The old size, in 32-bit words
	n	The new size, in 32-bit words

Definition at line 161 of file ROSFragment.cxx.

References eformat::write::node_t::base, m_node, m_parent, and eformat::write::SubDetectorFragment::size_change().

Referenced by eformat::write::ROBFragment::rod_data(), eformat::write::ROBFragment::rod_status(), and eformat::write::ROBFragment::status().

{ 
  uint32_t old_size = m_node[0].base[1];
  m_node[0].base[1] -= o;
  m_node[0].base[1] += n;
  if (m_parent) m_parent->size_change(old_size, m_node[0].base[1]);
}

uint32_t eformat::write::ROSFragment::size_word

(

void

)

const [inline]

Returns the total size for this fragment, in words

Definition at line 199 of file ROSFragment.h.

References eformat::write::node_t::base, and m_node.

Referenced by eformat::write::SubDetectorFragment::append().

      { return m_node[0].base[1]; }

uint32_t eformat::write::ROSFragment::source_id

(

void

)

const [inline]

Returns the source identifier for this fragment

Definition at line 143 of file ROSFragment.h.

References eformat::write::node_t::base, and m_node.

Referenced by append(), operator=(), and ROSFragment().

      { return m_node[0].base[4]; }

void eformat::write::ROSFragment::source_id

(

uint32_t

s

)

[inline]

Changes the source identifier for this fragment

Parameters:

s

The new value to set

Definition at line 137 of file ROSFragment.h.

References eformat::write::node_t::base, and m_node.

Referenced by eformat::write::SubDetectorFragment::append().

      { m_node[0].base[4] = s; }

const uint32_t* eformat::write::ROSFragment::status

(

void

)

const [inline]

Returns a pointer to the first status word to be used by this fragment

Definition at line 116 of file ROSFragment.h.

References eformat::write::node_t::base, and m_node.

{ return m_node[1].base; }

void eformat::write::ROSFragment::status	(	uint32_t	n,
		const uint32_t *	status
	)

Changes the number of status words and the status words themselves from the fragment

Parameters:

	n	How many status words this fragment is supposed to have.
	status	A pointer to n pre-allocated words

Definition at line 149 of file ROSFragment.cxx.

References eformat::write::node_t::base, m_node, m_parent, eformat::write::SubDetectorFragment::size_change(), and eformat::write::node_t::size_word.

Referenced by Builder::append2event(), and eformat::old::convert().

{
  if (m_parent) m_parent->size_change(m_node[0].base[1], 
                                      m_node[0].base[1]-m_node[0].base[5]+n);
  m_node[0].base[1] -= m_node[0].base[5]; //remove count from previous status
  m_node[0].base[2] -= m_node[0].base[5]; //remove count from previous status
  m_node[1].size_word = m_node[0].base[5] = n; //set new values
  m_node[0].base[1] += n;
  m_node[0].base[2] += n;
  m_node[1].base = const_cast<uint32_t*>(status);
}

---

Member Data Documentation

eformat::write::ROBFragment* eformat::write::ROSFragment::m_child [private]

my ROB children

Definition at line 288 of file ROSFragment.h.

Referenced by append(), bind(), first_child(), and page_count().

eformat::write::node_t eformat::write::ROSFragment::m_extra [private]

Extra pages I may have.

Definition at line 291 of file ROSFragment.h.

Referenced by bind(), and ROSFragment().

uint32_t eformat::write::ROSFragment::m_extra_count [private]

How many extra pages I have.

Definition at line 292 of file ROSFragment.h.

Referenced by bind(), page_count(), and ROSFragment().

uint32_t eformat::write::ROSFragment::m_header[10] [private]

The ROS Header.

Definition at line 281 of file ROSFragment.h.

Referenced by ROSFragment().

eformat::write::ROBFragment* eformat::write::ROSFragment::m_last [private]

my last ROB child

Definition at line 289 of file ROSFragment.h.

Referenced by append().

const eformat::write::ROSFragment* eformat::write::ROSFragment::m_next [private]

Next sibling.

Definition at line 290 of file ROSFragment.h.

Referenced by next().

eformat::write::node_t eformat::write::ROSFragment::m_node[3] [private]

Node representation.

Definition at line 286 of file ROSFragment.h.

Referenced by append(), bc_id(), bind(), lvl1_id(), meta_size_word(), minor_version(), nstatus(), ROSFragment(), run_no(), size_change(), size_word(), source_id(), and status().

eformat::write::SubDetectorFragment* eformat::write::ROSFragment::m_parent [private]

my parent

Definition at line 287 of file ROSFragment.h.

Referenced by append(), parent(), size_change(), and status().

---