clearpath.horizon.payloads.PlatformName Class Reference

Inheritance diagram for clearpath.horizon.payloads.PlatformName:

List of all members.

Public Member Functions
def	__init__
	Create A Horizon Message Payload - Platform Name.
def	print_format
	Human Readable Payload String.
Public Attributes
	name
	Platform Name.

---

Detailed Description

Horizon Message Payload - Platform Name

Definition at line 635 of file payloads.py.

---

Constructor & Destructor Documentation

def clearpath.horizon.payloads.PlatformName.__init__	(		self,
			name = 'Clearpath1',
			raw = None,
			timestamp = 0
	)

Create A Horizon Message Payload - Platform Name.

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

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

Parameters:

name	Platform Name
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 - Platform Name

Definition at line 658 of file payloads.py.

---

Member Function Documentation

def clearpath.horizon.payloads.PlatformName.print_format

(

self

)

Human Readable Payload String.

Return the payload as a human readable string

Reimplemented from clearpath.horizon.payloads.Payload.

Definition at line 704 of file payloads.py.

---

Member Data Documentation

clearpath::horizon::payloads.PlatformName::name

Platform Name.

Definition at line 659 of file payloads.py.

---

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

• payloads.py