Public Types | Public Member Functions | Public Attributes | Protected Attributes
Pose2dOdomAlgorithm Class Reference

IRI ROS Specific Driver Class. More...

#include <pose2d_odom_alg.h>

List of all members.

Public Types

typedef
iri_msg_to_odom::MessageToOdomConfig 
Config
 define config type

Public Member Functions

void config_update (const Config &new_cfg, uint32_t level=0)
 config update
void getOdometry (nav_msgs::Odometry &o, geometry_msgs::TransformStamped &t)
void lock (void)
 Lock Algorithm.
 Pose2dOdomAlgorithm ()
 constructor
bool try_enter (void)
 Tries Access to Algorithm.
void unlock (void)
 Unlock Algorithm.
 ~Pose2dOdomAlgorithm ()
 Destructor.

Public Attributes

Config config_
 config variable
std::string frame_id_
geometry_msgs::Pose2D new_pose2D_
ros::Time new_time_
geometry_msgs::Pose2D old_pose2D_
ros::Time old_time_
std::string parent_id_

Protected Attributes

CMutex alg_mutex_
 define config type

Detailed Description

IRI ROS Specific Driver Class.

Definition at line 42 of file pose2d_odom_alg.h.


Member Typedef Documentation

typedef iri_msg_to_odom::MessageToOdomConfig Pose2dOdomAlgorithm::Config

define config type

Define a Config type with the Pose2dOdomConfig. All driver implementations will then use the same variable type Config.

Definition at line 62 of file pose2d_odom_alg.h.


Constructor & Destructor Documentation

constructor

In this constructor parameters related to the specific driver can be initalized. Those parameters can be also set in the openDriver() function. Attributes from the main node driver class IriBaseDriver such as loop_rate, may be also overload here.

Definition at line 3 of file pose2d_odom_alg.cpp.

Destructor.

This destructor is called when the object is about to be destroyed.

Definition at line 7 of file pose2d_odom_alg.cpp.


Member Function Documentation

void Pose2dOdomAlgorithm::config_update ( const Config new_cfg,
uint32_t  level = 0 
)

config update

In this function the driver parameters must be updated with the input config variable. Then the new configuration state will be stored in the Config attribute.

Parameters:
new_cfgthe new driver configuration state
levellevel in which the update is taken place

Definition at line 11 of file pose2d_odom_alg.cpp.

void Pose2dOdomAlgorithm::getOdometry ( nav_msgs::Odometry &  o,
geometry_msgs::TransformStamped &  t 
)

Definition at line 24 of file pose2d_odom_alg.cpp.

void Pose2dOdomAlgorithm::lock ( void  ) [inline]

Lock Algorithm.

Locks access to the Algorithm class

Definition at line 87 of file pose2d_odom_alg.h.

bool Pose2dOdomAlgorithm::try_enter ( void  ) [inline]

Tries Access to Algorithm.

Tries access to Algorithm

Returns:
true if the lock was adquired, false otherwise

Definition at line 103 of file pose2d_odom_alg.h.

void Pose2dOdomAlgorithm::unlock ( void  ) [inline]

Unlock Algorithm.

Unlocks access to the Algorithm class

Definition at line 94 of file pose2d_odom_alg.h.


Member Data Documentation

CMutex Pose2dOdomAlgorithm::alg_mutex_ [protected]

define config type

Define a Config type with the Pose2dOdomConfig. All driver implementations will then use the same variable type Config.

Definition at line 51 of file pose2d_odom_alg.h.

config variable

This variable has all the driver parameters defined in the cfg config file. Is updated everytime function config_update() is called.

Definition at line 70 of file pose2d_odom_alg.h.

Definition at line 126 of file pose2d_odom_alg.h.

geometry_msgs::Pose2D Pose2dOdomAlgorithm::new_pose2D_

Definition at line 123 of file pose2d_odom_alg.h.

Definition at line 121 of file pose2d_odom_alg.h.

geometry_msgs::Pose2D Pose2dOdomAlgorithm::old_pose2D_

Definition at line 124 of file pose2d_odom_alg.h.

Definition at line 122 of file pose2d_odom_alg.h.

Definition at line 125 of file pose2d_odom_alg.h.


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


iri_msg_to_odom
Author(s): Marti Morta, mmorta at iri.upc.edu
autogenerated on Fri Dec 6 2013 22:08:38