clearpath::horizon::payloads::Ack Class Reference

Horizon Message Payload - Acknowledgment. More...

Inheritance diagram for clearpath::horizon::payloads::Ack:

Public Member Functions
def	__init__
	Create A Horizon Message Payload - Acknowledgment.
def	print_format
	Human Readable Payload String.
Public Attributes
	bad_bandwidth
	bad_checksum
	bad_code
	bad_code_count
	bad_format
	bad_frequency
	bad_values

Detailed Description

Horizon Message Payload - Acknowledgment.

Represents the payload of a standard acknowledgment message.

Horizon Message Payload - Acknowledgment

Definition at line 342 of file payloads.py.

def clearpath::horizon::payloads::Ack::__init__	(	self,
		bad_bandwidth = `False`,
		bad_checksum = `False`,
		bad_code = `False`,
		bad_code_count = `False`,
		bad_format = `False`,
		bad_frequency = `False`,
		bad_values = `False`,
		raw = `None`,
		timestamp = `0`
	)

Create A Horizon Message Payload - Acknowledgment.

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

Ack(bad_checksum,raw=None,...)
Create an acknowledgment message payload to send.
Ack(raw,timestamp)
Parse raw data (most likely received) into payload variables.

Parameters:

	bad_bandwidth	Not enough bandwidth
	bad_checksum	Message had a bad checksum
	bad_code	Message type is unsupported
	bad_code_count	Too many subscription types
	bad_format	Message format is bad
	bad_frequency	Subscription frequency is too high
	bad_values	Message value(s) are out of range
	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 Acknowledgment Message Payload

Definition at line 372 of file payloads.py.

def clearpath::horizon::payloads::Ack::print_format ( self )

Human Readable Payload String.

Return the payload as a human readable string

Definition at line 434 of file payloads.py.

Definition at line 376 of file payloads.py.

Definition at line 377 of file payloads.py.

Definition at line 378 of file payloads.py.

Definition at line 379 of file payloads.py.

Definition at line 380 of file payloads.py.

Definition at line 381 of file payloads.py.

Definition at line 382 of file payloads.py.

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