Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

eformat::SubDetectorFragment< TPointer > Class Template Reference

#include <SubDetectorFragment.h>

Inheritance diagram for eformat::SubDetectorFragment< TPointer >:

eformat::Header< TPointer > eformat::Header< TPointer > List of all members.

Public Member Functions

Header & assign (const TPointer &it, uint32_t match)
SubDetectorFragment & assign (const TPointer &it)
SubDetectorFragment & assign (const TPointer &it)
virtual bool check () const
virtual bool check () const
bool check_tree () const
bool check_tree () const
virtual void child (TPointer &p, size_t n) const
virtual void child (TPointer &p, size_t n) const
virtual void child_check (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
virtual uint32_t children (TPointer *p, size_t max) const
void end (TPointer &it) const
void end (TPointer &it) const
uint32_t fragment_size_word () const
uint32_t fragment_size_word () const
uint32_t header_size_word () const
uint32_t header_size_word () const
uint32_t marker () const
uint32_t marker () const
virtual uint32_t nchildren () const
virtual uint32_t nchildren () const
uint32_t nspecific () const
uint32_t nspecific () const
uint32_t nstatus () const
uint32_t nstatus () const
SubDetectorFragment & operator= (const SubDetectorFragment &other)
SubDetectorFragment & operator= (const SubDetectorFragment &other)
void payload (TPointer &it) const
void payload (TPointer &it) const
uint32_t payload_size_word (void) const
uint32_t payload_size_word (void) const
uint32_t source_id () const
uint32_t source_id () const
void specific_header (TPointer &it) const
void specific_header (TPointer &it) const
void start (TPointer &it) const
void start (TPointer &it) const
void status (TPointer &it) const
void status (TPointer &it) const
 SubDetectorFragment (const SubDetectorFragment &other)
 SubDetectorFragment ()
 SubDetectorFragment (const TPointer &it)
 SubDetectorFragment (const SubDetectorFragment &other)
 SubDetectorFragment ()
 SubDetectorFragment (const TPointer &it)
uint32_t version () const
uint32_t version () const
virtual ~SubDetectorFragment ()
virtual ~SubDetectorFragment ()

Private Attributes

TPointer m_start
 my start word

Static Private Attributes

const uint32_t NSPECIFIC = 0

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.

Constructor & Destructor Documentation

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. 
00102   : eformat::Header<TPointer>(it, eformat::SUB_DETECTOR),
00103     m_start()
00104 {
00105   specific_header(m_start);
00106 }

template<class TPointer>
eformat::SubDetectorFragment< TPointer >::SubDetectorFragment (   )  [inline]
 

Builds an empty, otherwise useless SubDetectorFragment 

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

template<class TPointer>
eformat::SubDetectorFragment< TPointer >::SubDetectorFragment (  const SubDetectorFragment< TPointer > &  other  )  [inline]
 

Copy constructor

Parameters:
other The fragment to be copied 
00052       : Header<TPointer>(other), m_start(other.m_start) {}

template<class TPointer>
virtual eformat::SubDetectorFragment< TPointer >::~SubDetectorFragment (   )  [inline, virtual]
 

Destructor virtualisation 

00057 {}

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.

template<class TPointer>
eformat::SubDetectorFragment< TPointer >::SubDetectorFragment (   )  [inline]
 

Builds an empty, otherwise useless SubDetectorFragment 

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

template<class TPointer>
eformat::SubDetectorFragment< TPointer >::SubDetectorFragment (  const SubDetectorFragment< TPointer > &  other  )  [inline]
 

Copy constructor

Parameters:
other The fragment to be copied 
00052       : Header<TPointer>(other), m_start(other.m_start) {}

template<class TPointer>
virtual eformat::SubDetectorFragment< TPointer >::~SubDetectorFragment (   )  [inline, virtual]
 

Destructor virtualisation 

00057 {}

Member Function Documentation

template<class TPointer>
eformat::Header< TPointer > & eformat::Header< TPointer >::assign (  const TPointer &  it,
uint32_t  match
)  [inherited]
 

Reassign this header

Parameters:
it The exact position where this header should start.
match The word that this header should match. 
00237 {
00238   ERS_DEBUG_3("Rebuilding header 0x%x from iterator", match);
00239   m_start = it;
00240   if (marker() != match) {
00241     throw EFORMAT_WRONG_MARKER(marker(), match);
00242   }
00243   ERS_DEBUG_1("Re-initialized header with source identifier = %s",
00244               eformat::helper::SourceIdentifier(match).human().c_str());
00245   return *this;
00246 }

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

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 
00110 {
00111   ERS_DEBUG_3("Re-building SubDetectorFragment from pointer");
00112   eformat::Header<TPointer>::assign(it, eformat::SUB_DETECTOR);
00113   specific_header(m_start);
00114   ERS_DEBUG_1("Initialized header with source identifier = %s",
00115               eformat::helper::SourceIdentifier(source_id()).human().c_str());
00116   return *this;
00117 }

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 >.

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 >.

00121 {
00122   ERS_DEBUG_2("Checking for consistency of SubDetectorFragment");
00123   eformat::Header<TPointer>::check(); //< first do a generic check
00124   if (nspecific() != NSPECIFIC) {
00125     throw EFORMAT_SIZE_CHECK(NSPECIFIC, nspecific());
00126   }
00127   return true;
00128 }

template<class TPointer>
bool eformat::SubDetectorFragment< TPointer >::check_tree (   )  const
 

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

template<class TPointer>
bool eformat::SubDetectorFragment< TPointer >::check_tree (   )  const
 

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

00132 {
00133   ERS_DEBUG_2("Checking recursively for consistency of SubDetectorFragment");
00134   check(); // check myself
00135   uint32_t total = nchildren();
00136   for (size_t i=0; i<total; ++i) {
00137     TPointer fp;
00138     child(fp, i);
00139     eformat::ROSFragment<TPointer> f(fp);
00140     f.check_tree();
00141   }
00142   return true;
00143 }

template<class TPointer>
virtual void eformat::Header< TPointer >::child (  TPointer &  p,
size_t  n
)  const [virtual, inherited]
 

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.

template<class TPointer>
void eformat::Header< TPointer >::child (  TPointer &  p,
size_t  n
)  const [virtual, inherited]
 

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. 
00273 {
00274   ERS_DEBUG_2("User asked for child %ud of fragment type %s [%s]", n,
00275               eformat::marker2string(marker()).c_str(),
00276               eformat::helper::SourceIdentifier(source_id()).human().c_str());
00277   TPointer next;
00278   payload(next);
00279   for (size_t i=0; i<n; ++i) next += next[1];
00280   ERS_DEBUG_3("Set user object");
00281   p = next;
00282 }

template<class TPointer>
virtual void eformat::Header< TPointer >::child_check (  TPointer &  p,
size_t  n
)  const [virtual, inherited]
 

Returns the nth child fragment. If the nth fragment doesn't exist, an exception is thrown.

Warning:
Use this method with care, it is slower than the equivalent method that doesn't check.
Parameters:
p A preallocated pointer you should provide.
n The fragment position, starting at zero, of the child fragment you would like to get.

template<class TPointer>
void eformat::Header< TPointer >::child_check (  TPointer &  p,
size_t  n
)  const [virtual, inherited]
 

Returns the nth child fragment. If the nth fragment doesn't exist, an exception is thrown.

Warning:
Use this method with care, it is slower than the equivalent method that doesn't check.
Parameters:
p A preallocated pointer you should provide.
n The fragment position, starting at zero, of the child fragment you would like to get. 
00286 {
00287   uint32_t total = nchildren();
00288   if (n >= total) throw EFORMAT_NO_SUCH_CHILD(n, total);
00289   child(p, n);
00290 }

template<class TPointer>
virtual uint32_t eformat::Header< TPointer >::children (  TPointer *  p,
size_t  max
)  const [virtual, inherited]
 

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

template<class TPointer>
uint32_t eformat::Header< TPointer >::children (  TPointer *  p,
size_t  max
)  const [virtual, inherited]
 

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 
00294 {
00295   ERS_DEBUG_2("Retrieving all children...");
00296   TPointer payload_start;
00297   payload(payload_start);
00298   try {
00299     return find_fragments(child_marker(static_cast<HeaderMarker>(marker())),
00300                           payload_start, payload_size_word(), p, max);
00301   }
00302   catch (WrongMarkerIssue& ex) {
00303     //This normally means the fragment size is wrong...
00304     throw EFORMAT_WRONG_SIZE(fragment_size_word());
00305   }
00306   return 0;
00307 }

template<class TPointer>
void eformat::Header< TPointer >::end (  TPointer &  it  )  const [inline, inherited]
 

Sets the pointer to one-past my end position

Parameters:
it The pointer to set 
00144     { it = m_start; it += fragment_size_word(); }

template<class TPointer>
void eformat::Header< TPointer >::end (  TPointer &  it  )  const [inline, inherited]
 

Sets the pointer to one-past my end position

Parameters:
it The pointer to set 
00144     { it = m_start; it += fragment_size_word(); }

template<class TPointer>
uint32_t eformat::Header< TPointer >::fragment_size_word (   )  const [inline, inherited]
 

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

00100 { return m_start[1]; }

template<class TPointer>
uint32_t eformat::Header< TPointer >::fragment_size_word (   )  const [inline, inherited]
 

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

00100 { return m_start[1]; }

template<class TPointer>
uint32_t eformat::Header< TPointer >::header_size_word (   )  const [inline, inherited]
 

Returns the size, in words, of the current header. That does include the specific part of the header. 

00106 { return m_start[2]; }

template<class TPointer>
uint32_t eformat::Header< TPointer >::header_size_word (   )  const [inline, inherited]
 

Returns the size, in words, of the current header. That does include the specific part of the header. 

00106 { return m_start[2]; }

template<class TPointer>
uint32_t eformat::Header< TPointer >::marker (   )  const [inline, inherited]
 

Returns the fragment type. 

00095 { return m_start[0]; }

template<class TPointer>
uint32_t eformat::Header< TPointer >::marker (   )  const [inline, inherited]
 

Returns the fragment type. 

00095 { return m_start[0]; }

template<class TPointer>
virtual uint32_t eformat::Header< TPointer >::nchildren (   )  const [virtual, inherited]
 

Returns the number of children available.

template<class TPointer>
uint32_t eformat::Header< TPointer >::nchildren (   )  const [virtual, inherited]
 

Returns the number of children available. 

00264 {
00265   ERS_DEBUG_2("User asked for number of children of fragment type %s [%s]",
00266               eformat::marker2string(marker()).c_str(),
00267               eformat::helper::SourceIdentifier(source_id()).human().c_str());
00268   return children(0,0);
00269 }

template<class TPointer>
uint32_t eformat::Header< TPointer >::nspecific (   )  const [inline, inherited]
 

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

00164 { return m_start[6 + nstatus()]; }

template<class TPointer>
uint32_t eformat::Header< TPointer >::nspecific (   )  const [inline, inherited]
 

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

00164 { return m_start[6 + nstatus()]; }

template<class TPointer>
uint32_t eformat::Header< TPointer >::nstatus (  void   )  const [inline, inherited]
 

Returns the number of status words available 

00121 { return m_start[5]; }

template<class TPointer>
uint32_t eformat::Header< TPointer >::nstatus (   )  const [inline, inherited]
 

Returns the number of status words available 

00121 { return m_start[5]; }

template<class TPointer>
SubDetectorFragment& eformat::SubDetectorFragment< TPointer >::operator= (  const SubDetectorFragment< TPointer > &  other  )  [inline]
 

Copy operator

Parameters:
other The fragment to be copied 
00065     { Header<TPointer>::operator=(other); m_start=other.m_start; return *this; }

template<class TPointer>
SubDetectorFragment& eformat::SubDetectorFragment< TPointer >::operator= (  const SubDetectorFragment< TPointer > &  other  )  [inline]
 

Copy operator

Parameters:
other The fragment to be copied 
00065     { Header<TPointer>::operator=(other); m_start=other.m_start; return *this; }

template<class TPointer>
void eformat::Header< TPointer >::payload (  TPointer &  it  )  const [inline, inherited]
 

Sets the pointer to where the payload starts

Parameters:
it The pointer to set 
00136     { it = m_start; it+= header_size_word(); }

template<class TPointer>
void eformat::Header< TPointer >::payload (  TPointer &  it  )  const [inline, inherited]
 

Sets the pointer to where the payload starts

Parameters:
it The pointer to set 
00136     { it = m_start; it+= header_size_word(); }

template<class TPointer>
uint32_t eformat::Header< TPointer >::payload_size_word (  void   )  const [inline, inherited]
 

Returns the payload size 

00150     { return fragment_size_word() - header_size_word(); }

template<class TPointer>
uint32_t eformat::Header< TPointer >::payload_size_word (  void   )  const [inline, inherited]
 

Returns the payload size 

00150     { return fragment_size_word() - header_size_word(); }

template<class TPointer>
uint32_t eformat::Header< TPointer >::source_id (  void   )  const [inline, inherited]
 

Returns the full source identifier. 

00116 { return m_start[4]; }

template<class TPointer>
uint32_t eformat::Header< TPointer >::source_id (   )  const [inline, inherited]
 

Returns the full source identifier. 

00116 { return m_start[4]; }

template<class TPointer>
void eformat::Header< TPointer >::specific_header (  TPointer &  it  )  const [inline, inherited]
 

Returns an iterator to the start of the specific header part (this does not include the number of specific header fragments)

Parameters:
it An updateable iterator you should provide. 
00173     { it = m_start; it += 7 + nstatus(); }

template<class TPointer>
void eformat::Header< TPointer >::specific_header (  TPointer &  it  )  const [inline, inherited]
 

Returns an iterator to the start of the specific header part (this does not include the number of specific header fragments)

Parameters:
it An updateable iterator you should provide. 
00173     { it = m_start; it += 7 + nstatus(); }

template<class TPointer>
void eformat::Header< TPointer >::start (  TPointer &  it  )  const [inline, inherited]
 

Sets the pointer to my start

Parameters:
it The pointer to set 
00128 { it = m_start; }

template<class TPointer>
void eformat::Header< TPointer >::start (  TPointer &  it  )  const [inline, inherited]
 

Sets the pointer to my start

Parameters:
it The pointer to set 
00128 { it = m_start; }

template<class TPointer>
void eformat::Header< TPointer >::status (  TPointer &  it  )  const [inline, inherited]
 

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

Parameters:
it An updateable iterator you should provide. 
00157 { it = m_start; it += 6; }

template<class TPointer>
void eformat::Header< TPointer >::status (  TPointer &  it  )  const [inline, inherited]
 

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

Parameters:
it An updateable iterator you should provide. 
00157 { it = m_start; it += 6; }

template<class TPointer>
uint32_t eformat::Header< TPointer >::version (   )  const [inline, inherited]
 

Returns the formatting version. 

00111 { return m_start[3]; }

template<class TPointer>
uint32_t eformat::Header< TPointer >::version (   )  const [inline, inherited]
 

Returns the formatting version. 

00111 { return m_start[3]; }

Member Data Documentation

template<class TPointer>
TPointer eformat::SubDetectorFragment< TPointer >::m_start [private]
 

my start word

Reimplemented from eformat::Header< TPointer >.

template<class TPointer>
const uint32_t eformat::SubDetectorFragment< TPointer >::NSPECIFIC = 0 [static, private]
 

The documentation for this class was generated from the following files:
Generated on Wed Feb 2 19:18:21 2011 for BOSS6.5.5 by  doxygen 1.3.9.1