|
ocssw
V2022
|
FixedLength
Inheritance diagram for FixedLength:
Collaboration diagram for FixedLength:
Public Member Functions | |
| def | __init__ (self, fields) |
| def | load (self, file, include_primary_header=False) |
 Public Member Functions inherited from _BasePacket | |
| def | from_file (cls, file) |
| def | add_converted_field (self, input_field_name, output_field_name, converter) |
Detailed Description
Define a fixed length packet to decode binary data. Fixed length packets correspond to packets that are the same length and layout every time. A common example of this is housekeeping or status messages.
Definition at line 116 of file packet_types.py.
Constructor & Destructor Documentation
◆ __init__()
| def __init__ | ( | self, | |
| fields | |||
| ) |
Parameters
----------
fields : list of :py:class:`~ccsdspy.PacketField` or :py:class:`~ccsdspy.PacketArray`
Layout of packet fields contained in the definition.
Raises
------
ValueError
one or more of the arguments are invalid
Definition at line 124 of file packet_types.py.
Member Function Documentation
◆ load()
| def load | ( | self, | |
| file, | |||
include_primary_header = False |
|||
| ) |
Decode a file-like object containing a sequence of these packets.
Parameters
----------
file : str
Path to file on the local file system, or file-like object
include_primary_header : bool
If True, provides the primary header in the output
Returns
-------
field_arrays : dict, string to NumPy array
dictionary mapping field names to NumPy arrays, with key order matching
the order of fields in the packet.
Warns
-----
UserWarning
If the ccsds sequence count is not in order
UserWarning
If the ccsds sequence count is missing packets
UserWarning
If there are more than one APID
Definition at line 144 of file packet_types.py.
The documentation for this class was generated from the following file:
- /gfs-oceanweb/web/ocssw/ocssw_src/src/scripts/telemetry/ccsdspy/packet_types.py
