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

#include <TOPInterimFEInfo.h>

Inheritance diagram for TOPInterimFEInfo:

Collaboration diagram for TOPInterimFEInfo:

[legend]

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

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

unsigned	getScrodID () const
	Returns SCROD ID. More...

int	getDataSize () const
	Returns data buffer size. More...

unsigned	getFEHeadersCount () const
	Returns the number of FE headers found in data buffer. More...

unsigned	getEmptyFEHeadersCount () const
	Returns the number of empty FE headers found in data buffer. More...

unsigned	getWaveformsCount () const
	Returns the number of waveforms found in data buffer. More...

unsigned	getErrorFlags () const
	Returns error flags. More...

bool	isErrorBitSet (ErrorFlags flag) const
	Returns true if particular error flag is set. More...

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

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

void	copyRelations (const RelationsInterface< BASE > *sourceObj)
	Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights). More...

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

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

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

template<class TO >
TO *	getRelatedTo (const std::string &name="", const std::string &namedRelation="") const
	Get the object to which this object has a relation. More...

template<class FROM >
FROM *	getRelatedFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the object from which this object has a relation. More...

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

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

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

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

virtual std::string	getName () const
	Return a short name that describes this object, e.g. More...

virtual std::string	getInfoHTML () const
	Return a short summary of this object's contents in HTML format. More...

std::string	getInfo () const
	Return a short summary of this object's contents in raw text format. More...

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

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.

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

Constructor & Destructor Documentation

◆ TOPInterimFEInfo()

TOPInterimFEInfo	(	unsigned short	scrodID,
		int	dataSize
	)

inline

Full constructor.

Parameters

scrodID	scrod ID
dataSize	data buffer size [32-bit words]

Definition at line 51 of file TOPInterimFEInfo.h.

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

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 142 of file RelationsObject.h.

◆ 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

object	The object to which the relation should point.
weight	The weight of the relation.
namedRelation	Additional name for the relation, or "" for the default naming

Definition at line 155 of file RelationsObject.h.

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

◆ getDataSize()

int getDataSize ( ) const

inline

Returns data buffer size.

Returns: size [32-bit words]

Definition at line 86 of file TOPInterimFEInfo.h.

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

◆ getErrorFlags()

unsigned getErrorFlags ( ) const

inline

Returns error flags.

Returns: bit flags

Definition at line 110 of file TOPInterimFEInfo.h.

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

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

◆ 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();

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 RecoTrack, TRGSummary, TrackFitResult, Track, SoftwareTriggerResult, PIDLikelihood, MCParticle, Cluster, and Particle.

Definition at line 362 of file RelationsObject.h.

◆ getName()

virtual std::string getName ( ) const

inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in SpacePoint, MCParticle, and Particle.

Definition at line 344 of file RelationsObject.h.

◆ 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

T	The class of objects to or from which the relation points.

Parameters

name	The 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.
namedRelation	Additional 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.

◆ 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

FROM	The class of objects from which the relation points.

Parameters

name	The 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.
namedRelation	Additional 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.

◆ 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

FROM	The class of objects from which the relation points.

Parameters

name	The 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.
namedRelation	Additional 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.

◆ 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

TO	The class of objects to which the relation points.

Parameters

name	The 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.
namedRelation	Additional 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.

◆ 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

TO	The class of objects to which the relation points.

Parameters

name	The 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.
namedRelation	Additional 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.

◆ 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

T	The class of objects to or from which the relation points.

Parameters

name	The 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.
namedRelation	Additional 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.

◆ 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

FROM	The class of objects from which the relations point.

Parameters

name	The 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.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 212 of file RelationsObject.h.

◆ 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

TO	The class of objects to which the relations point.

Parameters

name	The 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.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 197 of file RelationsObject.h.

◆ 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

T	The class of objects to or from which the relations point.

Parameters

name	The 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.
namedRelation	Additional name for the relation, or "" for the default naming

Returns: A vector of relations.

Definition at line 230 of file RelationsObject.h.

◆ getScrodID()

unsigned getScrodID ( ) const

inline

Returns SCROD ID.

Returns: SCROD ID

Definition at line 80 of file TOPInterimFEInfo.h.

◆ getWaveformsCount()

unsigned getWaveformsCount ( ) const

inline

Returns the number of waveforms found in data buffer.

Returns: count

Definition at line 104 of file TOPInterimFEInfo.h.

◆ isErrorBitSet()

bool isErrorBitSet ( ErrorFlags flag ) const

inline

Returns true if particular error flag is set.

Parameters

flag bit flag

Returns: true if set

Definition at line 117 of file TOPInterimFEInfo.h.

◆ setErrorFlag()

void setErrorFlag ( ErrorFlags flag )

inline

Sets error flag.

Parameters

flag	bit flag as defined in enum

Definition at line 74 of file TOPInterimFEInfo.h.

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

top/dataobjects/include/TOPInterimFEInfo.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ErrorFlags

Constructor & Destructor Documentation

◆ TOPInterimFEInfo()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getDataSize()

◆ getEmptyFEHeadersCount()

◆ getErrorFlags()

◆ getFEHeadersCount()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getScrodID()

◆ getWaveformsCount()

◆ isErrorBitSet()

◆ setErrorFlag()