Gaudi Framework, version v23r5
Home   Generated: Wed Nov 28 2012
 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 11 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 15 of file Variable.py.

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

Member Function Documentation

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

Definition at line 39 of file Variable.py.

39 
40  def __call__(self, variable, value):
41  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 23 of file Variable.py.

23 
24  def isTarget(self, variable):
25  '''
26  Return True if this processor can operate on the given variable.
27  '''
28  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 29 of file Variable.py.

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

Member Data Documentation

EnvConfig.Variable.VariableProcessor._env
private

Definition at line 21 of file Variable.py.

The documentation for this class was generated from the following file:
Generated at Wed Nov 28 2012 12:17:35 for Gaudi Framework, version v23r5 by Doxygen version 1.8.2 written by Dimitri van Heesch, © 1997-2004