Simulated hardware clock state. More...

#include <SimClockState.h>

Inheritance diagram for SimClockState:

Public Member Functions
	SimClockState ()
	Default constructor.

void	setRevo9Count (unsigned count)
	Sets the number of system clock ticks since last revo9 marker.

void	setBucketNumber (unsigned bucket)
	Sets RF bucket number of the collision.

void	setBeamCycleNumber (unsigned beamCycle)
	Sets beam revolution count since last revo9 marker.

void	setRelativeBucketNo (int relativeBucket)
	Sets the relativeBucket number, i.e.

unsigned	getRevo9Count () const
	Returns the number of system clock ticks since last revo9 marker.

unsigned	getBucketNumber () const
	Returns RF bucket number of the collision.

unsigned	getBeamCycleNumber () const
	Returs beam revolution count since last revo9 marker.

unsigned	getSVDTriggerBin (unsigned offset=2) const
	Returns SVD trigger bin.

unsigned	getCDCTriggerBin (unsigned offset=0) const
	Returns CDC trigger bin.

int	getRelativeBucketNo () const
	Returns the distance (in bucket number) between the collision bunch crossing and the bucket corresponding to the L1 trigger signal.

void	addRelationTo (const RelationsInterface< TObject > *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	addRelationTo (const RelationsInterface< TObject > *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< TObject > *sourceObj)
	Copies all relations of sourceObj (pointing from or to sourceObj) to this object (including weights).

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

RelationVector< TO >	getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from this object to another store array.

RelationVector< TO >	getRelationsTo (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from this object to another store array.

RelationVector< FROM >	getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from another store array to this object.

RelationVector< FROM >	getRelationsFrom (const std::string &name="", const std::string &namedRelation="") const
	Get the relations that point from another store array to this object.

RelationVector< T >	getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
	Get the relations between this object and another store array.

RelationVector< T >	getRelationsWith (const std::string &name="", const std::string &namedRelation="") const
	Get the relations between this object and another store array.

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

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

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

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

T *	getRelated (const std::string &name="", const std::string &namedRelation="") const
	Get the object to or from which this object has a relation.

T *	getRelated (const std::string &name="", const std::string &namedRelation="") const
	Get the object to or from which this object has a relation.

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.

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.

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.

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.

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.

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

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

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.

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

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 (SimClockState, 2)
	ClassDef.

Private Attributes
int	m_relativeBucketNo = 0
	jitter measured in units of number-of-buckets

unsigned	m_revo9Count = 0
	number of system clock ticks since last revo9 marker

unsigned	m_bucketNumber = 0
	RF bucket number of the collision.

unsigned	m_beamCycle = 0
	beam revolution count since last revo9 marker

DataStore::StoreEntry *	m_cacheDataStoreEntry
	Cache of the data store entry to which this object belongs.

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.

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

Detailed Description

Simulated hardware clock state.

This class is used to distribute to sub-detectors the clock state generated in EventT0Generator.

Note: StoreObjPtr must be registered as optional and the validity must be checked before using it, because the module that creates it is optional in add_simulation.

Definition at line 27 of file SimClockState.h.

Constructor & Destructor Documentation

◆ SimClockState()

SimClockState ( )

inline

Default constructor.

Definition at line 34 of file SimClockState.h.

35 {}

Member Function Documentation

◆ addRelationTo() [1/4]

void addRelationTo	(	const RelationsInterface< TObject > *	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/4]

void addRelationTo	(	const RelationsInterface< TObject > *	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() [3/4]

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

◆ addRelationTo() [4/4]

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() [1/2]

void copyRelations ( const RelationsInterface< TObject > * 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));
      }
    }

◆ copyRelations() [2/2]

void copyRelations ( const RelationsInterface< TObject > * 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() [1/2]

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 {

387 DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);

388 return m_cacheArrayIndex;

389 }

◆ getArrayIndex() [2/2]

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 {

387 DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);

388 return m_cacheArrayIndex;

389 }

◆ getArrayName() [1/2]

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.

378 {

379 DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);

380 return m_cacheDataStoreEntry ? m_cacheDataStoreEntry->name : "";

381 }

◆ getArrayName() [2/2]

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.

378 {

379 DataStore::Instance().findStoreEntry(this, m_cacheDataStoreEntry, m_cacheArrayIndex);

380 return m_cacheDataStoreEntry ? m_cacheDataStoreEntry->name : "";

381 }

◆ getArrayPointer() [1/2]

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

◆ getArrayPointer() [2/2]

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

◆ getBeamCycleNumber()

unsigned getBeamCycleNumber ( ) const

inline

Returs beam revolution count since last revo9 marker.

Returns: beam revolution count

Definition at line 81 of file SimClockState.h.

81{return m_beamCycle;}

◆ getBucketNumber()

unsigned getBucketNumber ( ) const

inline

Returns RF bucket number of the collision.

Returns: bucket number

Definition at line 75 of file SimClockState.h.

75{return m_bucketNumber;}

◆ getCDCTriggerBin()

unsigned getCDCTriggerBin ( unsigned offset = 0 ) const

inline

Returns CDC trigger bin.

Default value for offset put as 0 for now.

Parameters

offset offset

Returns: CDC trigger bin

Definition at line 97 of file SimClockState.h.

97{return (m_revo9Count + offset) % 4;}

◆ getInfo() [1/2]

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 {

372 return _RelationsInterfaceImpl::htmlToPlainText(getInfoHTML());

373 }

◆ getInfo() [2/2]

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 {

372 return _RelationsInterfaceImpl::htmlToPlainText(getInfoHTML());

373 }

◆ getInfoHTML() [1/2]

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 << "PDG: " << m_pdg << " ";

out << "Covariance Matrix: " << HTML::getString(getCovariance5()) << " ";

return out.str();

Belle2::HTML::getString

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

Definition at line 362 of file RelationsObject.h.

362{ return ""; }

◆ getInfoHTML() [2/2]

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 << "PDG: " << m_pdg << " ";

out << "Covariance Matrix: " << HTML::getString(getCovariance5()) << " ";

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

Definition at line 362 of file RelationsObject.h.

362{ return ""; }

◆ getName() [1/2]

virtual std::string getName ( ) const

inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in MCParticle, Particle, and SpacePoint.

Definition at line 344 of file RelationsObject.h.

344{ return ""; }

◆ getName() [2/2]

virtual std::string getName ( ) const

inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in MCParticle, Particle, and SpacePoint.

Definition at line 344 of file RelationsObject.h.

344{ return ""; }

◆ getRelated() [1/2]

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.

279 {

280 return static_cast<T*>(DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,

281 T::Class(), name, namedRelation).object);

282 }

◆ getRelated() [2/2]

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.

279 {

280 return static_cast<T*>(DataStore::Instance().getRelationWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry, m_cacheArrayIndex,

281 T::Class(), name, namedRelation).object);

282 }

◆ getRelatedFrom() [1/2]

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.

264 {

265 return static_cast<FROM*>(DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,

266 m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);

267 }

◆ getRelatedFrom() [2/2]

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.

264 {

265 return static_cast<FROM*>(DataStore::Instance().getRelationWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,

266 m_cacheArrayIndex, FROM::Class(), name, namedRelation).object);

267 }

◆ getRelatedFromWithWeight() [1/2]

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

◆ getRelatedFromWithWeight() [2/2]

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() [1/2]

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.

249 {

250 return static_cast<TO*>(DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,

251 TO::Class(), name, namedRelation).object);

252 }

◆ getRelatedTo() [2/2]

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.

249 {

250 return static_cast<TO*>(DataStore::Instance().getRelationWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry, m_cacheArrayIndex,

251 TO::Class(), name, namedRelation).object);

252 }

◆ getRelatedToWithWeight() [1/2]

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

◆ getRelatedToWithWeight() [2/2]

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() [1/2]

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

◆ getRelatedWithWeight() [2/2]

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() [1/2]

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.

214 {

215 return RelationVector<FROM>(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,

216 m_cacheArrayIndex, FROM::Class(), name, namedRelation));

217 }

◆ getRelationsFrom() [2/2]

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.

214 {

215 return RelationVector<FROM>(DataStore::Instance().getRelationsWith(DataStore::c_FromSide, this, m_cacheDataStoreEntry,

216 m_cacheArrayIndex, FROM::Class(), name, namedRelation));

217 }

◆ getRelationsTo() [1/2]

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.

198 {

199 return RelationVector<TO>(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry,

200 m_cacheArrayIndex, TO::Class(), name, namedRelation));

201 }

◆ getRelationsTo() [2/2]

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.

198 {

199 return RelationVector<TO>(DataStore::Instance().getRelationsWith(DataStore::c_ToSide, this, m_cacheDataStoreEntry,

200 m_cacheArrayIndex, TO::Class(), name, namedRelation));

201 }

◆ getRelationsWith() [1/2]

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.

231 {

232 return RelationVector<T>(DataStore::Instance().getRelationsWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry,

233 m_cacheArrayIndex, T::Class(), name, namedRelation));

234 }

◆ getRelationsWith() [2/2]

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.

231 {

232 return RelationVector<T>(DataStore::Instance().getRelationsWith(DataStore::c_BothSides, this, m_cacheDataStoreEntry,

233 m_cacheArrayIndex, T::Class(), name, namedRelation));

234 }

◆ getRelativeBucketNo()

int getRelativeBucketNo ( ) const

inline

Returns the distance (in bucket number) between the collision bunch crossing and the bucket corresponding to the L1 trigger signal.

Returns: relative bucket number

Definition at line 105 of file SimClockState.h.

105{return m_relativeBucketNo;}

◆ getRevo9Count()

unsigned getRevo9Count ( ) const

inline

Returns the number of system clock ticks since last revo9 marker.

System clock runs with a frequency of RF/4 ~ 127 MHz.

Returns: number of system clock ticks

Definition at line 69 of file SimClockState.h.

69{return m_revo9Count;}

◆ getSVDTriggerBin()

unsigned getSVDTriggerBin ( unsigned offset = 2 ) const

inline

Returns SVD trigger bin.

Default value for offset determined on rawdata of run 7/1500 using SVDEventInfo and TOPRawDigits.

Parameters

offset offset

Returns: SVD trigger bin

Definition at line 89 of file SimClockState.h.

89{return (m_revo9Count + offset) % 4;}

◆ setBeamCycleNumber()

void setBeamCycleNumber ( unsigned beamCycle )

inline

Sets beam revolution count since last revo9 marker.

Parameters

beamCycle beam revolution count

Definition at line 53 of file SimClockState.h.

53{m_beamCycle = beamCycle;}

◆ setBucketNumber()

void setBucketNumber ( unsigned bucket )

inline

Sets RF bucket number of the collision.

Parameters

bucket bucket number

Definition at line 47 of file SimClockState.h.

47{m_bucketNumber = bucket;}

◆ setRelativeBucketNo()

void setRelativeBucketNo ( int relativeBucket )

inline

Sets the relativeBucket number, i.e.

the number of buckets between the collision bunch crossing and the L1 trigger signal. In other words: it sets the jitter measured in units of number of buckets.

Definition at line 62 of file SimClockState.h.

62{m_relativeBucketNo = relativeBucket;}

◆ setRevo9Count()

void setRevo9Count ( unsigned count )

inline

Sets the number of system clock ticks since last revo9 marker.

Parameters

count number of system clock ticks

Definition at line 41 of file SimClockState.h.

41{m_revo9Count = count;}

Member Data Documentation

◆ m_beamCycle

unsigned m_beamCycle = 0

private

beam revolution count since last revo9 marker

Definition at line 113 of file SimClockState.h.

◆ m_bucketNumber

unsigned m_bucketNumber = 0

private

RF bucket number of the collision.

Definition at line 112 of file SimClockState.h.

◆ m_cacheArrayIndex [1/2]

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_cacheArrayIndex [2/2]

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 [1/2]

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_cacheDataStoreEntry [2/2]

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_relativeBucketNo

int m_relativeBucketNo = 0

private

jitter measured in units of number-of-buckets

Definition at line 109 of file SimClockState.h.

◆ m_revo9Count

unsigned m_revo9Count = 0

private

number of system clock ticks since last revo9 marker

Definition at line 111 of file SimClockState.h.

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

simulation/dataobjects/include/SimClockState.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SimClockState()

Member Function Documentation

◆ addRelationTo() [1/4]

◆ addRelationTo() [2/4]

◆ addRelationTo() [3/4]

◆ addRelationTo() [4/4]

◆ copyRelations() [1/2]

◆ copyRelations() [2/2]

◆ getArrayIndex() [1/2]

◆ getArrayIndex() [2/2]

◆ getArrayName() [1/2]

◆ getArrayName() [2/2]

◆ getArrayPointer() [1/2]

◆ getArrayPointer() [2/2]

◆ getBeamCycleNumber()

◆ getBucketNumber()

◆ getCDCTriggerBin()

◆ getInfo() [1/2]

◆ getInfo() [2/2]

◆ getInfoHTML() [1/2]

◆ getInfoHTML() [2/2]

◆ getName() [1/2]

◆ getName() [2/2]

◆ getRelated() [1/2]

◆ getRelated() [2/2]

◆ getRelatedFrom() [1/2]

◆ getRelatedFrom() [2/2]

◆ getRelatedFromWithWeight() [1/2]

◆ getRelatedFromWithWeight() [2/2]

◆ getRelatedTo() [1/2]

◆ getRelatedTo() [2/2]

◆ getRelatedToWithWeight() [1/2]

◆ getRelatedToWithWeight() [2/2]

◆ getRelatedWithWeight() [1/2]

◆ getRelatedWithWeight() [2/2]

◆ getRelationsFrom() [1/2]

◆ getRelationsFrom() [2/2]

◆ getRelationsTo() [1/2]

◆ getRelationsTo() [2/2]

◆ getRelationsWith() [1/2]

◆ getRelationsWith() [2/2]

◆ getRelativeBucketNo()

◆ getRevo9Count()

◆ getSVDTriggerBin()

◆ setBeamCycleNumber()

◆ setBucketNumber()

◆ setRelativeBucketNo()

◆ setRevo9Count()

Member Data Documentation

◆ m_beamCycle

◆ m_bucketNumber

◆ m_cacheArrayIndex [1/2]

◆ m_cacheArrayIndex [2/2]

◆ m_cacheDataStoreEntry [1/2]

◆ m_cacheDataStoreEntry [2/2]

◆ m_relativeBucketNo

◆ m_revo9Count