pyCAPS
pyCAPS: A Python Extension Module for CAPS
Loading...
Searching...
No Matches
DataSetSequence Class Reference

Defines a Sequence of CAPS DataSet Objects. More...

Inheritance diagram for DataSetSequence:
Collaboration diagram for DataSetSequence:

Public Member Functions

 create (self, dname, ftype=None, init=None, rank=None)
 Create a CAPS DataSet Object.
 
 fields (self)
 Returns a list of the fields in the Analysis Object associated with this DataSet.
 
- Public Member Functions inherited from Sequence
 keys (self)
 Returns the keys of the Sequence.
 
 values (self)
 Returns the values of the Sequence.
 
 items (self)
 Returns the items of the Sequence.
 

Detailed Description

Defines a Sequence of CAPS DataSet Objects.

Member Function Documentation

◆ create()

create (   self,
  dname,
  ftype = None,
  init = None,
  rank = None 
)

Create a CAPS DataSet Object.

Parameters
dnameThe name of the data set
ftypeThe field type (FieldIn, FieldOut, GeomSens, TessSens, User). Auto detected FieldIn/FieldOut if None
initInital value assiged to the DataSet. Length must be consistent with the rank.
rankThe rank of the data set (only needed for un-connected data set)
Returns
The new DataSet Object is added to the sequence and returned

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