clearpath::horizon::payloads::MaxSpeed Class Reference

Horizon Message Payload - Max Speed. More...

Inheritance diagram for clearpath::horizon::payloads::MaxSpeed:

[legend]

List of all members.

Public Member Functions
def	__init__
	Create A Horizon Message Payload - Max Speed.
def	print_format
	Human Readable Payload String.
Public Attributes
	forward
	Max Forward Speed.
	reverse
	Max Reverse Speed.

---

Detailed Description

Horizon Message Payload - Max Speed.

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

Warning:

Data should not be modified once created

Since:

0.1

Horizon Message Payload - Max Speed

Definition at line 1985 of file payloads.py.

---

Member Function Documentation

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

Create A Horizon Message Payload - Max Speed.

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

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

Parameters:

	forward	The maximum forward speed
	raw	Raw Payload data byte list to parse
	reverse	The maximum reverse speed
	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 - Max Speed

Definition at line 2008 of file payloads.py.

def clearpath::horizon::payloads::MaxSpeed::print_format

(

self

)

Human Readable Payload String.

Return the payload as a human readable string

Reimplemented from clearpath::horizon::payloads::Payload.

Definition at line 2063 of file payloads.py.

---

Member Data Documentation

clearpath::horizon::payloads::MaxSpeed::forward

Max Forward Speed.

Definition at line 2013 of file payloads.py.

clearpath::horizon::payloads::MaxSpeed::reverse

Max Reverse Speed.

Definition at line 2015 of file payloads.py.

---

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

• payloads.py