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

Horizon Message Payload - Max Acceleration. More...

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

List of all members.

Public Member Functions

def __init__
 Create A Horizon Message Payload - Max Acceleration.
def print_format
 Human Readable Payload String.

Public Attributes

 forward
 reverse

Detailed Description

Horizon Message Payload - Max Acceleration.

Represents the payload of the command and data messages 'max acceleration'

Warning:
Data should not be modified once created
Since:
0.1
Horizon Message Payload - Max Acceleration

Definition at line 2078 of file payloads.py.


Constructor & Destructor Documentation

def clearpath.horizon.payloads.MaxAccel.__init__ (   self,
  forward = 0,
  reverse = 0,
  raw = None,
  timestamp = 0 
)

Create A Horizon Message Payload - Max Acceleration.

Constructor for the Horizon Message Payload - Max Acceleration.
The constructor can be called two different ways:

  • MaxAcceleration(forward, reverse, raw=None, ...)
    Create a command message payload to send.
  • MaxAcceleration(raw, version, timestamp)
    Parse raw data (most likely received) into payload variables.
Parameters:
forwardThe maximum forward acceleration
rawRaw Payload data byte list to parse
reverseThe maximum reverse acceleration
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 - Max Acceleration

Definition at line 2102 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 2156 of file payloads.py.


Member Data Documentation

Definition at line 2102 of file payloads.py.

Definition at line 2102 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