Sensors2LinkAlgorithm Class Reference

IRI ROS Specific Driver Class. More...

#include <sensors_2_link_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.
	Sensors2LinkAlgorithm (void)
	constructor
bool	try_enter (void)
	Tries Access to Algorithm.
void	unlock (void)
	Unlock Algorithm.
	~Sensors2LinkAlgorithm (void)
	Destructor.
Protected Attributes
CMutex	alg_mutex_
	define config type

---

Detailed Description

IRI ROS Specific Driver Class.

Definition at line 39 of file sensors_2_link_alg.h.

---

Member Typedef Documentation

typedef iri_poseslam::PoseslamConfig Sensors2LinkAlgorithm::Config

define config type

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

Definition at line 59 of file sensors_2_link_alg.h.

---

Constructor & Destructor Documentation

Sensors2LinkAlgorithm::Sensors2LinkAlgorithm

(

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

Sensors2LinkAlgorithm::~Sensors2LinkAlgorithm

(

void

)

Destructor.

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

Definition at line 7 of file sensors_2_link_alg.cpp.

---

Member Function Documentation

void Sensors2LinkAlgorithm::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 sensors_2_link_alg.cpp.

void Sensors2LinkAlgorithm::lock

(

void

)

[inline]

Lock Algorithm.

Locks access to the Algorithm class

Definition at line 76 of file sensors_2_link_alg.h.

bool Sensors2LinkAlgorithm::try_enter

(

void

)

[inline]

Tries Access to Algorithm.

Tries access to Algorithm

Returns:

true if the lock was adquired, false otherwise

Definition at line 92 of file sensors_2_link_alg.h.

void Sensors2LinkAlgorithm::unlock

(

void

)

[inline]

Unlock Algorithm.

Unlocks access to the Algorithm class

Definition at line 83 of file sensors_2_link_alg.h.

---

Member Data Documentation

CMutex Sensors2LinkAlgorithm::alg_mutex_ [protected]

define config type

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

Definition at line 48 of file sensors_2_link_alg.h.

---

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

• sensors_2_link_alg.h
• sensors_2_link_alg.cpp