Belle II Software light-2405-quaxo
PythonVariableManager Class Reference

Public Member Functions

def getVariable (self, *args)
 
def getVariables (self, *args)
 
def addAlias (self, alias, variable)
 
def printAliases (self)
 
def clearAliases (self)
 
def resolveAlias (self, alias)
 
def addCollection (self, *args)
 
def getCollection (self, collection)
 
def resolveCollections (self, *args)
 
def checkDeprecatedVariable (self, variable)
 
def evaluate (self, variable, particle)
 
def getNames (self)
 
def getAliasNames (self)
 
def assertValidName (self, variable)
 

Protected Member Functions

def _instance (self)
 

Detailed Description

Wrapper around the variable manager class.
This is necessary for avoiding to import ROOT globally when 'variables' is imported.

Definition at line 13 of file __init__.py.

Member Function Documentation

◆ _instance()

def _instance (   self)
protected
Return an instance to the variable manager.

Definition at line 20 of file __init__.py.

20 def _instance(self):
21 '''
22 Return an instance to the variable manager.
23 '''
24 # Always avoid the top-level 'import ROOT'.
25 import ROOT # noqa
26 instance = ROOT.Belle2.Variable.Manager.Instance()
27 return instance
28

◆ addAlias()

def addAlias (   self,
  alias,
  variable 
)
Wrapper around Manager::addAlias(const std::string& alias, const std::string& variable).

Definition at line 45 of file __init__.py.

45 def addAlias(self, alias, variable):
46 '''
47 Wrapper around Manager::addAlias(const std::string& alias, const std::string& variable).
48 '''
49 instance = PythonVariableManager._instance()
50 assert(instance.addAlias(alias, variable))
51

◆ addCollection()

def addCollection (   self,
args 
)
Wrapper around Manager::addCollection(const std::string& collection, const std::vector<std::string>& variables)

Definition at line 73 of file __init__.py.

73 def addCollection(self, *args):
74 '''
75 Wrapper around Manager::addCollection(const std::string& collection, const std::vector<std::string>& variables)
76 '''
77 instance = PythonVariableManager._instance()
78 assert(instance.addCollection(*args))
79

◆ assertValidName()

def assertValidName (   self,
  variable 
)
Wrapper around Manager::assertValidName(const std::string& name).

Definition at line 122 of file __init__.py.

122 def assertValidName(self, variable):
123 '''
124 Wrapper around Manager::assertValidName(const std::string& name).
125 '''
126 instance = PythonVariableManager._instance()
127 instance.assertValidName(variable)
128
129

◆ checkDeprecatedVariable()

def checkDeprecatedVariable (   self,
  variable 
)
Wrapper around Manager::checkDeprecatedVariable(const std::string& name).

Definition at line 94 of file __init__.py.

94 def checkDeprecatedVariable(self, variable):
95 '''
96 Wrapper around Manager::checkDeprecatedVariable(const std::string& name).
97 '''
98 instance = PythonVariableManager._instance()
99 instance.checkDeprecatedVariable(variable)
100

◆ clearAliases()

def clearAliases (   self)
Wrapper around Manager::clearAliases().

Definition at line 59 of file __init__.py.

59 def clearAliases(self):
60 '''
61 Wrapper around Manager::clearAliases().
62 '''
63 instance = PythonVariableManager._instance()
64 instance.clearAliases()
65

◆ evaluate()

def evaluate (   self,
  variable,
  particle 
)
Wrapper around Manager::evaluate(const std::string& varName, const Particle* p).

Definition at line 101 of file __init__.py.

101 def evaluate(self, variable, particle):
102 '''
103 Wrapper around Manager::evaluate(const std::string& varName, const Particle* p).
104 '''
105 instance = PythonVariableManager._instance()
106 return instance.evaluate(variable, particle)
107

◆ getAliasNames()

def getAliasNames (   self)
Wrapper around Manager::getAliasNames().

Definition at line 115 of file __init__.py.

115 def getAliasNames(self):
116 '''
117 Wrapper around Manager::getAliasNames().
118 '''
119 instance = PythonVariableManager._instance()
120 return instance.getAliasNames()
121

◆ getCollection()

def getCollection (   self,
  collection 
)
Wrapper around Manager::getCollection(const std::string& collection).

Definition at line 80 of file __init__.py.

80 def getCollection(self, collection):
81 '''
82 Wrapper around Manager::getCollection(const std::string& collection).
83 '''
84 instance = PythonVariableManager._instance()
85 return instance.getCollection(collection)
86

◆ getNames()

def getNames (   self)
Wrapper around Manager::getNames().

Definition at line 108 of file __init__.py.

108 def getNames(self):
109 '''
110 Wrapper around Manager::getNames().
111 '''
112 instance = PythonVariableManager._instance()
113 return instance.getNames()
114

◆ getVariable()

def getVariable (   self,
args 
)
Wrapper around Manager::getVariable(std::string name) and
Manager::getVariable(const std::string& functionName, const std::vector<std::string>& functionArguments).

Definition at line 29 of file __init__.py.

29 def getVariable(self, *args):
30 '''
31 Wrapper around Manager::getVariable(std::string name) and
32 Manager::getVariable(const std::string& functionName, const std::vector<std::string>& functionArguments).
33 '''
34 instance = PythonVariableManager._instance()
35 return instance.getVariable(*args)
36

◆ getVariables()

def getVariables (   self,
args 
)
Wrapper around Manager::getVariables(const std::vector<std::string>& variables) and
Manager::getVariables().

Definition at line 37 of file __init__.py.

37 def getVariables(self, *args):
38 '''
39 Wrapper around Manager::getVariables(const std::vector<std::string>& variables) and
40 Manager::getVariables().
41 '''
42 instance = PythonVariableManager._instance()
43 return instance.getVariables(*args)
44

◆ printAliases()

def printAliases (   self)
Wrapper around Manager::printAliases().

Definition at line 52 of file __init__.py.

52 def printAliases(self):
53 '''
54 Wrapper around Manager::printAliases().
55 '''
56 instance = PythonVariableManager._instance()
57 instance.printAliases()
58

◆ resolveAlias()

def resolveAlias (   self,
  alias 
)
Wrapper around Manager::resolveAlias(const std::string& alias).

Definition at line 66 of file __init__.py.

66 def resolveAlias(self, alias):
67 '''
68 Wrapper around Manager::resolveAlias(const std::string& alias).
69 '''
70 instance = PythonVariableManager._instance()
71 return instance.resolveAlias(alias)
72

◆ resolveCollections()

def resolveCollections (   self,
args 
)
Wrapper around Manager::resolveCollections(const std::vector<std::string>& variables).

Definition at line 87 of file __init__.py.

87 def resolveCollections(self, *args):
88 '''
89 Wrapper around Manager::resolveCollections(const std::vector<std::string>& variables).
90 '''
91 instance = PythonVariableManager._instance()
92 return instance.resolveCollections(*args)
93

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