Command Class Reference

Base command to be run by a SLIMDataStructure takes a function to be run, a tuple and a dict object on the run method being called will run the function with the given arguments. More...

List of all members.

Public Member Functions

def __init__
 function is a given function to be called by run params and kparams are given to the function at runtime
def add_node_name_to_targets
def copy_sources
def is_set
def do_runtime_map
def get_nodename
def set_nodename
def __getitem__
 return an item from kparams
def __setitem__
 return an item from kparams
def del_kw
def del_par
def pop_kw
def pop_par
def __contains__
 returns True if the keyword arguments contain the key k
def add_other_dep
def has_key
 returns True if the keyword arguments contain the key k
def __repr__
def __str__
def nice_str
def copy
 returns an identical instance params and kparams are copied as well
def __eq__
def run
 runs the function given to the command with the arguments given
def get_all_values
def getTargets
def getSources
def get_source_spaces
def get_structure
def has_unusedtarget
 returns true if this command has an argument that is a Target class
def has_unusedsource
 returns true if this command has a argument that is a Target class
def setunusedtarget
 if this command contains an un-instanciated target class then replace it with : Target returns True if un-instanciated Source is found and false if not
def setunusedsource
 if this command contains an un-instanciated target class then replace it with : Target returns True if un-instanciated Source is found and false if not
def getAdder
def setAdder
def __add__
def __radd__

Public Attributes

 tag
 func
 params
 kparams
 node_name
 tb_info
 runtime_map
 num_proc
 command_type

Static Public Attributes

tuple env = InstanceManager()
tuple command_type = property( _get_cmdtype, _set_cmdtype)
tuple function = property( fset=_set_function )
tuple func = property( _get_func, _set_func )
tuple runtime_map = property( _get_runtime_map, _set_runtime_map)
tuple tag = property( _get_tag , _set_tag )
tuple node_name = property(get_nodename ,set_nodename )
tuple tb_info = property( _get_tb_info, _set_tb_info )
tuple all_values = property(get_all_values)
tuple target_containers = property( _get_target_cont )
tuple source_containers = property( _get_source_cont )
tuple adder = property( getAdder, setAdder )
tuple num_proc = property( _get_num_proc, _set_num_proc )


Detailed Description

Base command to be run by a SLIMDataStructure takes a function to be run, a tuple and a dict object on the run method being called will run the function with the given arguments.

Definition at line 42 of file Command.py.


Member Function Documentation

def __init__ (   self,
  tag,
  adder,
  params,
  kparams 
)

function is a given function to be called by run params and kparams are given to the function at runtime

Definition at line 51 of file Command.py.

def add_node_name_to_targets (   self  ) 

Todo:
explain this better

Definition at line 76 of file Command.py.

def copy_sources (   self  ) 

Definition at line 87 of file Command.py.

def is_set (   self  ) 

Definition at line 109 of file Command.py.

def do_runtime_map (   self  ) 

Definition at line 136 of file Command.py.

def get_nodename (   self  ) 

Definition at line 146 of file Command.py.

def set_nodename (   self,
  val 
)

Definition at line 149 of file Command.py.

def __getitem__ (   self,
  item 
)

return an item from kparams

Definition at line 171 of file Command.py.

def __setitem__ (   self,
  item,
  val 
)

return an item from kparams

Definition at line 179 of file Command.py.

def del_kw (   self,
  item 
)

Definition at line 183 of file Command.py.

def del_par (   self,
  idx 
)

Definition at line 186 of file Command.py.

def pop_kw (   self,
  item,
  default 
)

Definition at line 189 of file Command.py.

def pop_par (   self,
  index 
)

Definition at line 192 of file Command.py.

def __contains__ (   self,
  k 
)

returns True if the keyword arguments contain the key k

Definition at line 201 of file Command.py.

def add_other_dep (   self,
  other 
)

Definition at line 205 of file Command.py.

def has_key (   self,
  key 
)

returns True if the keyword arguments contain the key k

Definition at line 213 of file Command.py.

def __repr__ (   self  ) 

Definition at line 216 of file Command.py.

def __str__ (   self  ) 

Definition at line 219 of file Command.py.

def nice_str (   self  ) 

Definition at line 270 of file Command.py.

def copy (   self  ) 

returns an identical instance params and kparams are copied as well

Definition at line 303 of file Command.py.

def __eq__ (   self,
  other 
)

Definition at line 319 of file Command.py.

def run (   self  ) 

runs the function given to the command with the arguments given

Definition at line 344 of file Command.py.

def get_all_values (   self  ) 

Definition at line 347 of file Command.py.

def getTargets (   self  ) 

Definition at line 359 of file Command.py.

def getSources (   self  ) 

Definition at line 370 of file Command.py.

def get_source_spaces (   self  ) 

Definition at line 399 of file Command.py.

def get_structure (   self,
  item,
  default = None 
)

Definition at line 402 of file Command.py.

def has_unusedtarget (   self  ) 

returns true if this command has an argument that is a Target class

Definition at line 417 of file Command.py.

def has_unusedsource (   self  ) 

returns true if this command has a argument that is a Target class

Definition at line 436 of file Command.py.

def setunusedtarget (   self,
  target 
)

if this command contains an un-instanciated target class then replace it with : Target returns True if un-instanciated Source is found and false if not

Definition at line 447 of file Command.py.

def setunusedsource (   self,
  source 
)

if this command contains an un-instanciated target class then replace it with : Target returns True if un-instanciated Source is found and false if not

Definition at line 478 of file Command.py.

def getAdder (   self  ) 

Definition at line 503 of file Command.py.

def setAdder (   self,
  adder 
)

Definition at line 508 of file Command.py.

def __add__ (   self,
  other 
)

Definition at line 513 of file Command.py.

def __radd__ (   self,
  other 
)

Definition at line 518 of file Command.py.


Member Data Documentation

tuple env = InstanceManager() [static]

Definition at line 43 of file Command.py.

tuple command_type = property( _get_cmdtype, _set_cmdtype) [static]

Definition at line 102 of file Command.py.

tuple function = property( fset=_set_function ) [static]

Definition at line 107 of file Command.py.

tuple func = property( _get_func, _set_func ) [static]

Definition at line 121 of file Command.py.

tuple runtime_map = property( _get_runtime_map, _set_runtime_map) [static]

Definition at line 134 of file Command.py.

tuple tag = property( _get_tag , _set_tag ) [static]

Definition at line 144 of file Command.py.

tuple node_name = property(get_nodename ,set_nodename ) [static]

Definition at line 156 of file Command.py.

tuple tb_info = property( _get_tb_info, _set_tb_info ) [static]

Definition at line 164 of file Command.py.

tuple all_values = property(get_all_values) [static]

Definition at line 356 of file Command.py.

tuple target_containers = property( _get_target_cont ) [static]

Definition at line 395 of file Command.py.

tuple source_containers = property( _get_source_cont ) [static]

Definition at line 396 of file Command.py.

tuple adder = property( getAdder, setAdder ) [static]

Definition at line 511 of file Command.py.

tuple num_proc = property( _get_num_proc, _set_num_proc ) [static]

Definition at line 529 of file Command.py.

tag

Definition at line 53 of file Command.py.

Definition at line 57 of file Command.py.

Definition at line 59 of file Command.py.

Definition at line 60 of file Command.py.

Definition at line 67 of file Command.py.

Definition at line 68 of file Command.py.

Definition at line 69 of file Command.py.

Definition at line 70 of file Command.py.

Definition at line 77 of file Command.py.


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

Generated on Sun Aug 10 09:11:10 2008 for SLIMpy by  doxygen 1.5.6