The CDCRawHitWaveForm (Full output mode) class. More...

#include <CDCRawHitWaveForm.h>

Inheritance diagram for CDCRawHitWaveForm:

Public Member Functions
	CDCRawHitWaveForm ()
	Default constructor.

	CDCRawHitWaveForm (unsigned short status, int trgNumber, unsigned short node, unsigned short finess, unsigned short board, unsigned short channel, unsigned short sample, unsigned short trgTime, unsigned short adc, unsigned short tdc)
	Constructor.

int	getStatus (void) const
	Getter for status.

virtual	~CDCRawHitWaveForm ()
	Destructor.

void	setTriggerNumber (int trgNumber)
	Setter for trigger number.

int	getTriggerNumber (void) const
	Getter for trigger number.

void	setNode (unsigned short node)
	Setter for Node ID.

unsigned short	getNode (void) const
	Getter for Node ID.

void	setFiness (unsigned short finess)
	Setter for Finess ID.

unsigned short	getFiness (void) const
	Getter for Finess ID.

unsigned short	getADC (void) const
	Getter for ADC.

unsigned short	getTDC (void) const
	Getter for TDC.

unsigned short	getSample (void) const
	Getter for samplint point.

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 (CDCRawHitWaveForm, 1)
	To derive from TObject.

Private Attributes
unsigned short	m_status
	Status of data block.

int	m_triggerNumber
	Trigger number.

unsigned short	m_node
	Copper node ID.

unsigned short	m_finess
	Finess Slot ID.

unsigned short	m_board
	FEE boad ID.

unsigned short	m_channel
	Channel in a FEE (0-47).

unsigned short	m_triggerTime
	Trigger Timing.

unsigned short	m_sample
	Index of FADC sampling.

unsigned short	m_adc
	FADC count.

unsigned short	m_tdc
	TDC count (not subtracted by trigger time).

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

The CDCRawHitWaveForm (Full output mode) class.

Definition at line 24 of file CDCRawHitWaveForm.h.

Constructor & Destructor Documentation

◆ CDCRawHitWaveForm() [1/2]

CDCRawHitWaveForm ( )

Default constructor.

Definition at line 14 of file CDCRawHitWaveForm.cc.

                                     :
  m_status(0), m_triggerNumber(0), m_node(0), m_finess(0), m_board(0),
  m_channel(0), m_triggerTime(0), m_sample(0), m_adc(), m_tdc()
{
}

◆ CDCRawHitWaveForm() [2/2]

CDCRawHitWaveForm	(	unsigned short	status,
		int	trgNumber,
		unsigned short	node,
		unsigned short	finess,
		unsigned short	board,
		unsigned short	channel,
		unsigned short	sample,
		unsigned short	trgTime,
		unsigned short	adc,
		unsigned short	tdc
	)

Constructor.

Definition at line 20 of file CDCRawHitWaveForm.cc.

{
  m_status = status;
  m_triggerNumber = trgNumber;
  m_node = node;
  m_finess = finess;
  m_board = board;
  m_channel = channel;
  m_triggerTime = trgTime;
  m_sample = sample;
  m_adc = adc;
  m_tdc = tdc;
}

◆ ~CDCRawHitWaveForm()

~CDCRawHitWaveForm ( )

virtual

Destructor.

Definition at line 43 of file CDCRawHitWaveForm.cc.

44{

45}

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

◆ getADC()

unsigned short getADC ( void ) const

inline

Getter for ADC.

Definition at line 110 of file CDCRawHitWaveForm.h.

    {
      return m_adc;
    }

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

◆ getFiness()

unsigned short getFiness ( void ) const

inline

Getter for Finess ID.

Definition at line 102 of file CDCRawHitWaveForm.h.

    {
      return m_finess;
    }

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

◆ getNode()

unsigned short getNode ( void ) const

inline

Getter for Node ID.

Definition at line 86 of file CDCRawHitWaveForm.h.

    {
      return m_node;
    }

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

◆ getSample()

unsigned short getSample ( void ) const

inline

Getter for samplint point.

Definition at line 126 of file CDCRawHitWaveForm.h.

    {
      return m_sample;
    }

◆ getStatus()

int getStatus ( void ) const

inline

Getter for status.

Definition at line 45 of file CDCRawHitWaveForm.h.

    {
      return m_status;
    }

◆ getTDC()

unsigned short getTDC ( void ) const

inline

Getter for TDC.

Definition at line 118 of file CDCRawHitWaveForm.h.

    {
      return m_tdc;
    }

◆ getTriggerNumber()

int getTriggerNumber ( void ) const

inline

Getter for trigger number.

Definition at line 69 of file CDCRawHitWaveForm.h.

    {
      return m_triggerNumber;
    }

◆ setFiness()

void setFiness ( unsigned short finess )

inline

Setter for Finess ID.

Definition at line 94 of file CDCRawHitWaveForm.h.

    {
      m_finess = finess;
    }

◆ setNode()

void setNode ( unsigned short node )

inline

Setter for Node ID.

Definition at line 77 of file CDCRawHitWaveForm.h.

    {
      m_node = node;
    }

◆ setTriggerNumber()

void setTriggerNumber ( int trgNumber )

inline

Setter for trigger number.

Definition at line 60 of file CDCRawHitWaveForm.h.

    {
      m_triggerNumber = trgNumber;
    }

Member Data Documentation

◆ m_adc

unsigned short m_adc

private

FADC count.

Definition at line 167 of file CDCRawHitWaveForm.h.

◆ m_board

unsigned short m_board

private

FEE boad ID.

Definition at line 151 of file CDCRawHitWaveForm.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_channel

unsigned short m_channel

private

Channel in a FEE (0-47).

Definition at line 155 of file CDCRawHitWaveForm.h.

◆ m_finess

unsigned short m_finess

private

Finess Slot ID.

Definition at line 147 of file CDCRawHitWaveForm.h.

◆ m_node

unsigned short m_node

private

Copper node ID.

Definition at line 143 of file CDCRawHitWaveForm.h.

◆ m_sample

unsigned short m_sample

private

Index of FADC sampling.

Definition at line 163 of file CDCRawHitWaveForm.h.

◆ m_status

unsigned short m_status

private

Status of data block.

Definition at line 135 of file CDCRawHitWaveForm.h.

◆ m_tdc

unsigned short m_tdc

private

TDC count (not subtracted by trigger time).

Definition at line 171 of file CDCRawHitWaveForm.h.

◆ m_triggerNumber

int m_triggerNumber

private

Trigger number.

Definition at line 139 of file CDCRawHitWaveForm.h.

◆ m_triggerTime

unsigned short m_triggerTime

private

Trigger Timing.

Definition at line 159 of file CDCRawHitWaveForm.h.

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

cdc/dataobjects/include/CDCRawHitWaveForm.h
cdc/dataobjects/src/CDCRawHitWaveForm.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CDCRawHitWaveForm() [1/2]

◆ CDCRawHitWaveForm() [2/2]

◆ ~CDCRawHitWaveForm()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getADC()

◆ getArrayIndex()

◆ getArrayName()

◆ getArrayPointer()

◆ getFiness()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getNode()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ getSample()

◆ getStatus()

◆ getTDC()

◆ getTriggerNumber()

◆ setFiness()

◆ setNode()

◆ setTriggerNumber()

Member Data Documentation

◆ m_adc

◆ m_board

◆ m_cacheArrayIndex

◆ m_cacheDataStoreEntry

◆ m_channel

◆ m_finess

◆ m_node

◆ m_sample

◆ m_status

◆ m_tdc

◆ m_triggerNumber

◆ m_triggerTime