Public Member Functions | Properties | Private Attributes
clearpath.horizon.payloads.GearStatus Class Reference

Horizon Message Payload - Gear Status. More...

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

List of all members.

Public Member Functions

def __init__
 Create A Horizon Message Payload - Gear Status.
def get_gear
 Get Gear.
def is_downshifting
 Is Downshifting?
def is_upshifting
 Is Upshifting?
def print_format
 Human Readable Payload String.

Properties

 downshifting = property(fget=is_downshifting, doc="Downshifting")
 Downshifting.
 gear = property(fget=get_gear, doc="Gear")
 Gear.
 upshifting = property(fget=is_upshifting, doc="Upshifting")
 Upshifting.

Private Attributes

 _down
 Downshifting.
 _gear
 Gear.
 _up
 Upshifting.

Detailed Description

Horizon Message Payload - Gear Status.

Represents the payload of the data message 'gear status'

Warning:
Data should not be modified once created
Since:
0.1
Horizon Message Payload - Gear Status

Definition at line 2267 of file payloads.py.


Constructor & Destructor Documentation

def clearpath.horizon.payloads.GearStatus.__init__ (   self,
  downshifting = False,
  upshifting = False,
  gear = -1,
  raw = None,
  timestamp = 0 
)

Create A Horizon Message Payload - Gear Status.

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

  • GearStatus(upshifting, downshifting,gear,raw=None,...)
    Create a command message payload to send.
  • GearStatus(raw, version, timestamp)
    Parse raw data (most likely received) into payload variables.
Parameters:
downshiftingSet the downshifting flag?
gearThe desired gear [-128,127]
rawRaw Payload data byte list to parse
timestampPayload Send / Create Time (milliseconds)
upshiftingSet the upshifting flag?
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 - Gear Status

Definition at line 2292 of file payloads.py.


Member Function Documentation

Get Gear.

Returns:
the gear
Get Gear

Definition at line 2391 of file payloads.py.

Is Downshifting?

Returns:
is the platform downshifting?
Is Downshifting?

Definition at line 2369 of file payloads.py.

Is Upshifting?

Returns:
is the platform upshifting?
Is Upshifting?

Definition at line 2380 of file payloads.py.

Human Readable Payload String.

Return the payload as a human readable string

Reimplemented from clearpath.horizon.payloads.Payload.

Definition at line 2357 of file payloads.py.


Member Data Documentation

Downshifting.

Definition at line 2293 of file payloads.py.

Gear.

Definition at line 2294 of file payloads.py.

Upshifting.

Definition at line 2295 of file payloads.py.


Property Documentation

clearpath::horizon::payloads.GearStatus::downshifting = property(fget=is_downshifting, doc="Downshifting") [static]

Downshifting.

Definition at line 2399 of file payloads.py.

clearpath::horizon::payloads.GearStatus::gear = property(fget=get_gear, doc="Gear") [static]

Gear.

Definition at line 2403 of file payloads.py.

clearpath::horizon::payloads.GearStatus::upshifting = property(fget=is_upshifting, doc="Upshifting") [static]

Upshifting.

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