Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

GPSSensor Struct Reference

#include <SensorInfo.h>

Inheritance diagram for GPSSensor:

Detailed Description

Definition at line 139 of file SensorInfo.h.

List of all members.

Public Member Functions

 GPSSensor ()
 constructor
 GPSSensor (const GPSSensor &s)
 copy constructor for cloning
virtual void declareValues (DynamicRobotState &values)
 Subclass should add name/value pairs to the dictionary to allow variable number of values per Sensor, as well as fast filtering and serialization to subscribers.
virtual void reclaimValues (DynamicRobotState &values)
 Subclass should remove values added via previous declareValues().
virtual GPSSensorclone () const __attribute__((warn_unused_result))
 clone implementation for Dictionary

Public Attributes

plist::Primitive< std::string > sensorName
 Name of the sensor instance, to match up with the a sensorNames[] in RobotInfo header.
plist::Primitive< floatcurX
 current displacement along the X axis
plist::Primitive< floatcurY
 current displacement along the Y axis
plist::Primitive< floatcurZ
 current displacement along the Z axis
plist::Primitive< floatcurHeading
 current orientation

Static Public Attributes

static const std::string autoRegister = FamilyFactory<SensorInfo>::getRegistry().registerType<GPSSensor>("GPS")
 Provides registration with FamilyFactory<SensorInfo>

Protected Member Functions

void init ()
 performs common initialization

Constructor & Destructor Documentation

GPSSensor::GPSSensor (  ) 

constructor

Definition at line 141 of file SensorInfo.h.

GPSSensor::GPSSensor ( const GPSSensor s  ) 

copy constructor for cloning

Definition at line 143 of file SensorInfo.h.


Member Function Documentation

GPSSensor * GPSSensor::clone (  )  const [virtual]

clone implementation for Dictionary

implements the clone function for dictionary

Implements SensorInfo.

Definition at line 11 of file SensorInfo.cc.

virtual void GPSSensor::declareValues ( DynamicRobotState values  )  [virtual]

Subclass should add name/value pairs to the dictionary to allow variable number of values per Sensor, as well as fast filtering and serialization to subscribers.

A reference to a permanent plist::Primitive<float> instance should be added, this is how values are extracted from the sensor via this shared value.

Implements SensorInfo.

Definition at line 145 of file SensorInfo.h.

void GPSSensor::init (  )  [protected]

performs common initialization

Reimplemented from SensorInfo.

Definition at line 166 of file SensorInfo.h.

Referenced by GPSSensor().

virtual void GPSSensor::reclaimValues ( DynamicRobotState values  )  [virtual]

Subclass should remove values added via previous declareValues().

Implements SensorInfo.

Definition at line 151 of file SensorInfo.h.


Member Data Documentation

const std::string GPSSensor::autoRegister = FamilyFactory<SensorInfo>::getRegistry().registerType<GPSSensor>("GPS") [static]

Provides registration with FamilyFactory<SensorInfo>

Definition at line 162 of file SensorInfo.h.

current orientation

Definition at line 161 of file SensorInfo.h.

Referenced by declareValues().

current displacement along the X axis

Definition at line 158 of file SensorInfo.h.

Referenced by declareValues().

current displacement along the Y axis

Definition at line 159 of file SensorInfo.h.

Referenced by declareValues().

current displacement along the Z axis

Definition at line 160 of file SensorInfo.h.

Referenced by declareValues().

Name of the sensor instance, to match up with the a sensorNames[] in RobotInfo header.

Definition at line 157 of file SensorInfo.h.

Referenced by declareValues(), init(), and reclaimValues().


The documentation for this struct was generated from the following files:

Tekkotsu v5.1CVS
Generated Mon May 9 04:59:08 2016 by Doxygen 1.6.3