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

Defines a Sequence of CAPS Attribute Value Objects. More...

Inheritance diagram for AttrSequence:
Collaboration diagram for AttrSequence:

Public Member Functions

 create (self, name, data, overwrite=False)
 Create an attribute (that is meta-data) to the CAPS Object.
 
- 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 Attribute Value Objects.

Member Function Documentation

◆ create()

create (   self,
  name,
  data,
  overwrite = False 
)

Create an attribute (that is meta-data) to the CAPS Object.

See example

Parameters
nameName used to define the attribute.
dataInitial data value(s) for the attribute. Note that type casting in done automatically based on the determined type of the Python object.
overwriteFlag to overwrite any existing attribute with the same 'name'
Returns
The new Value Object is added to the sequence and returned

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