smp::interface_base< typeparams > Class Template Reference

The abstract class that specifies the structure of a interfacing component. More...

#include <base.h>

Inheritance diagram for smp::interface_base< typeparams >:

List of all members.

Public Member Functions
virtual int	publish_data ()=0
	Publishes the graph maintained by the planner.
virtual int	publish_trajectory (trajectory_t &trajectory)=0
	Publishes a given trajectory.

---

Detailed Description

template<class typeparams>
class smp::interface_base< typeparams >

The abstract class that specifies the structure of a interfacing component.

The interfacing component provides a function to publish the graph that is stored in the planner. It also provides a function to visualize a certain trajectory (for instance, this trajectory can be the optimal trajectory in the graph).

---

Member Function Documentation

template<class typeparams >

virtual int smp::interface_base< typeparams >::publish_data

(

)

[pure virtual]

Publishes the graph maintained by the planner.

This function publishes the graph maintained by the planner.

Returns:

Returns 1 for success, and a non-positive value to indicate an error.

Implemented in smp::interface_libbot< typeparams >.

template<class typeparams >

virtual int smp::interface_base< typeparams >::publish_trajectory

(

trajectory_t &

trajectory

)

[pure virtual]

Publishes a given trajectory.

This function will send out the messages (of the development environment) containing the trajectory given as an argument.

Parameters:

trajectory

The trajectory that will be published.

Returns:

Returns 1 for success, and a non-positive value to indicate an error.

Implemented in smp::interface_libbot< typeparams >.

---

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

• src/smp/interfaces/base.h