Public Member Functions | Public Attributes
clearpath.horizon.payloads.Rotation Class Reference

Horizon Message Payload - Rotation. More...

Inheritance diagram for clearpath.horizon.payloads.Rotation:
Inheritance graph
[legend]

List of all members.

Public Member Functions

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

Public Attributes

 pitch
 roll
 yaw

Detailed Description

Horizon Message Payload - Rotation.

Represents the payload of the data message 'rotational rate'

Warning:
Data should not be modified once created
Since:
0.1
Horizon Message Payload - Rotation

Definition at line 2640 of file payloads.py.


Constructor & Destructor Documentation

def clearpath.horizon.payloads.Rotation.__init__ (   self,
  roll = 0,
  pitch = 0,
  yaw = 0,
  raw = None,
  timestamp = 0 
)

Create A Horizon Message Payload - Rotation.

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

  • Rotation(roll, pitch, yaw, raw=None, ...)
    Create a command message payload to send.
  • Rotation(raw, version, timestamp)
    Parse raw data (most likely received) into payload variables.
Parameters:
rawRaw Payload data byte list to parse
rot_pitchThe vehicle's pitch rotation rate
rot_rollThe vehicle's roll rotation rate
rot_yawThe vehicle's yaw rotation rate
timestampPayload Send / Create Time (milliseconds)
versionHorizon Protocol Version, (-1,*) represents the newest version, (0,0) auto-detect the version (if supported)
Exceptions:
LookupErrorIf auto-detect version fails
ValueErrorIf values are out of range or if raw is invalid
Create A Horizon Message Payload - Rotation

Definition at line 2665 of file payloads.py.


Member Function Documentation

Human Readable Payload String.

Return the payload as a human readable string

Reimplemented from clearpath.horizon.payloads.Payload.

Definition at line 2716 of file payloads.py.


Member Data Documentation

Definition at line 2665 of file payloads.py.

Definition at line 2665 of file payloads.py.

Definition at line 2665 of file payloads.py.


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


clearpath_base
Author(s): Mike Purvis
autogenerated on Sat Dec 28 2013 16:50:48