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

Horizon Message Payload - Platform Time. More...

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

List of all members.

Public Member Functions

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

Public Attributes

 time
 Platform Time.

Detailed Description

Horizon Message Payload - Platform Time.

Represents the payload of the command message 'platform time'

Warning:
Data should not be modified once created
Since:
0.3
Horizon Message Payload - Platform Time

Definition at line 718 of file payloads.py.


Constructor & Destructor Documentation

def clearpath.horizon.payloads.PlatformTime.__init__ (   self,
  time = 0,
  raw = None,
  timestamp = 0 
)

Create A Horizon Message Payload - Platform Time.

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

  • PlatformTime(time, raw=None, version, timestamp)
    Create a command message payload to send.
  • PlatformTime(raw, version, timestamp)
    Parse raw data (most likely received) into payload variables.
Parameters:
timePlatform Time (0-4294967295)
rawRaw Payload data byte list to parse
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 - Platform Time

Definition at line 741 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 781 of file payloads.py.


Member Data Documentation

Platform Time.

Definition at line 742 of file payloads.py.


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


clearpath_base
Author(s): Mike Purvis
autogenerated on Sun Oct 5 2014 22:52:08