Belle II Software development
ClassMnemomics.h File Reference

Utility functions to lookup identifier and description for event data objects useful to define module parameters. More...

#include <tracking/trackingUtilities/utilities/WeightedRelation.h>
#include <tracking/trackingUtilities/utilities/StringManipulation.h>
#include <string>

Go to the source code of this file.

Namespaces

namespace  Belle2
 Abstract base class for different kinds of events.
 

Functions

std::string getClassMnemomicParameterName (const CDCWireHit *dispatchTag)
 Returns a short name for class CDCWireHit to be used in names of parameters.
 
std::string getClassMnemomicParameterDescription (const CDCWireHit *dispatchTag)
 Returns a short description for class CDCWireHit to be used in descriptions of parameters.
 
std::string getClassMnemomicParameterName (const CDCWireHitCluster *dispatchTag)
 Returns a short name for class CDCWireHitCluster to be used in names of parameters.
 
std::string getClassMnemomicParameterDescription (const CDCWireHitCluster *dispatchTag)
 Returns a short description for class CDCWireHitCluster to be used in descriptions of parameters.
 
std::string getClassMnemomicParameterName (const CDCFacet *dispatchTag)
 Returns a short name for class CDCFacet to be used in names of parameters.
 
std::string getClassMnemomicParameterDescription (const CDCFacet *dispatchTag)
 Returns a short description for class CDCFacet to be used in descriptions of parameters.
 
std::string getClassMnemomicParameterName (const CDCSegment2D *dispatchTag)
 Returns a short name for class CDCSegment2D to be used in names of parameters.
 
std::string getClassMnemomicParameterDescription (const CDCSegment2D *dispatchTag)
 Returns a short description for class CDCSegment2D to be used in descriptions of parameters.
 
std::string getClassMnemomicParameterName (const CDCSegmentPair *dispatchTag)
 Returns a short name for class CDCSegmentPair to be used in names of parameters.
 
std::string getClassMnemomicParameterDescription (const CDCSegmentPair *dispatchTag)
 Returns a short description for class CDCSegmentPair to be used in descriptions of parameters.
 
std::string getClassMnemomicParameterName (const CDCAxialSegmentPair *dispatchTag)
 Returns a short name for class CDCAxialSegmentPair to be used in names of parameters.
 
std::string getClassMnemomicParameterDescription (const CDCAxialSegmentPair *tag)
 Returns a short description for class CDCAxialSegmentPair to be used in descriptions of parameters.
 
std::string getClassMnemomicParameterName (const CDCSegmentTriple *dispatchTag)
 Returns a short name for class CDCSegmentTriple to be used in names of parameters.
 
std::string getClassMnemomicParameterDescription (const CDCSegmentTriple *dispatchTag)
 Returns a short description for class CDCSegmentTriple to be used in descriptions of parameters.
 
std::string getClassMnemomicParameterName (const CDCTrack *dispatchTag)
 Returns a short name for class CDCTrack to be used in names of parameters.
 
std::string getClassMnemomicParameterDescription (const CDCTrack *dispatchTag)
 Returns a short description for class CDCTrack to be used in descriptions of parameters.
 
template<class T>
std::string getClassMnemomicParameterName (const WeightedRelation< T > *dispatchTag)
 Returns a short name for class WeightedRelation<T> to be used in names of parameters.
 
template<class T>
std::string getClassMnemomicParameterDescription (const WeightedRelation< T > *dispatchTag)
 Returns a short description for class WeightedRelation<T> to be used in descriptions.
 
template<class From, class To>
std::string getClassMnemomicParameterName (const WeightedRelation< From, To > *dispatchTag)
 Returns a short name for class WeightedRelation<From, To> to be used in names of parameters.
 
template<class From, class To>
std::string getClassMnemomicParameterDescription (const WeightedRelation< From, To > *dispatchTag)
 Returns a short description for class WeightedRelation<From, To> to be used in descriptions.
 

Detailed Description

Utility functions to lookup identifier and description for event data objects useful to define module parameters.

The functions are typically called unqualified to be found at compile time by argument dependent lookup.

Definition in file ClassMnemomics.h.

Function Documentation

◆ getClassMnemomicParameterDescription() [1/10]

std::string getClassMnemomicParameterDescription ( const CDCAxialSegmentPair * tag)
inline

Returns a short description for class CDCAxialSegmentPair to be used in descriptions of parameters.

Definition at line 107 of file ClassMnemomics.h.

108 {
109 return "axial segment pair";
110 }

◆ getClassMnemomicParameterDescription() [2/10]

std::string getClassMnemomicParameterDescription ( const CDCFacet * dispatchTag)
inline

Returns a short description for class CDCFacet to be used in descriptions of parameters.

Definition at line 71 of file ClassMnemomics.h.

72 {
73 return "facet";
74 }

◆ getClassMnemomicParameterDescription() [3/10]

std::string getClassMnemomicParameterDescription ( const CDCSegment2D * dispatchTag)
inline

Returns a short description for class CDCSegment2D to be used in descriptions of parameters.

Definition at line 83 of file ClassMnemomics.h.

84 {
85 return "segment";
86 }

◆ getClassMnemomicParameterDescription() [4/10]

std::string getClassMnemomicParameterDescription ( const CDCSegmentPair * dispatchTag)
inline

Returns a short description for class CDCSegmentPair to be used in descriptions of parameters.

Definition at line 95 of file ClassMnemomics.h.

96 {
97 return "segment pair";
98 }

◆ getClassMnemomicParameterDescription() [5/10]

std::string getClassMnemomicParameterDescription ( const CDCSegmentTriple * dispatchTag)
inline

Returns a short description for class CDCSegmentTriple to be used in descriptions of parameters.

Definition at line 119 of file ClassMnemomics.h.

120 {
121 return "segment triple";
122 }

◆ getClassMnemomicParameterDescription() [6/10]

std::string getClassMnemomicParameterDescription ( const CDCTrack * dispatchTag)
inline

Returns a short description for class CDCTrack to be used in descriptions of parameters.

Definition at line 132 of file ClassMnemomics.h.

133 {
134 return "track";
135 }

◆ getClassMnemomicParameterDescription() [7/10]

std::string getClassMnemomicParameterDescription ( const CDCWireHit * dispatchTag)
inline

Returns a short description for class CDCWireHit to be used in descriptions of parameters.

Definition at line 47 of file ClassMnemomics.h.

48 {
49 return "wire hit";
50 }

◆ getClassMnemomicParameterDescription() [8/10]

std::string getClassMnemomicParameterDescription ( const CDCWireHitCluster * dispatchTag)
inline

Returns a short description for class CDCWireHitCluster to be used in descriptions of parameters.

Definition at line 59 of file ClassMnemomics.h.

60 {
61 return "wire hit cluster";
62 }

◆ getClassMnemomicParameterDescription() [9/10]

template<class From, class To>
std::string getClassMnemomicParameterDescription ( const WeightedRelation< From, To > * dispatchTag)
inline

Returns a short description for class WeightedRelation<From, To> to be used in descriptions.

Definition at line 161 of file ClassMnemomics.h.

162 {
163 return getClassMnemomicParameterDescription((From*)(nullptr)) + " to " +
164 getClassMnemomicParameterDescription((To*)(nullptr)) + " relation";
165 }
std::string getClassMnemomicParameterDescription(const CDCWireHit *dispatchTag)
Returns a short description for class CDCWireHit to be used in descriptions of parameters.

◆ getClassMnemomicParameterDescription() [10/10]

template<class T>
std::string getClassMnemomicParameterDescription ( const WeightedRelation< T > * dispatchTag)
inline

Returns a short description for class WeightedRelation<T> to be used in descriptions.

Definition at line 146 of file ClassMnemomics.h.

147 {
148 return getClassMnemomicParameterDescription((T*)(nullptr)) + " relation";
149 }

◆ getClassMnemomicParameterName() [1/10]

std::string getClassMnemomicParameterName ( const CDCAxialSegmentPair * dispatchTag)
inline

Returns a short name for class CDCAxialSegmentPair to be used in names of parameters.

Definition at line 101 of file ClassMnemomics.h.

102 {
103 return "axialSegmentPair";
104 }

◆ getClassMnemomicParameterName() [2/10]

std::string getClassMnemomicParameterName ( const CDCFacet * dispatchTag)
inline

Returns a short name for class CDCFacet to be used in names of parameters.

Definition at line 65 of file ClassMnemomics.h.

66 {
67 return "facet";
68 }

◆ getClassMnemomicParameterName() [3/10]

std::string getClassMnemomicParameterName ( const CDCSegment2D * dispatchTag)
inline

Returns a short name for class CDCSegment2D to be used in names of parameters.

Definition at line 77 of file ClassMnemomics.h.

78 {
79 return "segment";
80 }

◆ getClassMnemomicParameterName() [4/10]

std::string getClassMnemomicParameterName ( const CDCSegmentPair * dispatchTag)
inline

Returns a short name for class CDCSegmentPair to be used in names of parameters.

Definition at line 89 of file ClassMnemomics.h.

90 {
91 return "segmentPair";
92 }

◆ getClassMnemomicParameterName() [5/10]

std::string getClassMnemomicParameterName ( const CDCSegmentTriple * dispatchTag)
inline

Returns a short name for class CDCSegmentTriple to be used in names of parameters.

Definition at line 113 of file ClassMnemomics.h.

114 {
115 return "segmentTriple";
116 }

◆ getClassMnemomicParameterName() [6/10]

std::string getClassMnemomicParameterName ( const CDCTrack * dispatchTag)
inline

Returns a short name for class CDCTrack to be used in names of parameters.

Definition at line 126 of file ClassMnemomics.h.

127 {
128 return "track";
129 }

◆ getClassMnemomicParameterName() [7/10]

std::string getClassMnemomicParameterName ( const CDCWireHit * dispatchTag)
inline

Returns a short name for class CDCWireHit to be used in names of parameters.

Definition at line 41 of file ClassMnemomics.h.

42 {
43 return "wireHit";
44 }

◆ getClassMnemomicParameterName() [8/10]

std::string getClassMnemomicParameterName ( const CDCWireHitCluster * dispatchTag)
inline

Returns a short name for class CDCWireHitCluster to be used in names of parameters.

Definition at line 53 of file ClassMnemomics.h.

54 {
55 return "cluster";
56 }

◆ getClassMnemomicParameterName() [9/10]

template<class From, class To>
std::string getClassMnemomicParameterName ( const WeightedRelation< From, To > * dispatchTag)
inline

Returns a short name for class WeightedRelation<From, To> to be used in names of parameters.

Definition at line 153 of file ClassMnemomics.h.

154 {
155 return prefixed(getClassMnemomicParameterName((From*)(nullptr)) + "To",
156 getClassMnemomicParameterName((To*)(nullptr)) + "Relation");
157 }
std::string getClassMnemomicParameterName(const CDCWireHit *dispatchTag)
Returns a short name for class CDCWireHit to be used in names of parameters.

◆ getClassMnemomicParameterName() [10/10]

template<class T>
std::string getClassMnemomicParameterName ( const WeightedRelation< T > * dispatchTag)
inline

Returns a short name for class WeightedRelation<T> to be used in names of parameters.

Definition at line 139 of file ClassMnemomics.h.

140 {
141 return getClassMnemomicParameterName((T*)(nullptr)) + "Relation";
142 }