Class to store SVD DAQ diagnostic information. More...

#include <SVDDAQDiagnostic.h>

Inheritance diagram for SVDDAQDiagnostic:

Collaboration diagram for SVDDAQDiagnostic:

[legend]

Public Types
enum	{ TriggerTypeBits = 4 , TriggerNumberBits = 8 , PipelineAddressBits = 8 , CMC1Bits = 8 , CMC2Bits = 4 , APVErrorBits = 4 , FTBErrorBits = 8 , FTBFlagsBits = 5 , EMUPipelineAddressBits = 8 , APVErrorORBits = 4 , FADCMatchBits = 1 , APVMatchBits = 1 , UpsetAPVBits = 1 , BadMappingBits = 1 , BadHeaderBits = 1 , BadTrailerBits = 1 , MissedHeaderBits = 1 , MissedTrailerBits = 1 , Bits = TriggerTypeBits + TriggerNumberBits + PipelineAddressBits + CMC1Bits + CMC2Bits + APVErrorBits + FTBErrorBits + FTBFlagsBits + EMUPipelineAddressBits + APVErrorORBits + FADCMatchBits + APVMatchBits + UpsetAPVBits + BadMappingBits + BadHeaderBits + BadTrailerBits + MissedHeaderBits + MissedTrailerBits }

Public Member Functions
	SVDDAQDiagnostic (uint8_t triggerNumber, uint8_t triggerType, uint8_t pipelineAddress, uint8_t cmc1, uint8_t cmc2, uint8_t apvError, uint8_t ftbError, bool fadcMatch, bool apvMatch, bool badHeader, bool missedHeader, bool missedTrailer, uint8_t fadcNo=uint8_t(0), uint8_t apvNo=uint8_t(0))
	Constructor. More...

	SVDDAQDiagnostic ()
	Default constructor.

uint16_t	getTriggerNumber () const
	Get the trigger number.

uint16_t	getTriggerType () const
	Get the trigger type.

uint16_t	getPipelineAddress () const
	Get the pipeline address.

uint16_t	getCMC1 () const
	Get the Common Mode Correction w/o masking out particle signals.

uint16_t	getCMC2 () const
	Get the Common Mode Correction performed after masking particle signals.

uint16_t	getAPVError () const
	Get the APV error code.

uint16_t	getFTBError () const
	Get the FTB errors field.

uint16_t	getFTBFlags () const
	Get the FTB Flags field.

uint16_t	getEmuPipelineAddress () const
	Get the emulated pipeline address.

uint16_t	getAPVErrorOR () const
	Get the APV error OR code.

bool	getAPVMatch () const
	Get the APVmatch code.

bool	getFADCMatch () const
	Get the FADCmatch code.

bool	getUpsetAPV () const
	Get the UpsetAPV code.

bool	getBadMapping () const
	Get the Bad Mapping code.

bool	getBadTrailer () const
	Get the Bad Trailer code.

bool	getBadHeader () const
	Get the Bad Header code.

bool	getMissedHeader () const
	Get the missed Header.

bool	getMissedTrailer () const
	Get the missed Trailer.

unsigned short	getFADCNumber () const
	Get FADC number.

unsigned short	getAPVNumber () const
	Get APV number.

void	setFTBFlags (uint16_t ftbFlags)
	functions for setting values unpacked from FADC trailer More...

void	setEmuPipelineAddress (uint8_t emuPipelineAddress)
	functions for setting values unpacked from FADC trailer More...

void	setApvErrorOR (uint8_t apvErrorOR)
	functions for setting values unpacked from FADC trailer More...

void	setAPVMatch (bool APVMatch)
	functions for setting values of More...

void	setFADCMatch (bool FADCMatch)
	functions for setting values of More...

void	setUpsetAPV (bool UpsetAPV)
	functions for setting values for More...

void	setBadMapping (bool BadMapping)
	functions for setting values for More...

void	setBadTrailer (bool BadTrailer)
	functions for setting values for More...

void	setMissedTrailer (bool MissedTrailer)
	functions for setting values for More...

void	setMissedHeader (bool MissedHeader)
	functions for setting values for More...

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

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

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

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

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

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

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

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

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

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

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

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

virtual std::string	getName () const
	Return a short name that describes this object, e.g. More...

virtual std::string	getInfoHTML () const
	Return a short summary of this object's contents in HTML format. More...

std::string	getInfo () const
	Return a short summary of this object's contents in raw text format. More...

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 (RelationsInterface, 0)
	defines interface for accessing relations of objects in StoreArray.

Private Attributes
uint8_t	m_triggerNumber
	Trigger number.

uint8_t	m_triggerType
	Trigger type.

uint8_t	m_pipelineAddress
	Pipeline address.

uint8_t	m_cmc1
	CMC1.

uint8_t	m_cmc2
	CMC2.

uint8_t	m_apvError
	APV error code.

uint8_t	m_ftbError
	FTB error code.

uint16_t	m_ftbFlags
	FTB Flags Field.

uint8_t	m_emuPipelineAddress
	emulated pipeline Address

uint8_t	m_apvErrorOR
	APV error code in FADC trailer.

bool	m_fadcMatch
	if # of FADC boards match # of RawData objects

bool	m_apvMatch
	if # of APV headers match # of APVs for given FADC

bool	m_upsetApv
	Upset APV.

bool	m_badMapping
	Bad mapping.

bool	m_badHeader
	Bad fadc Header.

bool	m_badTrailer
	Bad fadc Trailer.

bool	m_missedHeader
	missed Header

bool	m_missedTrailer
	missed Trailer

uint8_t	m_fadcNo
	FADC #.

uint8_t	m_apvNo
	APV #.

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 SVD DAQ diagnostic information.

Definition at line 23 of file SVDDAQDiagnostic.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
TriggerTypeBits	Number of bits available to represent a trigger type.
TriggerNumberBits	Number of bits available to represent a trigger number.
PipelineAddressBits	Number of bits available to represent a pipeline address.
CMC1Bits	Number of bits available to represent Common Mode Correction w/o masking out particle signals.
CMC2Bits	Number of bits available to represent Common Mode Correction performed after masking particle signals.
APVErrorBits	Number of bits available to represent an APV error code.
FTBErrorBits	Number of bits available to represent a FTB error code.
FTBFlagsBits	Number of bits available to represent a FTB Flags Field.
EMUPipelineAddressBits	Number of bits available to represent an Emulated pipeline adress.
APVErrorORBits	Number of bits available to represent an APV error OR code.
FADCMatchBits	Number of bits available to represent an FADC match code.
APVMatchBits	Number of bits available to represent an APV match code.
UpsetAPVBits	Number of bits available to represent an upset APV code.
BadMappingBits	Number of bits available to represent bad mapping.
BadHeaderBits	Number of Bits available to represent bad header.
BadTrailerBits	Number of Bits available to represent bad trailer code.
MissedHeaderBits	Number of Bits available to represent missed header.
MissedTrailerBits	Number of Bits available to represent missed trailer.
Bits	Total bit size of the SVDDAQDiagnostic.

Definition at line 25 of file SVDDAQDiagnostic.h.

          {
       TriggerTypeBits = 4,
       TriggerNumberBits = 8,
       PipelineAddressBits = 8,
       CMC1Bits = 8,
       CMC2Bits = 4,
       APVErrorBits = 4,
       FTBErrorBits = 8,
       FTBFlagsBits = 5,
       EMUPipelineAddressBits = 8,
       APVErrorORBits = 4,
       FADCMatchBits = 1,
       APVMatchBits = 1,
       UpsetAPVBits = 1,
       BadMappingBits = 1,
       BadHeaderBits = 1,
       BadTrailerBits = 1,
       MissedHeaderBits = 1,
       MissedTrailerBits = 1,
  
  
       Bits = TriggerTypeBits + TriggerNumberBits + PipelineAddressBits + CMC1Bits + CMC2Bits + APVErrorBits + FTBErrorBits + FTBFlagsBits + EMUPipelineAddressBits + APVErrorORBits + FADCMatchBits + APVMatchBits + UpsetAPVBits + BadMappingBits + BadHeaderBits + BadTrailerBits + MissedHeaderBits + MissedTrailerBits
     };

Constructor & Destructor Documentation

◆ SVDDAQDiagnostic()

SVDDAQDiagnostic	(	uint8_t	triggerNumber,
		uint8_t	triggerType,
		uint8_t	pipelineAddress,
		uint8_t	cmc1,
		uint8_t	cmc2,
		uint8_t	apvError,
		uint8_t	ftbError,
		bool	fadcMatch,
		bool	apvMatch,
		bool	badHeader,
		bool	missedHeader,
		bool	missedTrailer,
		uint8_t	fadcNo = `uint8_t(0)`,
		uint8_t	apvNo = `uint8_t(0)`
	)

inline

Constructor.

Parameters

triggerNumber	as in the FADC header
triggerType	as in the FADC header
pipelineAddress	as in the APV header
cmc1	Common Mode Correction w/o masking out particle signals
cmc2	Common Mode Correction performed after masking particle signals
apvError	Error code as in the APV header
ftbError	Errors field as in the FTB header
fadcMatch	true if FADC number matches
apvMatch	true if APV number matches
badHeader
missedHeader
missedTrailer
fadcNo	FADC number
apvNo	apv number

Definition at line 85 of file SVDDAQDiagnostic.h.

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.

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

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

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

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

Definition at line 362 of file RelationsObject.h.

◆ getName()

virtual std::string getName ( ) const

inlinevirtualinherited

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

pi+ for an MCParticle.

Reimplemented in SpacePoint, MCParticle, and Particle.

Definition at line 344 of file RelationsObject.h.

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

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

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

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

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

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

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

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

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

◆ setApvErrorOR()

void setApvErrorOR ( uint8_t apvErrorOR )

inline

functions for setting values unpacked from FADC trailer

APV errors OR

Definition at line 168 of file SVDDAQDiagnostic.h.

◆ setAPVMatch()

void setAPVMatch ( bool APVMatch )

inline

functions for setting values of

APV match code

Definition at line 171 of file SVDDAQDiagnostic.h.

◆ setBadMapping()

void setBadMapping ( bool BadMapping )

inline

functions for setting values for

Bad Mapping

Definition at line 180 of file SVDDAQDiagnostic.h.

◆ setBadTrailer()

void setBadTrailer ( bool BadTrailer )

inline

functions for setting values for

Bad FADC Trailer

Definition at line 183 of file SVDDAQDiagnostic.h.

◆ setEmuPipelineAddress()

void setEmuPipelineAddress ( uint8_t emuPipelineAddress )

inline

functions for setting values unpacked from FADC trailer

emulated pipeline Address

Definition at line 165 of file SVDDAQDiagnostic.h.

◆ setFADCMatch()

void setFADCMatch ( bool FADCMatch )

inline

functions for setting values of

FADC match code

Definition at line 174 of file SVDDAQDiagnostic.h.

◆ setFTBFlags()

void setFTBFlags ( uint16_t ftbFlags )

inline

functions for setting values unpacked from FADC trailer

FTB Flags Field

Definition at line 162 of file SVDDAQDiagnostic.h.

◆ setMissedHeader()

void setMissedHeader ( bool MissedHeader )

inline

functions for setting values for

Missed Header

Definition at line 189 of file SVDDAQDiagnostic.h.

◆ setMissedTrailer()

void setMissedTrailer ( bool MissedTrailer )

inline

functions for setting values for

Missed Trailer

Definition at line 186 of file SVDDAQDiagnostic.h.

◆ setUpsetAPV()

void setUpsetAPV ( bool UpsetAPV )

inline

functions for setting values for

Upset APVs

Definition at line 177 of file SVDDAQDiagnostic.h.

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

svd/dataobjects/include/SVDDAQDiagnostic.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ SVDDAQDiagnostic()

Member Function Documentation

◆ addRelationTo() [1/2]

◆ addRelationTo() [2/2]

◆ copyRelations()

◆ getInfo()

◆ getInfoHTML()

◆ getName()

◆ getRelated()

◆ getRelatedFrom()

◆ getRelatedFromWithWeight()

◆ getRelatedTo()

◆ getRelatedToWithWeight()

◆ getRelatedWithWeight()

◆ getRelationsFrom()

◆ getRelationsTo()

◆ getRelationsWith()

◆ setApvErrorOR()

◆ setAPVMatch()

◆ setBadMapping()

◆ setBadTrailer()

◆ setEmuPipelineAddress()

◆ setFADCMatch()

◆ setFTBFlags()

◆ setMissedHeader()

◆ setMissedTrailer()

◆ setUpsetAPV()