clearpath.horizon.payloads.Subscribe Class Reference

Horizon Message Payload - Request Subscription. More...

Inheritance diagram for clearpath.horizon.payloads.Subscribe:

List of all members.

Public Member Functions
def	__init__
	Create A Horizon Message Payload - Request.
def	print_format
	Human Readable Payload String.
Public Attributes
	subscription
	Subscription Frequency.

---

Detailed Description

Horizon Message Payload - Request Subscription.

Represents the payload of a common request message

Warning:

Data should not be modified once created

Since:

0.1

Subscriptions

Request Data

Horizon Message Payload - Subscribe

Definition at line 459 of file payloads.py.

---

Constructor & Destructor Documentation

def clearpath.horizon.payloads.Subscribe.__init__	(		self,
			raw = None,
			subscription = 0,
			timestamp = 0,
			verify = True
	)

Create A Horizon Message Payload - Request.

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

• Request(subscription, raw=None, version, timestamp)
  Create a request message payload to send.
  
• Request(raw, version, timestamp)
  Parse raw data (most likely received) into payload variables.
  

Parameters:

raw	Raw Payload data byte list to parse
subscription	Subscription Frequency in Hz 0 - immediate, 0xFFFF - off
timestamp	Payload Send / Create Time (milliseconds)
verify	Verify the length? (useful for subclasses)
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 - Request

Definition at line 484 of file payloads.py.

---

Member Function Documentation

def clearpath.horizon.payloads.Subscribe.print_format

(

self

)

Human Readable Payload String.

Return the payload as a human readable string

Reimplemented from clearpath.horizon.payloads.Payload.

Definition at line 509 of file payloads.py.

---

Member Data Documentation

clearpath::horizon::payloads.Subscribe::subscription

Subscription Frequency.

Definition at line 485 of file payloads.py.

---

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

• payloads.py