eformat::write::SubDetectorFragment Class Reference

forward More...

#include <SubDetectorFragment.h>

Public Member Functions
	SubDetectorFragment (uint32_t source_id)
	SubDetectorFragment (uint32_t *sd)
	SubDetectorFragment (eformat::write::node_t *sd)
	SubDetectorFragment ()
	SubDetectorFragment (const SubDetectorFragment &other)
virtual	~SubDetectorFragment ()
SubDetectorFragment &	operator= (const SubDetectorFragment &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
uint32_t	meta_size_word (void) const
uint32_t	size_word (void) const
void	append (eformat::write::ROSFragment *ros)
const ROSFragment *	first_child (void) const
void	size_change (uint32_t o, uint32_t n)
const FullEventFragment *	parent (void) const
void	parent (eformat::write::FullEventFragment *fe)
const SubDetectorFragment *	next (void) const
void	next (const SubDetectorFragment *n)
uint32_t	page_count (void) const
const eformat::write::node_t *	bind (void)

Detailed Description

forward

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

Definition at line 27 of file write/SubDetectorFragment.h.

Constructor & Destructor Documentation

SubDetectorFragment() [1/5]

eformat::write::SubDetectorFragment::SubDetectorFragment

(

uint32_t

source_id

)

Builds a new SubDetector fragment from scratch

Parameters

source_id

The source identifier to be using for this SubDetector

Definition at line 19 of file SubDetectorFragment.cxx.

  : m_parent(0),
    m_child(0),
    m_last(0),
    m_next(0),
    m_extra_count(0)
{
  m_header[0] = eformat::SUB_DETECTOR; //marker
  m_header[1] = 8; //this header size + status size
  m_header[2] = 8; //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] = 0; //number of fragment specific
 
  //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], 1, 0);
  ERS_DEBUG_3("%s Source Id. = 0x%x.", 
          "Built (write) subdetector from scratch, with", 
          SubDetectorFragment::source_id());
}

SubDetectorFragment() [2/5]

eformat::write::SubDetectorFragment::SubDetectorFragment

(

uint32_t *

sd

)

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

Parameters

sd	The existing SubDetector fragment

Definition at line 67 of file SubDetectorFragment.cxx.

  : m_parent(0),
    m_child(0),
    m_last(0),
    m_next(0),
    m_extra_count(0)
{
  //now initialize pages
  set(m_node[0], sd, 6, &m_node[1]);
  set(m_node[1], &sd[6], sd[5], &m_node[2]);
  set(m_node[2], &sd[6+sd[5]], 1, &m_extra);
  eformat::write::set(m_extra, &sd[7+sd[5]], sd[1]-sd[2], 0);
  ++m_extra_count;
  ERS_DEBUG_3("%s Source Id. = 0x%x.", 
          "Built (write) subdetector from contiguous memory, with",
          source_id());
}

SubDetectorFragment() [3/5]

eformat::write::SubDetectorFragment::SubDetectorFragment

(

eformat::write::node_t *

sd

)

Builds a new SubDetector fragment from an existing SubDetector 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 ROS header marker). The following data can be spread around.

Parameters

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

Definition at line 85 of file SubDetectorFragment.cxx.

  : m_parent(0),
    m_child(0),
    m_last(0),
    m_next(0),
    m_extra_count(0)
{
  //now initialize pages
  set(m_node[0], sd->base, 6, &m_node[1]);
  set(m_node[1], &sd->base[6], sd->base[5], &m_node[2]);
  set(m_node[2], &sd->base[6+sd->base[5]], 1, &m_extra);
  eformat::write::set(m_extra, &sd->base[7+sd->base[5]],
              sd->size_word - sd->base[2], sd->next);
  m_extra_count += eformat::write::count(m_extra);
  ERS_DEBUG_3("%s Source Id. = 0x%x.", 
          "Built (write) subdetector from paged memory, with", 
          source_id());
}

SubDetectorFragment() [4/5]

eformat::write::SubDetectorFragment::SubDetectorFragment

(

)

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

Definition at line 43 of file SubDetectorFragment.cxx.

  : m_parent(0),
    m_child(0),
    m_last(0),
    m_next(0),
    m_extra_count(0)
{
  m_header[0] = eformat::SUB_DETECTOR; //marker
  m_header[1] = 8; //this header size + status size
  m_header[2] = 8; //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] = 0; //number of fragment specific
 
  //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], 1, 0);
  ERS_DEBUG_3("%s Source Id. = 0x%x.", 
          "Built empty (write) subdetector from scratch, with", 
          SubDetectorFragment::source_id());
}

SubDetectorFragment() [5/5]

eformat::write::SubDetectorFragment::SubDetectorFragment

(

const SubDetectorFragment &

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 105 of file SubDetectorFragment.cxx.

  : 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.", 
          "Built (write) subdetector from copy, with", 
          source_id());
}

~SubDetectorFragment()

virtual eformat::write::SubDetectorFragment::~SubDetectorFragment ( )

inlinevirtual

Base destructor

Definition at line 81 of file write/SubDetectorFragment.h.

{}

Member Function Documentation

append()

void eformat::write::SubDetectorFragment::append

(

eformat::write::ROSFragment *

ros

)

Appends a new ROS fragment to this SubDetector fragment.

Warning

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

Parameters

ros	The ROS fragment to be appended to myself

Definition at line 159 of file SubDetectorFragment.cxx.

{
  ERS_DEBUG_3("%s Source Id. = 0x%x to subdetector with Source Id. = 0x%x", 
          "Appending ros fragment with",
          ros->source_id(), source_id());
  ros->parent(this);
  uint32_t old_size = m_node[0].base[1];
  m_node[0].base[1] += ros->size_word();
 
  //adjust `m_last' and `m_child' to point to the new last ROB
  if (m_last) m_last->next(ros);
  else m_child = ros;
  m_last = ros;
 
  //propagate changes to my parent
  if (m_parent) m_parent->size_change(old_size, m_node[0].base[1]);
}

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

bind()

const eformat::write::node_t * eformat::write::SubDetectorFragment::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 187 of file SubDetectorFragment.cxx.

{
  //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 (ROSFragment* curr = m_child; curr; 
       curr = const_cast<ROSFragment*>(curr->next())) {
    last->next = const_cast<eformat::write::node_t*>(curr->bind());
    while (last->next) last = last->next; //advance until end
  }
  return m_node;
}

first_child()

const ROSFragment * eformat::write::SubDetectorFragment::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 178 of file write/SubDetectorFragment.h.

{ return m_child; }

Referenced by PackedRawDataCnvSvc::commitOutput().

meta_size_word()

uint32_t eformat::write::SubDetectorFragment::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 149 of file write/SubDetectorFragment.h.

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

minor_version() [1/2]

void eformat::write::SubDetectorFragment::minor_version ( uint16_t v )

inline

Changes the minor version number of the fragment

Parameters

s	The new minor version for this header

Definition at line 121 of file write/SubDetectorFragment.h.

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

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

minor_version() [2/2]

uint16_t eformat::write::SubDetectorFragment::minor_version ( void ) const

inline

Returns the minor version number of the fragment

Definition at line 127 of file write/SubDetectorFragment.h.

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

next() [1/2]

void eformat::write::SubDetectorFragment::next ( const SubDetectorFragment * n )

inline

Sets the next sibling

Parameters

n	The sibling following this fragment

Definition at line 213 of file write/SubDetectorFragment.h.

{ m_next = n; }

next() [2/2]

const SubDetectorFragment * eformat::write::SubDetectorFragment::next ( void ) const

inline

Returns the next sibling

Definition at line 206 of file write/SubDetectorFragment.h.

{ return m_next; }

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

nstatus()

uint32_t eformat::write::SubDetectorFragment::nstatus ( void ) const

inline

Returns the number of status wors in this fragment

Definition at line 109 of file write/SubDetectorFragment.h.

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

operator=()

eformat::write::SubDetectorFragment & eformat::write::SubDetectorFragment::operator=

(

const SubDetectorFragment &

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 120 of file SubDetectorFragment.cxx.

{
  memcpy(reinterpret_cast<void*>(m_header),
     reinterpret_cast<const void*>(other.m_node[0].base), 
     6*sizeof(uint32_t));
  m_header[6] = other.m_node[2].base[0];
 
  //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], 1, 0);
  ERS_DEBUG_3("%s Source Id. = 0x%x.",
          "Copied (write) subdetector with",
          SubDetectorFragment::source_id());
  return *this;
}

page_count()

uint32_t eformat::write::SubDetectorFragment::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 178 of file SubDetectorFragment.cxx.

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

Referenced by eformat::write::FullEventFragment::page_count().

parent() [1/2]

void eformat::write::SubDetectorFragment::parent ( eformat::write::FullEventFragment * fe )

inline

This sets the parent fragment

Parameters

fe	The FullEventFragment parent fragment of this SubDetector

Definition at line 200 of file write/SubDetectorFragment.h.

      { m_parent = fe; }

parent() [2/2]

const FullEventFragment * eformat::write::SubDetectorFragment::parent ( void ) const

inline

This returns the parent fragment

Definition at line 192 of file write/SubDetectorFragment.h.

      { return m_parent; }

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

size_change()

void eformat::write::SubDetectorFragment::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 151 of file SubDetectorFragment.cxx.

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

Referenced by status().

size_word()

uint32_t eformat::write::SubDetectorFragment::size_word ( void ) const

inline

Returns the total size for this fragment, in words

Definition at line 155 of file write/SubDetectorFragment.h.

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

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

source_id() [1/2]

void eformat::write::SubDetectorFragment::source_id ( uint32_t s )

inline

Changes the source identifier for this fragment

Parameters

s	The new value to set

Definition at line 135 of file write/SubDetectorFragment.h.

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

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

source_id() [2/2]

uint32_t eformat::write::SubDetectorFragment::source_id ( void ) const

inline

Returns the source identifier of this fragment

Definition at line 141 of file write/SubDetectorFragment.h.

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

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

status() [1/2]

void eformat::write::SubDetectorFragment::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 the underlying SubDetectorFragment fragment supposed to have.
status	A pointer to n pre-allocated words

Definition at line 138 of file SubDetectorFragment.cxx.

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

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

status() [2/2]

const uint32_t * eformat::write::SubDetectorFragment::status ( void ) const

inline

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

Definition at line 114 of file write/SubDetectorFragment.h.

{ return m_node[1].base; }

---

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

• write/SubDetectorFragment.h
• SubDetectorFragment.cxx