Public Member Functions | Public Attributes
clearpath.horizon.payloads.Distance Class Reference

Horizon Message Payload - Distance. More...

Inheritance diagram for clearpath.horizon.payloads.Distance:
Inheritance graph
[legend]

List of all members.

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:
distanceList of distances scaled to two bytes
rawRaw Payload data byte list to parse
timestampPayload Send / Create Time (milliseconds)
versionHorizon Protocol Version, (-1,*) represents the newest version, (0,0) auto-detect the version (if supported)
Exceptions:
LookupErrorIf auto-detect version fails
ValueErrorIf 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

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:


clearpath_base
Author(s): Mike Purvis
autogenerated on Sun Oct 5 2014 22:52:08