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

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

Inheritance diagram for ParamSequence:
Collaboration diagram for ParamSequence:

Public Member Functions

 create (self, name, data, limits=None, fixedLength=True, fixedShape=True)
 Create an parameter CAPS Value 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 Parameter Value Objects.

Member Function Documentation

◆ create()

create (   self,
  name,
  data,
  limits = None,
  fixedLength = True,
  fixedShape = True 
)

Create an parameter CAPS Value Object.

Parameters
nameName used to define the parameter.
dataInitial data value(s) for the parameter. Note that type casting in done automatically based on the determined type of the Python object.
limitsLimits on the parameter values
fixedLengthBoolean if the value is fixed length
fixedShapeBoolean if the value is fixed shape
Returns
The new Value Object is added to the sequence and returned

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