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.


Member Function 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:
time Platform Time (0-4294967295)
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 Message Payload - Platform Time

Definition at line 741 of file payloads.py.

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

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 746 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