Package xdp :: Package io :: Module sff :: Class Sff
[show private | hide private]
[frames | no frames]

Class Sff


The contents of the header of an SFF file.
Method Summary
  __init__(self, **kwds)
Create an empty SFF header.
  add(self, name, value)
Create a new field.
  addField(self, name, value)
Create a new field.
list of strings fields(self)
Retrive a list of the field names.
any get(self, name)
Retrieve a field's value.
any getField(self, name)
Retrieve a field's value.
list of strings getFieldNames(self)
Retrive a list of the field names.
bool has(self, name)
Check for the presence of a field.
bool hasField(self, name)
Check for the presence of a field.
  remove(self, name)
Remove a field from the header.
  removeField(self, name)
Remove a field from the header.
  set(self, name, value)
Assign a value to a field.
  setField(self, name, value)
Assign a value to a field.
  write(self, data, stream)
Write a dataset to an output stream in SFF, using this header's fields.

Method Details

__init__(self, **kwds)
(Constructor)

Create an empty SFF header.

If keyword arguments are provided, then are interpreted as field definitions and are used to populate the header.
Parameters:
kwds - field definitions
           (type=dict)

add(self, name, value)

Create a new field.
Parameters:
name - new field's name
           (type=string)
value - new field's value
           (type=any)
Raises:
SffFieldError - the field name already exists

Depreciated: use addField instead

addField(self, name, value)

Create a new field.
Parameters:
name - new field's name
           (type=string)
value - new field's value
           (type=any)
Raises:
SffFieldError - the field name already exists

fields(self)

Retrive a list of the field names.
Returns:
names of this header's fields
           (type=list of strings)

Depreciated: use getFieldNames instead

get(self, name)

Retrieve a field's value.
Parameters:
name - field name
           (type=string)
Returns:
field value
           (type=any)
Raises:
SffFieldError - this header has no field name

Depreciated: use getField instead

getField(self, name)

Retrieve a field's value.
Parameters:
name - field name
           (type=string)
Returns:
field value
           (type=any)
Raises:
SffFieldError - this header has no field name

getFieldNames(self)

Retrive a list of the field names.
Returns:
names of this header's fields
           (type=list of strings)

has(self, name)

Check for the presence of a field.
Parameters:
name - field to check for
           (type=string)
Returns:
whether or not this dataset has a field name
           (type=bool)

Depreciated: use hasField instead

hasField(self, name)

Check for the presence of a field.
Parameters:
name - field to check for
           (type=string)
Returns:
whether or not this dataset has a field name
           (type=bool)

Depreciated: use hasField instead

remove(self, name)

Remove a field from the header.
Parameters:
name - field to remove
           (type=string)
Raises:
SffFieldError - the field name does not exist

Depreciated: use removeField instead

removeField(self, name)

Remove a field from the header.
Parameters:
name - field to remove
           (type=string)
Raises:
SffFieldError - the field name does not exist

set(self, name, value)

Assign a value to a field. If the field does not exist, it will be created.
Parameters:
name - field name
           (type=string)
value - new field data
           (type=any)

Depreciated: use setField instead

setField(self, name, value)

Assign a value to a field. If the field does not exist, it will be created.
Parameters:
name - field name
           (type=string)
value - new field data
           (type=any)

write(self, data, stream)

Write a dataset to an output stream in SFF, using this header's fields.

The output is written in the SFF format, and a %devices field is created to hold the column names from data.
Parameters:
data - dataset
           (type=Data)
stream - output stream
           (type=file)

Generated by Epydoc 2.1 on Wed Jul 20 11:51:05 2005 http://epydoc.sf.net