rsf_data_container Class Reference

rsf_data_container - to keep track of "out of core" vectors corresponding binary files on disk. More...

Inheritance diagram for rsf_data_container:

DataContainer rsf_mpidata_container

List of all members.

Public Member Functions

def isCompatibleWith
 statict method to determine if 'obj' is an rsf file
def __init__
def __setitem__
def makeparams
 returns a param object created from the data contained ie.
def genname_helper
 formatting and better output files, no more tempname just 'slim.
def genName
 generate a random name if command is given then generate a unique but formatted name 'slim.
def get_tmp_dir
def isempty
 check if this data has bee built
def get_converter
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 path
 returns the absolute pathname to the file
def getName
def plot
 plot returns the path the the plotfile
def setName
 wrapped by SLIMpy.serial_vector.setname
def updateData
def getHeader
 return open header, data must exist
def move
def rm
 removes the file on disc
def node_copy
 copy from one node to another
def available_from
def readattr
def readbin
 : data must exist.
def writebin
 write data to file not tested
def book
def writeattr
def write
def get_data
def get_data_loc
def diagnostic
 run a check if this data is valid

Public Attributes

 SFRM
 SFGREY
 SFMV
 XTPEN
 SFATTR
 SFDD
 PLOTCMD
 MVCMD
 RMCMD
 ATTRMD
 data
 BinFile

Static Public Attributes

string suffix = ".rsf"
string psuffix = ".vpl"
string name = "rsf"
tuple env = InstanceManager()
int COUNT = 0
tuple sfFactory = rsfCommandFactory()
tuple local_data = property( _get_local_data )

Detailed Description

rsf_data_container - to keep track of "out of core" vectors corresponding binary files on disk.

Definition at line 51 of file rsfContainer.py.

Member Function Documentation

def isCompatibleWith (   cls,
  obj 
)

statict method to determine if 'obj' is an rsf file

Parameters:
obj,: obj: any object that would be contained in a datacontainer class

Reimplemented from DataContainer.

Reimplemented in rsf_mpidata_container.

Definition at line 75 of file rsfContainer.py.

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

Definition at line 88 of file rsfContainer.py.

def __setitem__ (   self,
  item,
  value 
)

Reimplemented from DataContainer.

Definition at line 129 of file rsfContainer.py.

def makeparams (   self  ) 

returns a param object created from the data contained ie.

the rsf header info

Definition at line 139 of file rsfContainer.py.

def genname_helper (   self,
  string 
)

formatting and better output files, no more tempname just 'slim.

prog.cmd.id.rsf' where prog is the main programs name and cmd is the last command on the pipe that created the data and id is a unique incremented identifier

Definition at line 162 of file rsfContainer.py.

def genName (   self,
  command = None 
)

generate a random name if command is given then generate a unique but formatted name 'slim.

prog.cmd.id.rsf'

Definition at line 198 of file rsfContainer.py.

def get_tmp_dir (   self  ) 

Definition at line 210 of file rsfContainer.py.

def isempty (   self  ) 

check if this data has bee built

Reimplemented from DataContainer.

Definition at line 223 of file rsfContainer.py.

def get_converter (   self,
  command 
)

Reimplemented from DataContainer.

Definition at line 243 of file rsfContainer.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 from DataContainer.

Definition at line 255 of file rsfContainer.py.

def __repr__ (   self  ) 

see: __str__

Reimplemented from DataContainer.

Definition at line 261 of file rsfContainer.py.

def path (   self  ) 

returns the absolute pathname to the file

Definition at line 268 of file rsfContainer.py.

def getName (   self  ) 

Definition at line 273 of file rsfContainer.py.

def plot (   self,
  command = None,
  plotcmd = None 
)

plot returns the path the the plotfile

Definition at line 282 of file rsfContainer.py.

def setName (   self,
  newname,
  path = None 
)

wrapped by SLIMpy.serial_vector.setname

Definition at line 315 of file rsfContainer.py.

def updateData (   self,
  newname 
)

Parameters:
newname,: string to rename data to newname:

Definition at line 344 of file rsfContainer.py.

def getHeader (   self  ) 

return open header, data must exist

Definition at line 351 of file rsfContainer.py.

def move (   self,
  newname 
)

Definition at line 363 of file rsfContainer.py.

def rm (   self  ) 

removes the file on disc

Definition at line 376 of file rsfContainer.py.

def node_copy (   self,
  node_name 
)

copy from one node to another

Reimplemented from DataContainer.

Reimplemented in rsf_mpidata_container.

Definition at line 440 of file rsfContainer.py.

def available_from (   self,
  nodename 
)

Reimplemented from DataContainer.

Definition at line 483 of file rsfContainer.py.

def readattr (   self  ) 

Definition at line 491 of file rsfContainer.py.

def readbin (   self,
  start = 0,
  len = -1 
)

: data must exist.

Returns:
: a numpy array.
Parameters:
start,: element in data to start from. start: int
 len: lenght of data to read into array if -1 reads until the end of data. len:int

Definition at line 529 of file rsfContainer.py.

def writebin (   self,
  data,
  start = 0,
  size = 0 
)

write data to file not tested

Definition at line 550 of file rsfContainer.py.

def book (   self,
  header 
)

Definition at line 564 of file rsfContainer.py.

def writeattr (   self,
  header,
  vector_dict,
  file_dict 
)

Definition at line 571 of file rsfContainer.py.

def write (   self,
  header,
  data,
  book 
)

Definition at line 595 of file rsfContainer.py.

def get_data (   self,
  nodename 
)

Reimplemented from DataContainer.

Definition at line 606 of file rsfContainer.py.

def get_data_loc (   self,
  nodename 
)

Definition at line 617 of file rsfContainer.py.

def diagnostic (   self,
  nodename = None 
)

run a check if this data is valid

Definition at line 633 of file rsfContainer.py.

Member Data Documentation

string suffix = ".rsf" [static]

Reimplemented in rsf_mpidata_container.

Definition at line 52 of file rsfContainer.py.

string psuffix = ".vpl" [static]

Reimplemented in rsf_mpidata_container.

Definition at line 53 of file rsfContainer.py.

string name = "rsf" [static]

Reimplemented from DataContainer.

Reimplemented in rsf_mpidata_container.

Definition at line 54 of file rsfContainer.py.

tuple env = InstanceManager() [static]

Definition at line 58 of file rsfContainer.py.

int COUNT = 0 [static]

Definition at line 60 of file rsfContainer.py.

tuple sfFactory = rsfCommandFactory() [static]

Reimplemented in rsf_mpidata_container.

Definition at line 61 of file rsfContainer.py.

tuple local_data = property( _get_local_data ) [static]

Definition at line 302 of file rsfContainer.py.

SFRM

Definition at line 91 of file rsfContainer.py.

SFGREY

Definition at line 92 of file rsfContainer.py.

SFMV

Definition at line 93 of file rsfContainer.py.

XTPEN

Definition at line 94 of file rsfContainer.py.

SFATTR

Definition at line 95 of file rsfContainer.py.

SFDD

Definition at line 96 of file rsfContainer.py.

PLOTCMD

Definition at line 98 of file rsfContainer.py.

MVCMD

Definition at line 99 of file rsfContainer.py.

RMCMD

Definition at line 100 of file rsfContainer.py.

ATTRMD

Definition at line 102 of file rsfContainer.py.

data

Reimplemented from DataContainer.

Definition at line 345 of file rsfContainer.py.

BinFile

Definition at line 509 of file rsfContainer.py.

The documentation for this class was generated from the following file:
Generated on Sun Aug 10 09:11:09 2008 for SLIMpy by  doxygen 1.5.6