Horizon Message Payload - Distance. More...
Inheritance diagram for clearpath.horizon.payloads.Distance:
Public Member Functions | |
| def | __init__ |
| Create A Horizon Message Payload - Distance. | |
| def | print_format |
| Human Readable Payload String. | |
Public Attributes | |
| distances | |
Detailed Description
Horizon Message Payload - Distance.
Represents the payload of the data message 'distance'
- Warning:
- Data should not be modified once created
- Since:
- 0.1
Horizon Message Payload - Distance
Definition at line 2417 of file payloads.py.
Constructor & Destructor Documentation
| def clearpath.horizon.payloads.Distance.__init__ | ( | self, | |
distance = [], |
|||
raw = None, |
|||
timestamp = 0 |
|||
| ) |
Create A Horizon Message Payload - Distance.
Constructor for the Horizon Message Payload - Distance.
The constructor can be called two different ways:
- Distance(distance, raw=None, timestamp, version, ...)
Create a command message payload to send.
- Distance(raw, version, timestamp)
Parse raw data (most likely received) into payload variables.
- Parameters:
-
distance List of distances scaled to two bytes raw Raw Payload data byte list to parse timestamp Payload Send / Create Time (milliseconds) version Horizon Protocol Version, (-1,*) represents the newest version, (0,0) auto-detect the version (if supported)
- Exceptions:
-
LookupError If auto-detect version fails ValueError If values are out of range or if raw is invalid
Create A Horizon Message Payload - Distance
Definition at line 2440 of file payloads.py.
Member Function Documentation
| def clearpath.horizon.payloads.Distance.print_format | ( | self | ) |
Human Readable Payload String.
Return the payload as a human readable string
Reimplemented from clearpath.horizon.payloads.Payload.
Definition at line 2465 of file payloads.py.
Member Data Documentation
Definition at line 2440 of file payloads.py.
The documentation for this class was generated from the following file: