The Robot Application Programming Interface Delegate Project
RAPID Logo

RapidPositionSample Class Reference

The helper classes will have both the config and the current state. More...

Inheritance diagram for RapidPositionSample:
Collaboration diagram for RapidPositionSample:

List of all members.

Public Member Functions

 RapidPositionSample (PositionSample sample, PositionConfig config, Map< String, DataTypeIndex > keyIndexes)
Transform3D getCurrentPositionSample ()
 XXX mallan: can we get rid of "Current" in this method name? There is no non-current position data, and it isn't balanced with setPositionData.
float[] getRotationMatrix ()
double[] getXYZ ()
float[] getVelocityVector ()
 XXX mallan: can we lose "Vector" here? The return type makes it clear it's a vector.
double getSpeedMetersPerSecond ()
 XXX can we get rid of "MetersPerSecond"? We can document in comments if people are unclear return current speed in [m/s].
float getHeading ()
 This is returning in radians.
double getHeadingValue ()
void setHeadingValue (double headingVal)
String toString ()
void initializeVariables ()
 ensure that there is no way to send over a null through the wire
Copyable getCopyable ()
Copyable getConfig ()
void populateTopLevelAttributes ()
 MAE-4255: create top level access variables to simplify access.
KeyTypeValueHelper getKeyValueHelper ()

Public Attributes

PositionSample positionSample
PositionConfig positionConfig
Map< String, String > mappedTelemetry = new LinkedHashMap<String, String>()

Protected Attributes

final KeyTypeValueHelper keyValueHelper

Detailed Description

If you are using the helper classes, you should be able to obtain all the information from the helper and not have to look at the individual message type.


Constructor & Destructor Documentation

RapidPositionSample ( PositionSample  sample,
PositionConfig  config,
Map< String, DataTypeIndex keyIndexes 
)

Member Function Documentation

Copyable getConfig ( )
Copyable getCopyable ( )

Reimplemented from RapidMessageAdapter.

Transform3D getCurrentPositionSample ( )
float getHeading ( )

XXX FIXME This has to be changed such that the calculation is not done here, it should just return the heading value. How you get the value is dependent of whether the heading has already been computed. If it has not been computed, then compute it. If it has been computed, then no need to recompute.

verify heading information

Returns:
float

Here is the call graph for this function:

double getHeadingValue ( )
KeyTypeValueHelper getKeyValueHelper ( )
float [] getRotationMatrix ( )
double getSpeedMetersPerSecond ( )
Returns:
double

Here is the call graph for this function:

float [] getVelocityVector ( )
double [] getXYZ ( )
void initializeVariables ( )

Reimplemented from RapidMessageAdapter.

void populateTopLevelAttributes ( )

Reimplemented from RapidMessageAdapter.

Here is the call graph for this function:

void setHeadingValue ( double  headingVal)
String toString ( )

Implements IRapidMessage.

Here is the call graph for this function:


Member Data Documentation

Map<String, String> mappedTelemetry = new LinkedHashMap<String, String>()

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines