clearpath.horizon.payloads.Gear Class Reference

Horizon Message Payload - Gear. More...

Inheritance diagram for clearpath.horizon.payloads.Gear:

List of all members.

Public Member Functions
def	__init__
	Create A Horizon Message Payload - Gear.
def	get_gear
	Get Gear.
def	print_format
	Human Readable Payload String.
Properties
	gear = property(fget=get_gear, doc="Gear")
	Gear.
Private Attributes
	_gear
	Gear.

---

Detailed Description

Horizon Message Payload - Gear.

Represents the payload of the command message 'gear'

Warning:

Data should not be modified once created

Since:

0.1

Horizon Message Payload - Gear

Definition at line 2172 of file payloads.py.

---

Constructor & Destructor Documentation

def clearpath.horizon.payloads.Gear.__init__	(		self,
			gear = -1,
			raw = None,
			timestamp = 0
	)

Create A Horizon Message Payload - Gear.

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

• Gear(gear, raw=None,...)
  Create a command message payload to send.
  
• Gear(raw, version, timestamp)
  Parse raw data (most likely received) into payload variables.
  

Parameters:

gear	The desired gear [-128,127]
raw	Raw Payload data byte list to parse
timestamp	Payload Send / Create Time (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 - Gear

Definition at line 2196 of file payloads.py.

---

Member Function Documentation

def clearpath.horizon.payloads.Gear.get_gear

(

self

)

Get Gear.

Returns:

the gear

Get Gear

Definition at line 2248 of file payloads.py.

def clearpath.horizon.payloads.Gear.print_format

(

self

)

Human Readable Payload String.

Return the payload as a human readable string

Reimplemented from clearpath.horizon.payloads.Payload.

Definition at line 2237 of file payloads.py.

---

Member Data Documentation

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

Gear.

Definition at line 2197 of file payloads.py.

---

Property Documentation

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

Gear.

Definition at line 2256 of file payloads.py.

---

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

• payloads.py