Package PyFoam :: Package Applications :: Module Comparator :: Class Command
[hide private]
[frames] | no frames]

Class Command

source code

object --+
         |
        Command
Known Subclasses:
SetterCommand, CopyLogCommand, DerivedCommand, DictionaryCommand, FoamCommand, GenericCommand, LastResultCommand, SetDictionaryCommand

Abstract base class of all commands

Instance Methods [hide private]
  __init__(self, c)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
  getNonEmpty(self, e, name)
  execute(self, vals, log)
  replace(self, orig, para)
Replaces all strings enclosed by $$ with the parameters

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__


Properties [hide private]

Inherited from object: __class__


Method Details [hide private]

__init__(self, c)
(Constructor)

source code 
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Overrides: object.__init__
(inherited documentation)

getNonEmpty(self, e, name)

source code 
None

execute(self, vals, log)

source code 
Parameters:
  • vals - Dictionary with the keywords
Returns:
A boolean whether it completed successfully and a list with results (None if no results are generated)

replace(self, orig, para)

source code 
Replaces all strings enclosed by $$ with the parameters
Parameters:
  • orig - the original string
  • para - dictionary with the parameters