clearpath::horizon::payloads::RawMagnetometer Class Reference

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

List of all members.

Public Member Functions

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

Public Attributes

 raw_z

Private Member Functions

def _base_for_value
def _num_sensors

Detailed Description

Horizon Message Payload - Raw Magnetometer Data

Definition at line 3467 of file payloads.py.


Member Function Documentation

def clearpath::horizon::payloads::RawMagnetometer::__init__ (   self,
  raw = None,
  timestamp = 0 
)

Create A Horizon Message Payload.

Constructor for the Horizon Payload class.
Creates a basic message payload which is simply a byte list.

Subclass overrides should throw ValueError if invalid format and LookupError if it has version detection problems (if supported).

Parameters:
raw Raw data buffer to parse
timestamp Payload Send / Create Time (milliseconds)
Exceptions:
LookupError If auto-detect version fails
ValueError If values are out of range or if raw is invalid
Create A Horizon Message Payload

Reimplemented from clearpath::horizon::payloads::RawSensor.

Definition at line 3470 of file payloads.py.

def clearpath::horizon::payloads::RawMagnetometer::_base_for_value (   self,
  i 
) [private]

Reimplemented from clearpath::horizon::payloads::RawSensor.

Definition at line 3479 of file payloads.py.

def clearpath::horizon::payloads::RawMagnetometer::_num_sensors (   self,
  raw 
) [private]

Reimplemented from clearpath::horizon::payloads::RawSensor.

Definition at line 3476 of file payloads.py.

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

Human Readable Payload String.

Returns:
Human readable string representation of the payload
Return the payload as a human readable string

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

Definition at line 3482 of file payloads.py.


Member Data Documentation

Definition at line 3474 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