clearpath::horizon::payloads::RawEncoders Class Reference

Horizon Message Payload - Raw Encoders. More...

Inheritance diagram for clearpath::horizon::payloads::RawEncoders:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def __init__
 Create A Horizon Message Payload - Raw Encoders.
def print_format
 Human Readable Payload String.

Public Attributes

 ticks

Detailed Description

Horizon Message Payload - Raw Encoders.

Represents the payload of the data message 'raw encoders'

Warning:
Data should not be modified once created
Since:
0.8
Horizon Message Payload - Raw Encoders

Definition at line 2984 of file payloads.py.


Member Function Documentation

def clearpath::horizon::payloads::RawEncoders::__init__ (   self,
  ticks = [],
  raw = None,
  timestamp = 0 
)

Create A Horizon Message Payload - Raw Encoders.

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

  • Encoders(ticks, raw=None, ...)
    Create a command message payload to send.
  • Encoders(raw, version, timestamp)
    Parse raw data (most likely received) into payload variables.
Parameters:
raw Raw Payload data byte list to parse
ticks A list of encoder ticks
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 - Raw Encoders

Definition at line 3008 of file payloads.py.

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

Human Readable Payload String.

Return the payload as a human readable string

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

Definition at line 3054 of file payloads.py.


Member Data Documentation

Definition at line 3011 of file payloads.py.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Properties


clearpath_base
Author(s): Mike Purvis
autogenerated on Fri Jan 11 10:11:35 2013