clearpath.horizon.payloads.GearStatus Class Reference

Horizon Message Payload - Gear Status. More...

Inheritance diagram for clearpath.horizon.payloads.GearStatus:

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:

downshifting	Set the downshifting flag?
gear	The desired gear [-128,127]
raw	Raw Payload data byte list to parse
timestamp	Payload Send / Create Time (milliseconds)
upshifting	Set the upshifting flag?
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 - Gear Status

Definition at line 2292 of file payloads.py.

---

Member Function Documentation

def clearpath.horizon.payloads.GearStatus.get_gear

(

self

)

Get Gear.

Returns:

the gear

Get Gear

Definition at line 2391 of file payloads.py.

def clearpath.horizon.payloads.GearStatus.is_downshifting

(

self

)

Is Downshifting?

Returns:

is the platform downshifting?

Is Downshifting?

Definition at line 2369 of file payloads.py.

def clearpath.horizon.payloads.GearStatus.is_upshifting

(

self

)

Is Upshifting?

Returns:

is the platform upshifting?

Is Upshifting?

Definition at line 2380 of file payloads.py.

def clearpath.horizon.payloads.GearStatus.print_format

(

self

)

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

clearpath::horizon::payloads.GearStatus::_down [private]

Downshifting.

Definition at line 2293 of file payloads.py.

clearpath::horizon::payloads.GearStatus::_gear [private]

Gear.

Definition at line 2294 of file payloads.py.

clearpath::horizon::payloads.GearStatus::_up [private]

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:

• payloads.py