smp::interface_libbot< typeparams > Class Template Reference

libbot interface for smp More...

#include <libbot.h>

Inheritance diagram for smp::interface_libbot< typeparams >:
smp::interface_base< typeparams >

List of all members.

Public Member Functions

int set_planner (planner_t *planner_in)
 Sets the planner.
int visualize_2d ()
 Sets visialization mode to 2D.
int visualize_3d ()
 Sets visialization mode to 3D.
int publish_environment (const environment_t &environment_in)
 Publishes the given environment.
int publish_data ()
 Publishes the graph maintained by the planner.
int publish_trajectory (trajectory_t &trajectory_in)
 Publishes a given trajectory.

Detailed Description


Member Function Documentation

template<class typeparams >
int smp::interface_libbot< typeparams >::publish_data ( ) [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.

Implements smp::interface_base< typeparams >.

template<class typeparams >
int smp::interface_libbot< typeparams >::publish_environment ( const environment_t environment_in)

Publishes the given environment.

This function constructs the necessary lcm messages and publishes the environment given as an argument through the ENVIRONMENT channel, which is listened by the renderer_smp of the libbot/viewer.

Parameters:
environment_inThe environment to be published.
Returns:
Returns 1 for success, and a non-positive value to indicate an error.
template<class typeparams >
int smp::interface_libbot< typeparams >::publish_trajectory ( trajectory_t trajectory) [virtual]

Publishes a given trajectory.

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

Parameters:
trajectoryThe trajectory that will be published.
Returns:
Returns 1 for success, and a non-positive value to indicate an error.

Implements smp::interface_base< typeparams >.

template<class typeparams >
int smp::interface_libbot< typeparams >::set_planner ( planner_t planner_in)

Sets the planner.

This function sets the planner variable to the new planner given as the argument.

Parameters:
planner_inThe new planner
Returns:
Returns 1 for success, and a non-positive value to indicate an error.
template<class typeparams >
int smp::interface_libbot< typeparams >::visualize_2d ( )

Sets visialization mode to 2D.

This function sets the visualization mode to 2D. When the visualization mode is set to 2D, the planner projects all the data to the z = 0 plane, i.e., fills in the third dimension with zeros.

Returns:
Returns 1 for success, and a non-positive value to indicate an error.
template<class typeparams >
int smp::interface_libbot< typeparams >::visualize_3d ( )

Sets visialization mode to 3D.

This function sets the visualization mode to 3D. When the visualization mode is set to 3D, third dimension in the data is taken into account. It is users responsibility to ensure that the data is in fact at least three dimensional.

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

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