Class to store debugging information about the event headers in the by the TOP production debugging raw data format one of these should be available per boardstack per event. More...

#include <TOPProductionEventDebug.h>

Inheritance diagram for TOPProductionEventDebug:

Public Member Functions
	TOPProductionEventDebug ()
	Default constructor.

	TOPProductionEventDebug (unsigned short formatType, unsigned short formatVersion, unsigned scrodID, bool skipProcessingFlag, unsigned short ctime, unsigned short phase, unsigned short asicMask, unsigned short eventQueueDepth, unsigned short eventNumberByte)
	Full constructor.

unsigned short	getFormatType () const
	Returns data format type number.

unsigned short	getFormatVersion () const
	Returns data format version number.

unsigned short	getScrodID () const
	Returns SCROD ID.

bool	getSkipProcessingFlag () const
	Returns skip processing bit.

unsigned short	getCtime () const
	Returns event header ctime.

unsigned short	getPhase () const
	Returns event phase.

unsigned short	getAsicMask () const
	Returns bit field of masked ASICs.

unsigned short	getEventQueueDepth () const
	Returns trigger FIFO queue depth.

unsigned short	getEventNumberByte () const
	Returns least significant byte of FE event number.

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 (TOPProductionEventDebug, 1)
	ClassDef.

Private Attributes
unsigned short	m_formatType = 0
	data format type specifier

unsigned short	m_formatVersion = 0
	data format version specifier

unsigned short	m_scrodID = 0
	hardware SCROD ID

bool	m_skipProcessingFlag = false
	skip processing bit, set if hit processing skipped due to queueDepth too high

unsigned short	m_ctime = 0
	event header ctime

unsigned short	m_phase = 0
	hardware phase

unsigned short	m_asicMask = 0
	bit field of masked ASICs (timeoutMask \| setMask)

unsigned short	m_eventQueueDepth = 0
	trigger FIFO queue depth

unsigned short	m_eventNumberByte = 0
	frontend internal event number (8LSB)

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 debugging information about the event headers in the by the TOP production debugging raw data format one of these should be available per boardstack per event.

Definition at line 22 of file TOPProductionEventDebug.h.

Constructor & Destructor Documentation

◆ TOPProductionEventDebug() [1/2]

TOPProductionEventDebug ( )

inline

Default constructor.

Definition at line 28 of file TOPProductionEventDebug.h.

29 {}

◆ TOPProductionEventDebug() [2/2]

TOPProductionEventDebug	(	unsigned short	formatType,
		unsigned short	formatVersion,
		unsigned	scrodID,
		bool	skipProcessingFlag,
		unsigned short	ctime,
		unsigned short	phase,
		unsigned short	asicMask,
		unsigned short	eventQueueDepth,
		unsigned short	eventNumberByte
	)

inline

Full constructor.

Parameters

formatType	format type
formatVersion	format version
scrodID	hardware SCROD ID
skipProcessingFlag	flag for skip processing
ctime	CTime
phase	phase
asicMask	ASIC mask
eventQueueDepth	depth of event queue
eventNumberByte	byte of event number

Definition at line 43 of file TOPProductionEventDebug.h.

                                                           :
      m_formatType(formatType),
      m_formatVersion(formatVersion),
      m_scrodID(scrodID),
      m_skipProcessingFlag(skipProcessingFlag),
      m_ctime(ctime),
      m_phase(phase),
      m_asicMask(asicMask),
      m_eventQueueDepth(eventQueueDepth),
      m_eventNumberByte(eventNumberByte)
    {
 
    }

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.

    {
      if (object)
        DataStore::Instance().addRelation(this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                          object, object->m_cacheDataStoreEntry, object->m_cacheArrayIndex, weight, namedRelation);
    }

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

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

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

    {
      if (!sourceObj)
        return;
      auto fromRels = sourceObj->getRelationsFrom<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < fromRels.size(); iRel++) {
        fromRels.object(iRel)->addRelationTo(this, fromRels.weight(iRel));
      }
 
      auto toRels = sourceObj->getRelationsTo<RelationsInterface<BASE>>("ALL");
      for (unsigned int iRel = 0; iRel < toRels.size(); iRel++) {
        this->addRelationTo(toRels.object(iRel), toRels.weight(iRel));
      }
    }

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

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheArrayIndex;
    }

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

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      return m_cacheDataStoreEntry ? m_cacheDataStoreEntry->name : "";
    }

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

    {
      DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);
      if (!m_cacheDataStoreEntry)
        return nullptr;
      return m_cacheDataStoreEntry->getPtrAsArray();
    }

◆ getAsicMask()

unsigned short getAsicMask ( ) const

inline

Returns bit field of masked ASICs.

Returns: asicMask

Definition at line 107 of file TOPProductionEventDebug.h.

107{ return m_asicMask; }

◆ getCtime()

unsigned short getCtime ( ) const

inline

Returns event header ctime.

Returns: event header ctime

Definition at line 95 of file TOPProductionEventDebug.h.

95{ return m_ctime; }

◆ getEventNumberByte()

unsigned short getEventNumberByte ( ) const

inline

Returns least significant byte of FE event number.

Returns: least significant byte of FE event number

Definition at line 119 of file TOPProductionEventDebug.h.

119{ return m_eventNumberByte; }

◆ getEventQueueDepth()

unsigned short getEventQueueDepth ( ) const

inline

Returns trigger FIFO queue depth.

Returns: eventQueueDepth

Definition at line 113 of file TOPProductionEventDebug.h.

113{ return m_eventQueueDepth; }

◆ getFormatType()

unsigned short getFormatType ( ) const

inline

Returns data format type number.

Returns: format type

Definition at line 70 of file TOPProductionEventDebug.h.

70{ return m_formatType; }

◆ getFormatVersion()

unsigned short getFormatVersion ( ) const

inline

Returns data format version number.

Returns: data format version

Definition at line 76 of file TOPProductionEventDebug.h.

76{ return m_formatVersion; }

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

    {
      return _RelationsInterfaceImpl::htmlToPlainText(getInfoHTML());
    }

◆ 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 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 ""; }

◆ getPhase()

unsigned short getPhase ( ) const

inline

Returns event phase.

Returns: event phase

Definition at line 101 of file TOPProductionEventDebug.h.

101{ return m_phase; }

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

    {
      return static_cast<T*>(DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                             T::Class(), name, namedRelation).object);
    }

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

    {
      return static_cast<FROM*>(DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);
    }

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

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  FROM::Class(), name, namedRelation);
      return std::make_pair(static_cast<FROM*>(entry.object), entry.weight);
    }

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

    {
      return static_cast<TO*>(DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                              TO::Class(), name, namedRelation).object);
    }

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

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  TO::Class(), name, namedRelation);
      return std::make_pair(static_cast<TO*>(entry.object), entry.weight);
    }

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

    {
      RelationEntry entry = DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,
                                                                  T::Class(), name, namedRelation);
      return std::make_pair(static_cast<T*>(entry.object), entry.weight);
    }

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

    {
      return RelationVector<FROM>(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,
                                  m_cacheArrayIndex, FROM::Class(), name, namedRelation));
    }

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

    {
      return RelationVector<TO>(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry,
                                m_cacheArrayIndex, TO::Class(), name, namedRelation));
    }

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

    {
      return RelationVector<T>(DataStore::Instance().getRelationsWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry,
                               m_cacheArrayIndex, T::Class(), name, namedRelation));
    }

◆ getScrodID()

unsigned short getScrodID ( ) const

inline

Returns SCROD ID.

Returns: SCROD ID

Definition at line 82 of file TOPProductionEventDebug.h.

82{ return m_scrodID; }

◆ getSkipProcessingFlag()

bool getSkipProcessingFlag ( ) const

inline

Returns skip processing bit.

Returns: skip processing bit

Definition at line 88 of file TOPProductionEventDebug.h.

88{ return m_skipProcessingFlag; }

Member Data Documentation

◆ m_asicMask

unsigned short m_asicMask = 0

private

bit field of masked ASICs (timeoutMask | setMask)

Definition at line 129 of file TOPProductionEventDebug.h.

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

unsigned short m_ctime = 0

private

event header ctime

Definition at line 127 of file TOPProductionEventDebug.h.

◆ m_eventNumberByte

unsigned short m_eventNumberByte = 0

private

frontend internal event number (8LSB)

Definition at line 131 of file TOPProductionEventDebug.h.

◆ m_eventQueueDepth

unsigned short m_eventQueueDepth = 0

private

trigger FIFO queue depth

Definition at line 130 of file TOPProductionEventDebug.h.

◆ m_formatType

unsigned short m_formatType = 0

private

data format type specifier

Definition at line 123 of file TOPProductionEventDebug.h.

◆ m_formatVersion

unsigned short m_formatVersion = 0

private

data format version specifier

Definition at line 124 of file TOPProductionEventDebug.h.

◆ m_phase

unsigned short m_phase = 0

private

hardware phase

Definition at line 128 of file TOPProductionEventDebug.h.

◆ m_scrodID

unsigned short m_scrodID = 0

private

hardware SCROD ID

Definition at line 125 of file TOPProductionEventDebug.h.

◆ m_skipProcessingFlag

bool m_skipProcessingFlag = false

private

skip processing bit, set if hit processing skipped due to queueDepth too high

Definition at line 126 of file TOPProductionEventDebug.h.

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

top/dataobjects/include/TOPProductionEventDebug.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TOPProductionEventDebug() [1/2]

◆ TOPProductionEventDebug() [2/2]

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getArrayIndex()

◆ getArrayName()

◆ getArrayPointer()

◆ getAsicMask()

◆ getCtime()

◆ getEventNumberByte()

◆ getEventQueueDepth()

◆ getFormatType()

◆ getFormatVersion()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getPhase()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getScrodID()

◆ getSkipProcessingFlag()

Member Data Documentation

◆ m_asicMask

◆ m_cacheArrayIndex

◆ m_cacheDataStoreEntry

◆ m_ctime

◆ m_eventNumberByte

◆ m_eventQueueDepth

◆ m_formatType

◆ m_formatVersion

◆ m_phase

◆ m_scrodID

◆ m_skipProcessingFlag