Gaudi Framework, version v24r2
Home   Generated: Wed Dec 4 2013
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
EnvConfig.Variable.VariableProcessor Class Reference
Inheritance diagram for EnvConfig.Variable.VariableProcessor:
Inheritance graph
[legend]
Collaboration diagram for EnvConfig.Variable.VariableProcessor:
Collaboration graph
[legend]

Public Member Functions

def __init__
 
def isTarget
 
def process
 
def __call__
 

Private Attributes

 _env
 

Detailed Description

Base class for the objects used to process the variables.

Definition at line 12 of file Variable.py.

Constructor & Destructor Documentation

def EnvConfig.Variable.VariableProcessor.__init__ (   self,
  env 
) 
@param env: dictionary with the reference environment to use

Definition at line 16 of file Variable.py.

16 
17  def __init__(self, env):
18  '''
19  @param env: dictionary with the reference environment to use
20  '''
21  if env is None:
22  env = {}
23  self._env = env

Member Function Documentation

def EnvConfig.Variable.VariableProcessor.__call__ (   self,
  variable,
  value 
)

Definition at line 40 of file Variable.py.

40 
41  def __call__(self, variable, value):
42  return self.process(variable, value)
def EnvConfig.Variable.VariableProcessor.isTarget (   self,
  variable 
) 
Return True if this processor can operate on the given variable.

Definition at line 24 of file Variable.py.

24 
25  def isTarget(self, variable):
26  '''
27  Return True if this processor can operate on the given variable.
28  '''
29  return True
def EnvConfig.Variable.VariableProcessor.process (   self,
  variable,
  value 
) 
Process the variable.

@param value: the content of the variable to be processed
@return: the processed value

Definition at line 30 of file Variable.py.

30 
31  def process(self, variable, value):
32  '''
33  Process the variable.
34 
35  @param value: the content of the variable to be processed
36  @return: the processed value
37  '''
38  # by default do nothing
39  return value

Member Data Documentation

EnvConfig.Variable.VariableProcessor._env
private

Definition at line 22 of file Variable.py.

The documentation for this class was generated from the following file:
Generated at Wed Dec 4 2013 14:33:20 for Gaudi Framework, version v24r2 by Doxygen version 1.8.2 written by Dimitri van Heesch, © 1997-2004