Belle II Software development
ClassMnemomics.h File Reference

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

#include <tracking/trackFindingCDC/utilities/WeightedRelation.h>
#include <tracking/trackFindingCDC/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 moduel parameters.

The functions are typically called unqualified to be found at compile time by aragument 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 106 of file ClassMnemomics.h.

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

◆ 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 70 of file ClassMnemomics.h.

71 {
72 return "facet";
73 }

◆ 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 82 of file ClassMnemomics.h.

83 {
84 return "segment";
85 }

◆ 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 94 of file ClassMnemomics.h.

95 {
96 return "segment pair";
97 }

◆ 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 118 of file ClassMnemomics.h.

119 {
120 return "segment triple";
121 }

◆ 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 130 of file ClassMnemomics.h.

131 {
132 return "track";
133 }

◆ 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 46 of file ClassMnemomics.h.

47 {
48 return "wire hit";
49 }

◆ 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 58 of file ClassMnemomics.h.

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

◆ getClassMnemomicParameterDescription() [9/10]

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 159 of file ClassMnemomics.h.

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

◆ getClassMnemomicParameterDescription() [10/10]

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

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

Definition at line 144 of file ClassMnemomics.h.

145 {
146 return getClassMnemomicParameterDescription((T*)(nullptr)) + " relation";
147 }

◆ 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 100 of file ClassMnemomics.h.

101 {
102 return "axialSegmentPair";
103 }

◆ 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 64 of file ClassMnemomics.h.

65 {
66 return "facet";
67 }

◆ 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 76 of file ClassMnemomics.h.

77 {
78 return "segment";
79 }

◆ 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 88 of file ClassMnemomics.h.

89 {
90 return "segmentPair";
91 }

◆ 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 112 of file ClassMnemomics.h.

113 {
114 return "segmentTriple";
115 }

◆ 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 124 of file ClassMnemomics.h.

125 {
126 return "track";
127 }

◆ 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 40 of file ClassMnemomics.h.

41 {
42 return "wireHit";
43 }

◆ 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 52 of file ClassMnemomics.h.

53 {
54 return "cluster";
55 }

◆ getClassMnemomicParameterName() [9/10]

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 151 of file ClassMnemomics.h.

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

◆ getClassMnemomicParameterName() [10/10]

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 137 of file ClassMnemomics.h.

138 {
139 return getClassMnemomicParameterName((T*)(nullptr)) + "Relation";
140 }