openjaus::mobility::LocalPoseSensorInterface Class Reference

Provides an abstract interface for the LocalPoseSensor service. More...

#include <LocalPoseSensorInterface.h>

Inherited by openjaus::mobility::LocalPoseSensor.

List of all members.

Public Member Functions
virtual	~LocalPoseSensorInterface ()
virtual ReportLocalPose	getReportLocalPose (QueryLocalPose *queryLocalPose)=0
	Send action for ReportLocalPose with input message QueryLocalPose.
virtual bool	updateLocalPose (SetLocalPose *setLocalPose)=0
	UpdateLocalPose action with input SetLocalPose.
virtual bool	isControllingLposClient (SetLocalPose *setLocalPose)=0
	isControllingLposClient condition.

---

Detailed Description

The function of the Local Pose Sensor is to report the local position and orientation of the platform. The Report Local Pose message provides the position and orientation of the platform relative to a local reference frame. The origin of the local reference frame may be altered using the Set Local Pose message, which sets the current position and orientation of the platform to the specified values. Platform orientation is defined in Section 3 of this document.

URI: urn:jaus:jss:mobility:LocalPoseSensor

Version: 1.0

Inherits From:

• urn:jaus:jss:core:AccessControl

---

Constructor & Destructor Documentation

virtual openjaus::mobility::LocalPoseSensorInterface::~LocalPoseSensorInterface

(

)

[inline, virtual]

---

Member Function Documentation

virtual ReportLocalPose openjaus::mobility::LocalPoseSensorInterface::getReportLocalPose

(

QueryLocalPose *

queryLocalPose

)

[pure virtual]

Send action for ReportLocalPose with input message QueryLocalPose.

Parameters:

[in]

queryLocalPose

- Input Trigger.

Returns:

ReportLocalPose Output Message.

Implemented in openjaus::mobility::LocalPoseSensor.

virtual bool openjaus::mobility::LocalPoseSensorInterface::isControllingLposClient

(

SetLocalPose *

setLocalPose

)

[pure virtual]

isControllingLposClient condition.

Parameters:

[in]

setLocalPose

- Input Trigger.

Returns:

Whether the condition is true.

Implemented in openjaus::mobility::LocalPoseSensor.

virtual bool openjaus::mobility::LocalPoseSensorInterface::updateLocalPose

(

SetLocalPose *

setLocalPose

)

[pure virtual]

UpdateLocalPose action with input SetLocalPose.

Parameters:

[in]

setLocalPose

- Input Trigger.

Returns:

Whether the message was properly processed by this action.

Implemented in openjaus::mobility::LocalPoseSensor.

---

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

• include/openjaus/mobility/LocalPoseSensorInterface.h