Example Detector. More...

#include <TRGTOPCombinedT0Decision.h>

Inheritance diagram for TRGTOPCombinedT0Decision:

Public Member Functions
	TRGTOPCombinedT0Decision (int combinedT0)
	A Useful Constructor.

	TRGTOPCombinedT0Decision (int combinedT0, int rvcNow, int combinedT0ClockCycle, int combinedT0RVC2GDL, int eventNumberL1, int rvcL1)
	Another Useful Constructor.

	~TRGTOPCombinedT0Decision ()
	Destructor.

int	getCombinedT0 () const

int	getRVCNow () const

int	getCombinedT0ClockCycle () const

int	getCombinedT0RVC2GDL () const

int	getEventNumberL1 () const

int	getRVCL1 () const

void	setCombinedT0 (int combinedT0)

void	setRVCNow (int rvcNow)

void	setCombinedT0ClockCycle (int combinedT0ClockCycle)

void	setCombinedT0RVC2GDL (int combinedT0RVC2GDL)

void	setEventNumberL1 (int eventNumberL1)

void	setRVCL1 (int rvcL1)

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

Private Attributes
int	m_combinedT0
	combined t0 (in ns)

int	m_rvcNow
	rvc at the time when this t0 was posted in FW

int	m_combinedT0ClockCycle
	clock cycle number in b2l buffer when this t0 was posted to b2l

int	m_combinedT0RVC2GDL
	rvc at the time when this t0 was supposed to be posted to GDL

int	m_eventNumberL1
	L1 event number from header.

int	m_rvcL1
	rvc at the time L1 was issued (for latency and window width studies)

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

Example Detector.

Definition at line 28 of file TRGTOPCombinedT0Decision.h.

Constructor & Destructor Documentation

◆ TRGTOPCombinedT0Decision() [1/3]

TRGTOPCombinedT0Decision ( )

inline

Definition at line 34 of file TRGTOPCombinedT0Decision.h.

                               :
      m_combinedT0(0),
      m_rvcNow(0),
      m_combinedT0ClockCycle(0),
      m_combinedT0RVC2GDL(0),
      m_eventNumberL1(0),
      m_rvcL1(0)
    {}

◆ TRGTOPCombinedT0Decision() [2/3]

TRGTOPCombinedT0Decision ( int combinedT0 )

inlineexplicit

A Useful Constructor.

Definition at line 44 of file TRGTOPCombinedT0Decision.h.

      :
      m_combinedT0(combinedT0)
    {}

◆ TRGTOPCombinedT0Decision() [3/3]

TRGTOPCombinedT0Decision	(	int	combinedT0,
		int	rvcNow,
		int	combinedT0ClockCycle,
		int	combinedT0RVC2GDL,
		int	eventNumberL1,
		int	rvcL1
	)

inline

Another Useful Constructor.

Definition at line 51 of file TRGTOPCombinedT0Decision.h.

      :
      m_combinedT0(combinedT0),
      m_rvcNow(rvcNow),
      m_combinedT0ClockCycle(combinedT0ClockCycle),
      m_combinedT0RVC2GDL(combinedT0RVC2GDL),
      m_eventNumberL1(eventNumberL1),
      m_rvcL1(rvcL1)
    {}

◆ ~TRGTOPCombinedT0Decision()

~TRGTOPCombinedT0Decision ( )

inline

Destructor.

Definition at line 69 of file TRGTOPCombinedT0Decision.h.

69{}

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

◆ getCombinedT0()

int getCombinedT0 ( ) const

inline

Definition at line 71 of file TRGTOPCombinedT0Decision.h.

71{ return m_combinedT0; }

◆ getCombinedT0ClockCycle()

int getCombinedT0ClockCycle ( ) const

inline

Definition at line 73 of file TRGTOPCombinedT0Decision.h.

73{ return m_combinedT0ClockCycle; }

◆ getCombinedT0RVC2GDL()

int getCombinedT0RVC2GDL ( ) const

inline

Definition at line 74 of file TRGTOPCombinedT0Decision.h.

74{ return m_combinedT0RVC2GDL; }

◆ getEventNumberL1()

int getEventNumberL1 ( ) const

inline

Definition at line 75 of file TRGTOPCombinedT0Decision.h.

75{ return m_eventNumberL1; }

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

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

◆ getRVCL1()

int getRVCL1 ( ) const

inline

Definition at line 76 of file TRGTOPCombinedT0Decision.h.

76{ return m_rvcL1; }

◆ getRVCNow()

int getRVCNow ( ) const

inline

Definition at line 72 of file TRGTOPCombinedT0Decision.h.

72{ return m_rvcNow; }

◆ setCombinedT0()

void setCombinedT0 ( int combinedT0 )

Definition at line 16 of file TRGTOPCombinedT0Decision.cc.

16{ m_combinedT0 = combinedT0 ; }

◆ setCombinedT0ClockCycle()

void setCombinedT0ClockCycle ( int combinedT0ClockCycle )

Definition at line 18 of file TRGTOPCombinedT0Decision.cc.

18{ m_combinedT0ClockCycle = combinedT0ClockCycle ; }

◆ setCombinedT0RVC2GDL()

void setCombinedT0RVC2GDL ( int combinedT0RVC2GDL )

Definition at line 19 of file TRGTOPCombinedT0Decision.cc.

19{ m_combinedT0RVC2GDL = combinedT0RVC2GDL ; }

◆ setEventNumberL1()

void setEventNumberL1 ( int eventNumberL1 )

Definition at line 20 of file TRGTOPCombinedT0Decision.cc.

20{ m_eventNumberL1 = eventNumberL1 ; }

◆ setRVCL1()

void setRVCL1 ( int rvcL1 )

Definition at line 21 of file TRGTOPCombinedT0Decision.cc.

21{ m_rvcL1 = rvcL1 ; }

◆ setRVCNow()

void setRVCNow ( int rvcNow )

Definition at line 17 of file TRGTOPCombinedT0Decision.cc.

17{ m_rvcNow = rvcNow ; }

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_combinedT0

int m_combinedT0

private

combined t0 (in ns)

Definition at line 90 of file TRGTOPCombinedT0Decision.h.

◆ m_combinedT0ClockCycle

int m_combinedT0ClockCycle

private

clock cycle number in b2l buffer when this t0 was posted to b2l

Definition at line 94 of file TRGTOPCombinedT0Decision.h.

◆ m_combinedT0RVC2GDL

int m_combinedT0RVC2GDL

private

rvc at the time when this t0 was supposed to be posted to GDL

Definition at line 96 of file TRGTOPCombinedT0Decision.h.

◆ m_eventNumberL1

int m_eventNumberL1

private

L1 event number from header.

Definition at line 98 of file TRGTOPCombinedT0Decision.h.

◆ m_rvcL1

int m_rvcL1

private

rvc at the time L1 was issued (for latency and window width studies)

Definition at line 100 of file TRGTOPCombinedT0Decision.h.

◆ m_rvcNow

int m_rvcNow

private

rvc at the time when this t0 was posted in FW

Definition at line 92 of file TRGTOPCombinedT0Decision.h.

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

trg/top/dataobjects/include/TRGTOPCombinedT0Decision.h
trg/top/dataobjects/src/TRGTOPCombinedT0Decision.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TRGTOPCombinedT0Decision() [1/3]

◆ TRGTOPCombinedT0Decision() [2/3]

◆ TRGTOPCombinedT0Decision() [3/3]

◆ ~TRGTOPCombinedT0Decision()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getArrayIndex()

◆ getArrayName()

◆ getArrayPointer()

◆ getCombinedT0()

◆ getCombinedT0ClockCycle()

◆ getCombinedT0RVC2GDL()

◆ getEventNumberL1()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getRVCL1()

◆ getRVCNow()

◆ setCombinedT0()

◆ setCombinedT0ClockCycle()

◆ setCombinedT0RVC2GDL()

◆ setEventNumberL1()

◆ setRVCL1()

◆ setRVCNow()

Member Data Documentation

◆ m_cacheArrayIndex

◆ m_cacheDataStoreEntry

◆ m_combinedT0

◆ m_combinedT0ClockCycle

◆ m_combinedT0RVC2GDL

◆ m_eventNumberL1

◆ m_rvcL1

◆ m_rvcNow