clearpath::horizon::payloads::Null Class Reference

Horizon Message Payload - Null. More...

Inheritance diagram for clearpath::horizon::payloads::Null:

[legend]

List of all members.

Public Member Functions
def	__init__
	Create A Horizon Message Payload - Null.
def	print_format
	Human Readable Payload String.

---

Detailed Description

Horizon Message Payload - Null.

Represents the null payload (payload of a message without a payload).

Warning:

Data should not be modified once created

Since:

0.1

Horizon Message Payload - Null

Definition at line 295 of file payloads.py.

---

Member Function Documentation

def clearpath::horizon::payloads::Null::__init__	(		self,
			raw = None,
			timestamp = 0
	)

Create A Horizon Message Payload - Null.

Constructor for the Horizon Message Payload - Null Class.
Version auto-detection is unsupported.

Parameters:

	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 - Null

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

Reimplemented in clearpath::horizon::payloads::Echo.

Definition at line 313 of file payloads.py.

def clearpath::horizon::payloads::Null::print_format

(

self

)

Human Readable Payload String.

Return the payload as a human readable string

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

Reimplemented in clearpath::horizon::payloads::Echo.

Definition at line 327 of file payloads.py.

---

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

• payloads.py