Belle II Software development
TOPInterimFEInfo Class Reference

Class to store debug info of raw data in Interim FE format. More...

#include <TOPInterimFEInfo.h>

Inheritance diagram for TOPInterimFEInfo:
RelationsInterface< BASE >

Public Types

enum  ErrorFlags {
  c_InvalidFEHeader = 0x0001 ,
  c_DifferentScrodIDs = 0x0002 ,
  c_InvalidMagicWord = 0x0004 ,
  c_DifferentCarriers = 0x0008 ,
  c_DifferentAsics = 0x0010 ,
  c_DifferentChannels = 0x0020 ,
  c_DifferentWindows = 0x0040 ,
  c_InsufficientWFData = 0x0080 ,
  c_InvalidScrodID = 0x0100
}
 Error flags. More...
 

Public Member Functions

 TOPInterimFEInfo ()
 Default constructor.
 
 TOPInterimFEInfo (unsigned short scrodID, int dataSize)
 Full constructor.
 
void incrementFEHeadersCount ()
 Increments FE headers counter.
 
void incrementEmptyFEHeadersCount ()
 Increments empty FE headers counter.
 
void incrementWaveformsCount ()
 Increments waveforms counter.
 
void setErrorFlag (ErrorFlags flag)
 Sets error flag.
 
unsigned getScrodID () const
 Returns SCROD ID.
 
int getDataSize () const
 Returns data buffer size.
 
unsigned getFEHeadersCount () const
 Returns the number of FE headers found in data buffer.
 
unsigned getEmptyFEHeadersCount () const
 Returns the number of empty FE headers found in data buffer.
 
unsigned getWaveformsCount () const
 Returns the number of waveforms found in data buffer.
 
unsigned getErrorFlags () const
 Returns error flags.
 
bool isErrorBitSet (ErrorFlags flag) const
 Returns true if particular error flag is set.
 
void addRelationTo (const RelationsInterface< BASE > *object, float weight=1.0, const std::string &namedRelation="") const
 Add a relation from this object to another object (with caching).
 
void addRelationTo (const TObject *object, float weight=1.0, const std::string &namedRelation="") const
 Add a relation from this object to another object (no caching, can be quite slow).
 
void copyRelations (const RelationsInterface< BASE > *sourceObj)
 Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).
 
template<class TO >
RelationVector< TO > getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
 Get the relations that point from this object to another store array.
 
template<class FROM >
RelationVector< FROM > getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
 Get the relations that point from another store array to this object.
 
template<class T >
RelationVector< T > getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
 Get the relations between this object and another store array.
 
template<class TO >
TO * getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
 Get the object to which this object has a relation.
 
template<class FROM >
FROM * getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
 Get the object from which this object has a relation.
 
template<class T >
T * getRelated (const std::string &name="", const std::string &namedRelation="") const
 Get the object to or from which this object has a relation.
 
template<class TO >
std::pair< TO *, float > getRelatedToWithWeight (const std::string &name="", const std::string &namedRelation="") const
 Get first related object & weight of relation pointing to an array.
 
template<class FROM >
std::pair< FROM *, float > getRelatedFromWithWeight (const std::string &name="", const std::string &namedRelation="") const
 Get first related object & weight of relation pointing from an array.
 
template<class T >
std::pair< T *, float > getRelatedWithWeight (const std::string &name="", const std::string &namedRelation="") const
 Get first related object & weight of relation pointing from/to an array.
 
virtual std::string getName () const
 Return a short name that describes this object, e.g.
 
virtual std::string getInfoHTML () const
 Return a short summary of this object's contents in HTML format.
 
std::string getInfo () const
 Return a short summary of this object's contents in raw text format.
 
std::string getArrayName () const
 Get name of array this object is stored in, or "" if not found.
 
int getArrayIndex () const
 Returns this object's array index (in StoreArray), or -1 if not found.
 

Protected Member Functions

TClonesArray * getArrayPointer () const
 Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).
 

Private Member Functions

 ClassDef (TOPInterimFEInfo, 1)
 ClassDef.
 

Private Attributes

unsigned short m_scrodID = 0
 SCROD ID.
 
int m_dataSize = 0
 data buffer size [32-bit words]
 
unsigned m_FEHeaders = 0
 number of FE headers in data buffer
 
unsigned m_emptyFEHeaders = 0
 number of empty FE headers in data buffer
 
unsigned m_waveforms = 0
 number of waveforms in data buffer
 
unsigned m_errorFlags = 0
 error flags, see enum
 
DataStore::StoreEntrym_cacheDataStoreEntry
 Cache of the data store entry to which this object belongs.
 
int m_cacheArrayIndex
 Cache of the index in the TClonesArray to which this object belongs.
 

Detailed Description

Class to store debug info of raw data in Interim FE format.

Definition at line 23 of file TOPInterimFEInfo.h.

Member Enumeration Documentation

◆ ErrorFlags

enum ErrorFlags

Error flags.

Enumerator
c_InvalidFEHeader 

invalid FE header word

c_DifferentScrodIDs 

in HLSB and FE header

c_InvalidMagicWord 

at the end of FE header

c_DifferentCarriers 

in FE and WF header

c_DifferentAsics 

in FE and WF header

c_DifferentChannels 

in FE and WF header

c_DifferentWindows 

in FE and WF header

c_InsufficientWFData 

too few words for waveform data

c_InvalidScrodID 

no front-end map available

Definition at line 29 of file TOPInterimFEInfo.h.

29 {c_InvalidFEHeader = 0x0001,
30 c_DifferentScrodIDs = 0x0002,
31 c_InvalidMagicWord = 0x0004,
32 c_DifferentCarriers = 0x0008,
33 c_DifferentAsics = 0x0010,
34 c_DifferentChannels = 0x0020,
35 c_DifferentWindows = 0x0040,
36 c_InsufficientWFData = 0x0080,
37 c_InvalidScrodID = 0x0100
38 };
@ c_DifferentChannels
in FE and WF header
@ c_DifferentScrodIDs
in HLSB and FE header
@ c_InvalidMagicWord
at the end of FE header
@ c_InvalidScrodID
no front-end map available
@ c_DifferentCarriers
in FE and WF header
@ c_DifferentWindows
in FE and WF header
@ c_InsufficientWFData
too few words for waveform data
@ c_InvalidFEHeader
invalid FE header word
@ c_DifferentAsics
in FE and WF header

Constructor & Destructor Documentation

◆ TOPInterimFEInfo() [1/2]

TOPInterimFEInfo ( )
inline

Default constructor.

Definition at line 43 of file TOPInterimFEInfo.h.

44 {}

◆ TOPInterimFEInfo() [2/2]

TOPInterimFEInfo ( unsigned short  scrodID,
int  dataSize 
)
inline

Full constructor.

Parameters
scrodIDscrod ID
dataSizedata buffer size [32-bit words]

Definition at line 51 of file TOPInterimFEInfo.h.

51 :
52 m_scrodID(scrodID), m_dataSize(dataSize)
53 {}
unsigned short m_scrodID
SCROD ID.
int m_dataSize
data buffer size [32-bit words]

Member Function Documentation

◆ addRelationTo() [1/2]

void addRelationTo ( const RelationsInterface< BASE > *  object,
float  weight = 1.0,
const std::string &  namedRelation = "" 
) const
inlineinherited

Add a relation from this object to another object (with caching).

Parameters
objectThe object to which the relation should point.
weightThe weight of the relation.
namedRelationAdditional name for the relation, or "" for the default naming

Definition at line 142 of file RelationsObject.h.

143 {
144 if (object)
146 object, object->m_cacheDataStoreEntry, object->m_cacheArrayIndex, weight, namedRelation);
147 }
void addRelation(const TObject *fromObject, StoreEntry *&fromEntry, int &fromIndex, const TObject *toObject, StoreEntry *&toEntry, int &toIndex, float weight, const std::string &namedRelation)
Add a relation from an object in a store array to another object in a store array.
Definition: DataStore.cc:492
static DataStore & Instance()
Instance of singleton Store.
Definition: DataStore.cc:54
DataStore::StoreEntry * m_cacheDataStoreEntry
Cache of the data store entry to which this object belongs.
int m_cacheArrayIndex
Cache of the index in the TClonesArray to which this object belongs.

◆ addRelationTo() [2/2]

void addRelationTo ( const TObject *  object,
float  weight = 1.0,
const std::string &  namedRelation = "" 
) const
inlineinherited

Add a relation from this object to another object (no caching, can be quite slow).

Parameters
objectThe object to which the relation should point.
weightThe weight of the relation.
namedRelationAdditional name for the relation, or "" for the default naming

Definition at line 155 of file RelationsObject.h.

156 {
157 StoreEntry* toEntry = nullptr;
158 int toIndex = -1;
159 DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex, object, toEntry, toIndex, weight, namedRelation);
160 }

◆ copyRelations()

void copyRelations ( const RelationsInterface< BASE > *  sourceObj)
inlineinherited

Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

Useful if you want to make a complete copy of a StoreArray object to make modifications to it, but retain all information on linked objects.

Note: this only works if sourceObj inherits from the same base (e.g. RelationsObject), and only for related objects that also inherit from the same base.

Definition at line 170 of file RelationsObject.h.

171 {
172 if (!sourceObj)
173 return;
174 auto fromRels = sourceObj->getRelationsFrom<RelationsInterface<BASE>>("ALL");
175 for (unsigned int iRel = 0; iRel < fromRels.size(); iRel++) {
176 fromRels.object(iRel)->addRelationTo(this, fromRels.weight(iRel));
177 }
178
179 auto toRels = sourceObj->getRelationsTo<RelationsInterface<BASE>>("ALL");
180 for (unsigned int iRel = 0; iRel < toRels.size(); iRel++) {
181 this->addRelationTo(toRels.object(iRel), toRels.weight(iRel));
182 }
183 }
void addRelationTo(const RelationsInterface< BASE > *object, float weight=1.0, const std::string &namedRelation="") const
Add a relation from this object to another object (with caching).

◆ getArrayIndex()

int getArrayIndex ( ) const
inlineinherited

Returns this object's array index (in StoreArray), or -1 if not found.

Definition at line 385 of file RelationsObject.h.

386 {
388 return m_cacheArrayIndex;
389 }
bool findStoreEntry(const TObject *object, StoreEntry *&entry, int &index)
Find an object in an array in the data store.
Definition: DataStore.cc:398

◆ getArrayName()

std::string getArrayName ( ) const
inlineinherited

Get name of array this object is stored in, or "" if not found.

Definition at line 377 of file RelationsObject.h.

◆ getArrayPointer()

TClonesArray * getArrayPointer ( ) const
inlineprotectedinherited

Returns the pointer to the raw DataStore array holding this object (protected since these arrays are easy to misuse).

Definition at line 418 of file RelationsObject.h.

419 {
422 return nullptr;
424 }
TClonesArray * getPtrAsArray() const
Return ptr cast to TClonesArray.
Definition: StoreEntry.cc:83

◆ getDataSize()

int getDataSize ( ) const
inline

Returns data buffer size.

Returns
size [32-bit words]

Definition at line 86 of file TOPInterimFEInfo.h.

86{return m_dataSize;}

◆ getEmptyFEHeadersCount()

unsigned getEmptyFEHeadersCount ( ) const
inline

Returns the number of empty FE headers found in data buffer.

Returns
count

Definition at line 98 of file TOPInterimFEInfo.h.

98{return m_emptyFEHeaders;}
unsigned m_emptyFEHeaders
number of empty FE headers in data buffer

◆ getErrorFlags()

unsigned getErrorFlags ( ) const
inline

Returns error flags.

Returns
bit flags

Definition at line 110 of file TOPInterimFEInfo.h.

110{return m_errorFlags;}
unsigned m_errorFlags
error flags, see enum

◆ getFEHeadersCount()

unsigned getFEHeadersCount ( ) const
inline

Returns the number of FE headers found in data buffer.

Returns
count

Definition at line 92 of file TOPInterimFEInfo.h.

92{return m_FEHeaders;}
unsigned m_FEHeaders
number of FE headers in data buffer

◆ getInfo()

std::string getInfo ( ) const
inlineinherited

Return a short summary of this object's contents in raw text format.

Returns the contents of getInfoHTML() while translating line-breaks etc.

Note
: You don't need to implement this function (it's not virtual), getInfoHTML() is enough.

Definition at line 370 of file RelationsObject.h.

371 {
373 }
virtual std::string getInfoHTML() const
Return a short summary of this object's contents in HTML format.
std::string htmlToPlainText(const std::string &html)
See RelationsObject::getInfo()

◆ getInfoHTML()

virtual std::string getInfoHTML ( ) const
inlinevirtualinherited

Return a short summary of this object's contents in HTML format.

Reimplement this in your own class to provide useful output for display or debugging purposes. For example, you might do something like:

std::stringstream out;
out << "<b>PDG</b>: " << m_pdg << "<br>";
out << "<b>Covariance Matrix</b>: " << HTML::getString(getCovariance5()) << "<br>";
return out.str();
std::string getString(const TMatrixFBase &matrix, int precision=2, bool color=true)
get HTML table representing a matrix.
Definition: HTML.cc:24
See also
Particle::getInfoHTML() for a more complex example.
HTML for some utility functions.
Use getInfo() to get a raw text version of this output.

Reimplemented in Particle, Cluster, MCParticle, PIDLikelihood, SoftwareTriggerResult, Track, TrackFitResult, TRGSummary, and RecoTrack.

Definition at line 362 of file RelationsObject.h.

362{ return ""; }

◆ getName()

virtual std::string getName ( ) const
inlinevirtualinherited

Return a short name that describes this object, e.g.

pi+ for an MCParticle.

Reimplemented in Particle, MCParticle, and SpacePoint.

Definition at line 344 of file RelationsObject.h.

344{ return ""; }

◆ getRelated()

T * getRelated ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get the object to or from which this object has a relation.

Template Parameters
TThe class of objects to or from which the relation points.
Parameters
nameThe name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
The first related object or a null pointer.

Definition at line 278 of file RelationsObject.h.

279 {
281 T::Class(), name, namedRelation).object);
282 }
@ c_BothSides
Combination of c_FromSide and c_ToSide.
Definition: DataStore.h:79
Belle2::RelationEntry getRelationWith(ESearchSide searchSide, const TObject *object, StoreEntry *&entry, int &index, const TClass *withClass, const std::string &withName, const std::string &namedRelation)
Get the first relation between an object and another object in a store array.
Definition: DataStore.cc:597
TObject * object
Pointer to the object.
Definition: RelationEntry.h:32

◆ getRelatedFrom()

FROM * getRelatedFrom ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get the object from which this object has a relation.

Template Parameters
FROMThe class of objects from which the relation points.
Parameters
nameThe name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
The first related object or a null pointer.

Definition at line 263 of file RelationsObject.h.

264 {
266 m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);
267 }
@ c_FromSide
Return relations/objects pointed from (to a given object).
Definition: DataStore.h:77

◆ getRelatedFromWithWeight()

std::pair< FROM *, float > getRelatedFromWithWeight ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get first related object & weight of relation pointing from an array.

Template Parameters
FROMThe class of objects from which the relation points.
Parameters
nameThe name of the store array from which the relation points. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 314 of file RelationsObject.h.

316 {
318 FROM::Class(), name, namedRelation);
319 return std::make_pair(static_cast<FROM*>(entry.object), entry.weight);
320 }

◆ getRelatedTo()

TO * getRelatedTo ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get the object to which this object has a relation.

Template Parameters
TOThe class of objects to which the relation points.
Parameters
nameThe name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
The first related object or a null pointer.

Definition at line 248 of file RelationsObject.h.

249 {
251 TO::Class(), name, namedRelation).object);
252 }
@ c_ToSide
Return relations/objects pointed to (from a given object).
Definition: DataStore.h:78

◆ getRelatedToWithWeight()

std::pair< TO *, float > getRelatedToWithWeight ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get first related object & weight of relation pointing to an array.

Template Parameters
TOThe class of objects to which the relation points.
Parameters
nameThe name of the store array to which the relation points. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 297 of file RelationsObject.h.

299 {
301 TO::Class(), name, namedRelation);
302 return std::make_pair(static_cast<TO*>(entry.object), entry.weight);
303 }

◆ getRelatedWithWeight()

std::pair< T *, float > getRelatedWithWeight ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get first related object & weight of relation pointing from/to an array.

Template Parameters
TThe class of objects to or from which the relation points.
Parameters
nameThe name of the store array to or from which the relation points. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
Pair of first related object and the relation weight, or (NULL, 1.0) if none found.

Definition at line 331 of file RelationsObject.h.

333 {
335 T::Class(), name, namedRelation);
336 return std::make_pair(static_cast<T*>(entry.object), entry.weight);
337 }

◆ getRelationsFrom()

RelationVector< FROM > getRelationsFrom ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get the relations that point from another store array to this object.

Template Parameters
FROMThe class of objects from which the relations point.
Parameters
nameThe name of the store array from which the relations point. If empty the default store array name for class FROM will be used. If the special name "ALL" is given all store arrays containing objects of type FROM are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
A vector of relations.

Definition at line 212 of file RelationsObject.h.

214 {
216 m_cacheArrayIndex, FROM::Class(), name, namedRelation));
217 }
RelationVector< T > getRelationsWith(const std::string &name="", const std::string &namedRelation="") const
Get the relations between this object and another store array.

◆ getRelationsTo()

RelationVector< TO > getRelationsTo ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get the relations that point from this object to another store array.

Template Parameters
TOThe class of objects to which the relations point.
Parameters
nameThe name of the store array to which the relations point. If empty the default store array name for class TO will be used. If the special name "ALL" is given all store arrays containing objects of type TO are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
A vector of relations.

Definition at line 197 of file RelationsObject.h.

198 {
200 m_cacheArrayIndex, TO::Class(), name, namedRelation));
201 }

◆ getRelationsWith()

RelationVector< T > getRelationsWith ( const std::string &  name = "",
const std::string &  namedRelation = "" 
) const
inlineinherited

Get the relations between this object and another store array.

Relations in both directions are returned.

Template Parameters
TThe class of objects to or from which the relations point.
Parameters
nameThe name of the store array to or from which the relations point. If empty the default store array name for class T will be used. If the special name "ALL" is given all store arrays containing objects of type T are considered.
namedRelationAdditional name for the relation, or "" for the default naming
Returns
A vector of relations.

Definition at line 230 of file RelationsObject.h.

231 {
233 m_cacheArrayIndex, T::Class(), name, namedRelation));
234 }

◆ getScrodID()

unsigned getScrodID ( ) const
inline

Returns SCROD ID.

Returns
SCROD ID

Definition at line 80 of file TOPInterimFEInfo.h.

80{return m_scrodID;}

◆ getWaveformsCount()

unsigned getWaveformsCount ( ) const
inline

Returns the number of waveforms found in data buffer.

Returns
count

Definition at line 104 of file TOPInterimFEInfo.h.

104{return m_waveforms;}
unsigned m_waveforms
number of waveforms in data buffer

◆ incrementEmptyFEHeadersCount()

void incrementEmptyFEHeadersCount ( )
inline

Increments empty FE headers counter.

Definition at line 63 of file TOPInterimFEInfo.h.

◆ incrementFEHeadersCount()

void incrementFEHeadersCount ( )
inline

Increments FE headers counter.

Definition at line 58 of file TOPInterimFEInfo.h.

58{m_FEHeaders++;}

◆ incrementWaveformsCount()

void incrementWaveformsCount ( )
inline

Increments waveforms counter.

Definition at line 68 of file TOPInterimFEInfo.h.

68{m_waveforms++;}

◆ isErrorBitSet()

bool isErrorBitSet ( ErrorFlags  flag) const
inline

Returns true if particular error flag is set.

Parameters
flagbit flag
Returns
true if set

Definition at line 117 of file TOPInterimFEInfo.h.

117{return (m_errorFlags & flag) == flag;}

◆ setErrorFlag()

void setErrorFlag ( ErrorFlags  flag)
inline

Sets error flag.

Parameters
flagbit flag as defined in enum

Definition at line 74 of file TOPInterimFEInfo.h.

74{m_errorFlags |= flag;}

Member Data Documentation

◆ m_cacheArrayIndex

int m_cacheArrayIndex
mutableprivateinherited

Cache of the index in the TClonesArray to which this object belongs.

Definition at line 432 of file RelationsObject.h.

◆ m_cacheDataStoreEntry

DataStore::StoreEntry* m_cacheDataStoreEntry
mutableprivateinherited

Cache of the data store entry to which this object belongs.

Definition at line 429 of file RelationsObject.h.

◆ m_dataSize

int m_dataSize = 0
private

data buffer size [32-bit words]

Definition at line 122 of file TOPInterimFEInfo.h.

◆ m_emptyFEHeaders

unsigned m_emptyFEHeaders = 0
private

number of empty FE headers in data buffer

Definition at line 124 of file TOPInterimFEInfo.h.

◆ m_errorFlags

unsigned m_errorFlags = 0
private

error flags, see enum

Definition at line 126 of file TOPInterimFEInfo.h.

◆ m_FEHeaders

unsigned m_FEHeaders = 0
private

number of FE headers in data buffer

Definition at line 123 of file TOPInterimFEInfo.h.

◆ m_scrodID

unsigned short m_scrodID = 0
private

SCROD ID.

Definition at line 121 of file TOPInterimFEInfo.h.

◆ m_waveforms

unsigned m_waveforms = 0
private

number of waveforms in data buffer

Definition at line 125 of file TOPInterimFEInfo.h.


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