NASA Logo
Ocean Color Science Software

ocssw V2022
Inheritance diagram for PacketArray:
[legend]
Collaboration diagram for PacketArray:
[legend]

Public Member Functions

def __init__ (self, *args, array_shape=None, array_order="C", **kwargs)
 
- Public Member Functions inherited from PacketField
def __init__ (self, name, data_type, bit_length, bit_offset=None, byte_order="big")
 
def __repr__ (self)
 
def __iter__ (self)
 

Detailed Description

An array contained in a packet, similar to :py:class:`~ccsdspy.PacketField` but with multiple
elements of the same size (e.g. image).

Definition at line 100 of file packet_fields.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
args,
  array_shape = None,
  array_order = "C",
**  kwargs 
)
Parameters
----------
name : str
    String identifier for the field. The name specified how you may
    call upon this data later.
data_type : {'uint', 'int', 'float', 'str', 'fill'}
    Data type of the field.
bit_length : int
    Number of bits contained in the field.
array_shape : int, tuple of ints, str, 'expand'
    Shape of the array as a tuple. For a 1-dimensional array, a single integer
    can be supplied. To use another field's value, pass the name of that field. To
    grow to fill the packet, use "expand". For details on variable length fields, see
    the :py:class:`~ccsdspy.VariableLength` class.
array_order  {'C', 'F'}
    Row-major (C-style) or column-major (Fortran-style) order.
bit_offset : int, optional
    Bit offset into packet, including the primary header which is 48 bits long.
    If this is not specified, than the bit offset will the be calculated automatically
    from its position inside the packet definition.
byte_order : {'big', 'little'}, optional
    Byte order of the field. Defaults to big endian.

Raises
------
TypeError
     If one of the arguments is not of the correct type.
ValueError
     array_shape, array_order, data_type, or byte_order is invalid

Definition at line 105 of file packet_fields.py.


The documentation for this class was generated from the following file:
  • /gfs-oceanweb/web/ocssw/ocssw_src/src/scripts/telemetry/ccsdspy/packet_fields.py