KLMDigitRaw Class Reference

Class to store the raw words from the unpacker, digit-by-digit. More...

#include <KLMDigitRaw.h>

Inheritance diagram for KLMDigitRaw:

Public Member Functions
	KLMDigitRaw ()
	Default constructor.
	KLMDigitRaw (int copper, int slot, uint16_t word1, uint16_t word2, uint16_t word3, uint16_t word4)
	Explicit constructor.
int	getCopper () const
	Get copper identifier.
int	getSlot () const
	Get slot number.
uint16_t	getWord1 () const
	Get the first (of four) raw words.
uint16_t	getWord2 () const
	Get the second (of four) raw words.
uint16_t	getWord3 () const
	Get the third (of four) raw words.
uint16_t	getWord4 () const
	Get the fourth (of four) raw words.
uint16_t	getChannel () const
	Get the channel number.
uint16_t	getAxis () const
	Get the view (= axis = plane) number.
uint16_t	getLane () const
	Get the lane number.
uint16_t	getFlag () const
	Get the status flag.
uint16_t	getCtime () const
	Get CTIME.
uint16_t	getTdc ()
	Get TDC.
uint16_t	getTriggerBits ()
	Get trigger bits.
uint16_t	getCharge ()
	Get charge.
uint16_t	getFEStatus ()
	Get FE.
uint16_t	getUnusedBits ()
	Get unused bits from the fourth word.
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 (KLMDigitRaw, 2)
	Class version.

Private Attributes
int	m_Copper
	Copper identifier.
int	m_Slot
	Slot number.
uint16_t	m_word1
	First (of four) raw-data words (contains channel number).
uint16_t	m_word2
	Second (of four) raw-data words (contains view/axis/plane).
uint16_t	m_word3
	Third (of four) raw-data words (contains lane number).
uint16_t	m_word4
	Fourth (of four) raw-data words (contains status flag).
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 the raw words from the unpacker, digit-by-digit.

Definition at line 29 of file KLMDigitRaw.h.

Constructor & Destructor Documentation

KLMDigitRaw() [1/2]

KLMDigitRaw ( )

inline

Default constructor.

Definition at line 36 of file KLMDigitRaw.h.

                 :
      m_Copper(0),
      m_Slot(0),
      m_word1(0),
      m_word2(0),
      m_word3(0),
      m_word4(0)
    {
    }

KLMDigitRaw() [2/2]

KLMDigitRaw ( int  copper, int  slot, uint16_t  word1, uint16_t  word2, uint16_t  word3, uint16_t  word4  )

inline

Explicit constructor.

Definition at line 49 of file KLMDigitRaw.h.

                                               :
      m_Copper(copper),
      m_Slot(slot),
      m_word1(word1),
      m_word2(word2),
      m_word3(word3),
      m_word4(word4)
    {
    }

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

getAxis()

uint16_t getAxis ( ) const

inline

Get the view (= axis = plane) number.

Definition at line 119 of file KLMDigitRaw.h.

    {
      return KLM::RawData::unpackAxis(m_word1);
    }

getChannel()

uint16_t getChannel ( ) const

inline

Get the channel number.

Definition at line 111 of file KLMDigitRaw.h.

    {
      return KLM::RawData::unpackChannel(m_word1);
    }

getCharge()

uint16_t getCharge ( )

inline

Get charge.

Definition at line 167 of file KLMDigitRaw.h.

    {
      return KLM::RawData::unpackCharge(m_word4);
    }

getCopper()

int getCopper ( ) const

inline

Get copper identifier.

Definition at line 63 of file KLMDigitRaw.h.

    {
      return m_Copper;
    }

getCtime()

uint16_t getCtime ( ) const

inline

Get CTIME.

Definition at line 143 of file KLMDigitRaw.h.

    {
      return KLM::RawData::unpackCTime(m_word2);
    }

getFEStatus()

uint16_t getFEStatus ( )

inline

Get FE.

Definition at line 175 of file KLMDigitRaw.h.

    {
      return KLM::RawData::unpackFE(m_word4);
    }

getFlag()

uint16_t getFlag ( ) const

inline

Get the status flag.

Definition at line 135 of file KLMDigitRaw.h.

    {
      return KLM::RawData::unpackType(m_word1);
    }

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.

{ return ""; }

getLane()

uint16_t getLane ( ) const

inline

Get the lane number.

Definition at line 127 of file KLMDigitRaw.h.

    {
      return KLM::RawData::unpackLane(m_word1);
    }

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.

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

getSlot()

int getSlot ( ) const

inline

Get slot number.

Definition at line 71 of file KLMDigitRaw.h.

    {
      return m_Slot;
    }

getTdc()

uint16_t getTdc ( )

inline

Get TDC.

Definition at line 151 of file KLMDigitRaw.h.

    {
      return KLM::RawData::unpackTDC(m_word3);
    }

getTriggerBits()

uint16_t getTriggerBits ( )

inline

Get trigger bits.

Definition at line 159 of file KLMDigitRaw.h.

    {
      return KLM::RawData::unpackTriggerBits(m_word3);
    }

getUnusedBits()

uint16_t getUnusedBits ( )

inline

Get unused bits from the fourth word.

Definition at line 183 of file KLMDigitRaw.h.

    {
      return m_word4 >> 12;
    }

getWord1()

uint16_t getWord1 ( ) const

inline

Get the first (of four) raw words.

Definition at line 79 of file KLMDigitRaw.h.

    {
      return m_word1;
    }

getWord2()

uint16_t getWord2 ( ) const

inline

Get the second (of four) raw words.

Definition at line 87 of file KLMDigitRaw.h.

    {
      return m_word2;
    }

getWord3()

uint16_t getWord3 ( ) const

inline

Get the third (of four) raw words.

Definition at line 95 of file KLMDigitRaw.h.

    {
      return m_word3;
    }

getWord4()

uint16_t getWord4 ( ) const

inline

Get the fourth (of four) raw words.

Definition at line 103 of file KLMDigitRaw.h.

    {
      return m_word4;
    }

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_Copper

int m_Copper

private

Copper identifier.

Definition at line 191 of file KLMDigitRaw.h.

m_Slot

int m_Slot

private

Slot number.

Definition at line 194 of file KLMDigitRaw.h.

m_word1

uint16_t m_word1

private

First (of four) raw-data words (contains channel number).

Definition at line 197 of file KLMDigitRaw.h.

m_word2

uint16_t m_word2

private

Second (of four) raw-data words (contains view/axis/plane).

Definition at line 200 of file KLMDigitRaw.h.

m_word3

uint16_t m_word3

private

Third (of four) raw-data words (contains lane number).

Definition at line 203 of file KLMDigitRaw.h.

m_word4

uint16_t m_word4

private

Fourth (of four) raw-data words (contains status flag).

Definition at line 206 of file KLMDigitRaw.h.

---

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

• klm/dataobjects/include/KLMDigitRaw.h