|
ocssw
V2022
|
PacketField
Inheritance diagram for PacketField:
Public Member Functions | |
| def | __init__ (self, name, data_type, bit_length, bit_offset=None, byte_order="big") |
| def | __repr__ (self) |
| def | __iter__ (self) |
Detailed Description
A field contained in a packet.
Definition at line 15 of file packet_fields.py.
Constructor & Destructor Documentation
◆ __init__()
| def __init__ | ( | self, | |
| name, | |||
| data_type, | |||
| bit_length, | |||
bit_offset = None, |
|||
byte_order = "big" |
|||
| ) |
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.
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
data_type or byte_order is invalid
Definition at line 18 of file packet_fields.py.
Member Function Documentation
◆ __iter__()
| def __iter__ | ( | self | ) |
Definition at line 88 of file packet_fields.py.
◆ __repr__()
| def __repr__ | ( | self | ) |
Definition at line 70 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
