Trajectory2MarkersAlgorithm Class Reference

IRI ROS Specific Driver Class. More...

#include <trajectory_2_markers_alg.h>

List of all members.

Public Types
typedef iri_poseslam::PoseslamConfig	Config
	define config type
Public Member Functions
void	config_update (Config &new_cfg, uint32_t level=0)
	config update
void	lock (void)
	Lock Algorithm.
	Trajectory2MarkersAlgorithm (void)
	constructor
bool	try_enter (void)
	Tries Access to Algorithm.
void	unlock (void)
	Unlock Algorithm.
	~Trajectory2MarkersAlgorithm (void)
	Destructor.
Protected Attributes
CMutex	alg_mutex_
	define config type

---

Detailed Description

IRI ROS Specific Driver Class.

Definition at line 36 of file trajectory_2_markers_alg.h.

---

Member Typedef Documentation

typedef iri_poseslam::PoseslamConfig Trajectory2MarkersAlgorithm::Config

define config type

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

Definition at line 57 of file trajectory_2_markers_alg.h.

---

Constructor & Destructor Documentation

Trajectory2MarkersAlgorithm::Trajectory2MarkersAlgorithm

(

void

)

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 trajectory_2_markers_alg.cpp.

Trajectory2MarkersAlgorithm::~Trajectory2MarkersAlgorithm

(

void

)

Destructor.

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

Definition at line 7 of file trajectory_2_markers_alg.cpp.

---

Member Function Documentation

void Trajectory2MarkersAlgorithm::config_update	(	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_cfg	the new driver configuration state
level	level in which the update is taken place

Definition at line 11 of file trajectory_2_markers_alg.cpp.

void Trajectory2MarkersAlgorithm::lock

(

void

)

[inline]

Lock Algorithm.

Locks access to the Algorithm class

Definition at line 74 of file trajectory_2_markers_alg.h.

bool Trajectory2MarkersAlgorithm::try_enter

(

void

)

[inline]

Tries Access to Algorithm.

Tries access to Algorithm

Returns:

true if the lock was adquired, false otherwise

Definition at line 90 of file trajectory_2_markers_alg.h.

void Trajectory2MarkersAlgorithm::unlock

(

void

)

[inline]

Unlock Algorithm.

Unlocks access to the Algorithm class

Definition at line 81 of file trajectory_2_markers_alg.h.

---

Member Data Documentation

CMutex Trajectory2MarkersAlgorithm::alg_mutex_ [protected]

define config type

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

Definition at line 45 of file trajectory_2_markers_alg.h.

---

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

• trajectory_2_markers_alg.h
• trajectory_2_markers_alg.cpp