DataContainer Class Reference

vectorflie has two main purposes - to keep track of "out of core" vectors corresponding binary files on disk and to act as a wrapper to a given library. More...

Inheritance diagram for DataContainer:

rsf_data_container SU_DataContainer rsf_mpidata_container

List of all members.

Public Member Functions

def add_referent
def add_referrers
def isCompatibleWith
 method to determine if the data is compatible with Data 'data'.
def __init__
 create container: both data and parameters may not be none.
def add_target_to_current
def getScalar_methods
def add_node_name
def node_copy
 copy data from node to node, data container stays the same
def get_data
def setData
def __setitem__
def isempty
 Returns True if the data associated with self.data does not exist.
def isfull
 Returns True if the data associated with self.data exists.
def tmp
 set whether the data is temporary or not
def istmp
 query whether the data is temporary
def remove
 remove the data from memory
def __str__
 Adds the current lib's suffix to the end of filename note: if no lib is set then self.plugin.suffix returns ''.
def __repr__
 see: __str__
def get_converter
def getParameters
 return parameter instance
def available_from

Static Public Attributes

string name = "ADC"
int test = 0
tuple referents
tuple referrers
tuple is_global = property( __is_global )
tuple is_local = property( __is_local )
tuple nodenames = property( _get_node_names )
tuple target_node = property( _get_target_node )
tuple data = property( _get_data , _set_data )
tuple params = property( getParameters )


Detailed Description

vectorflie has two main purposes - to keep track of "out of core" vectors corresponding binary files on disk and to act as a wrapper to a given library.

Definition at line 71 of file ContainerBase.py.


Member Function Documentation

def add_referent (   self,
  id 
)

Definition at line 91 of file ContainerBase.py.

def add_referrers (   self,
  id 
)

Definition at line 95 of file ContainerBase.py.

def isCompatibleWith (   cls,
  data 
)

method to determine if the data is compatible with Data 'data'.

Reimplemented in rsf_mpidata_container, and rsf_data_container.

Definition at line 105 of file ContainerBase.py.

def __init__ (   self,
  data = None,
  parameters = None,
  command = None,
  tmp = None,
  nodenames = None,
  node_info = None,
  target_node = None 
)

create container: both data and parameters may not be none.

and are mutually exclusive. if parameters is None: data is expected to exist and parameters will be generated if data is None: this instance will be assumed to need to be created.

Definition at line 118 of file ContainerBase.py.

def add_target_to_current (   self  ) 

Definition at line 183 of file ContainerBase.py.

def getScalar_methods (   self  ) 

Definition at line 186 of file ContainerBase.py.

def add_node_name (   self,
  name 
)

Definition at line 206 of file ContainerBase.py.

def node_copy (   self,
  node_name 
)

copy data from node to node, data container stays the same

Reimplemented in rsf_mpidata_container, and rsf_data_container.

Definition at line 221 of file ContainerBase.py.

def get_data (   self,
  node_name 
)

Reimplemented in rsf_data_container.

Definition at line 243 of file ContainerBase.py.

def setData (   self,
  data 
)

Definition at line 246 of file ContainerBase.py.

def __setitem__ (   self,
  item,
  value 
)

Reimplemented in rsf_data_container.

Definition at line 252 of file ContainerBase.py.

def isempty (   self  ) 

Returns True if the data associated with self.data does not exist.

Reimplemented in rsf_data_container, and SU_DataContainer.

Definition at line 264 of file ContainerBase.py.

def isfull (   self  ) 

Returns True if the data associated with self.data exists.

Definition at line 271 of file ContainerBase.py.

def tmp (   self,
  TMP = None 
)

set whether the data is temporary or not

Definition at line 285 of file ContainerBase.py.

def istmp (   self  ) 

query whether the data is temporary

Definition at line 296 of file ContainerBase.py.

def remove (   self  ) 

remove the data from memory

Definition at line 303 of file ContainerBase.py.

def __str__ (   self  ) 

Adds the current lib's suffix to the end of filename note: if no lib is set then self.plugin.suffix returns ''.

Reimplemented in rsf_data_container.

Definition at line 313 of file ContainerBase.py.

def __repr__ (   self  ) 

see: __str__

Reimplemented in rsf_data_container.

Definition at line 320 of file ContainerBase.py.

def get_converter (   cls,
  command 
)

Reimplemented in rsf_data_container.

Definition at line 328 of file ContainerBase.py.

def getParameters (   self  ) 

return parameter instance

Definition at line 335 of file ContainerBase.py.

def available_from (   self,
  nodename 
)

Reimplemented in rsf_data_container.

Definition at line 340 of file ContainerBase.py.


Member Data Documentation

string name = "ADC" [static]

Reimplemented in rsf_mpidata_container, and rsf_data_container.

Definition at line 72 of file ContainerBase.py.

int test = 0 [static]

Definition at line 73 of file ContainerBase.py.

tuple referents [static]

Initial value:

property( _get_referents, 
        doc="Return the list of objects that are directly referred to by this container" )

Definition at line 84 of file ContainerBase.py.

tuple referrers [static]

Initial value:

property(  _get_referrers,
        doc="Return the list of objects that directly refer to self" )

Definition at line 87 of file ContainerBase.py.

tuple is_global = property( __is_global ) [static]

Definition at line 202 of file ContainerBase.py.

tuple is_local = property( __is_local ) [static]

Definition at line 203 of file ContainerBase.py.

tuple nodenames = property( _get_node_names ) [static]

Definition at line 215 of file ContainerBase.py.

tuple target_node = property( _get_target_node ) [static]

Definition at line 227 of file ContainerBase.py.

tuple data = property( _get_data , _set_data ) [static]

Reimplemented in rsf_data_container.

Definition at line 250 of file ContainerBase.py.

tuple params = property( getParameters ) [static]

Definition at line 338 of file ContainerBase.py.


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

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