clearpath.horizon.payloads.DistanceTiming Class Reference

Horizon Message Payload - Distance & Timing. More...

Inheritance diagram for clearpath.horizon.payloads.DistanceTiming:

List of all members.

Public Member Functions
def	__init__
	Create A Horizon Message Payload - Distance & Timing.
def	print_format
	Human Readable Payload String.
Public Attributes
	distances
	timings

---

Detailed Description

Horizon Message Payload - Distance & Timing.

Represents the payload of the data message 'distance timing'

Warning:

Data should not be modified once created

Since:

0.1

Horizon Message Payload - Distance & Timing

Definition at line 2481 of file payloads.py.

---

Constructor & Destructor Documentation

def clearpath.horizon.payloads.DistanceTiming.__init__	(		self,
			distance = [],
			timing = [],
			raw = None,
			timestamp = 0
	)

Create A Horizon Message Payload - Distance & Timing.

Constructor for the Horizon Message Payload - Distance & Timing.
The constructor can be called two different ways:

• DistanceTiming(distance, timing, raw=None, ...)
  Create a command message payload to send.
  
• DistanceTiming(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)
timing	List of distance aquisition times (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 & Timing

Definition at line 2505 of file payloads.py.

---

Member Function Documentation

def clearpath.horizon.payloads.DistanceTiming.print_format

(

self

)

Human Readable Payload String.

Return the payload as a human readable string

Reimplemented from clearpath.horizon.payloads.Payload.

Definition at line 2539 of file payloads.py.

---

Member Data Documentation

clearpath::horizon::payloads.DistanceTiming::distances

Definition at line 2505 of file payloads.py.

clearpath::horizon::payloads.DistanceTiming::timings

Definition at line 2505 of file payloads.py.

---

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

• payloads.py