CovarianceMarkersAlgorithm Class Reference

IRI ROS Specific Driver Class. More...

#include <covariance_markers_alg.h>

List of all members.

Public Types
typedef iri_covariance_markers::CovarianceMarkersConfig	Config
	define config type
Public Member Functions
void	config_update (const Config &new_cfg, uint32_t level=0)
	config update
	CovarianceMarkersAlgorithm ()
	constructor
void	drawCovariance ()
	fill marker array message
void	lock (void)
	Lock Algorithm.
visualization_msgs::MarkerArray	marker_array ()
	get marker array
bool	try_enter (void)
	Tries Access to Algorithm.
void	unlock (void)
	Unlock Algorithm.
	~CovarianceMarkersAlgorithm ()
	Destructor.
Public Attributes
float	color_alpha_
float	color_blue_
float	color_green_
float	color_red_
Config	config_
	config variable
uint	counter_
visualization_msgs::Marker	current_marker_
std::string	frame_id_
visualization_msgs::MarkerArray	marker_array_
std::string	namespace_
nav_msgs::Odometry	odom_
float	scale_multiplier_
float	scale_multiplier_z_
Protected Attributes
CMutex	alg_mutex_
	define config type

---

Detailed Description

IRI ROS Specific Driver Class.

Definition at line 42 of file covariance_markers_alg.h.

---

Member Typedef Documentation

typedef iri_covariance_markers::CovarianceMarkersConfig CovarianceMarkersAlgorithm::Config

define config type

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

Definition at line 62 of file covariance_markers_alg.h.

---

Constructor & Destructor Documentation

CovarianceMarkersAlgorithm::CovarianceMarkersAlgorithm

(

)

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

CovarianceMarkersAlgorithm::~CovarianceMarkersAlgorithm

(

)

Destructor.

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

Definition at line 16 of file covariance_markers_alg.cpp.

---

Member Function Documentation

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

Definition at line 20 of file covariance_markers_alg.cpp.

void CovarianceMarkersAlgorithm::drawCovariance

(

)

fill marker array message

Definition at line 40 of file covariance_markers_alg.cpp.

void CovarianceMarkersAlgorithm::lock

(

void

)

[inline]

Lock Algorithm.

Locks access to the Algorithm class

Definition at line 87 of file covariance_markers_alg.h.

visualization_msgs::MarkerArray CovarianceMarkersAlgorithm::marker_array

(

)

get marker array

Definition at line 103 of file covariance_markers_alg.cpp.

bool CovarianceMarkersAlgorithm::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 covariance_markers_alg.h.

void CovarianceMarkersAlgorithm::unlock

(

void

)

[inline]

Unlock Algorithm.

Unlocks access to the Algorithm class

Definition at line 94 of file covariance_markers_alg.h.

---

Member Data Documentation

CMutex CovarianceMarkersAlgorithm::alg_mutex_ [protected]

define config type

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

Definition at line 51 of file covariance_markers_alg.h.

float CovarianceMarkersAlgorithm::color_alpha_

Definition at line 126 of file covariance_markers_alg.h.

float CovarianceMarkersAlgorithm::color_blue_

Definition at line 129 of file covariance_markers_alg.h.

float CovarianceMarkersAlgorithm::color_green_

Definition at line 128 of file covariance_markers_alg.h.

float CovarianceMarkersAlgorithm::color_red_

Definition at line 127 of file covariance_markers_alg.h.

Config CovarianceMarkersAlgorithm::config_

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 covariance_markers_alg.h.

uint CovarianceMarkersAlgorithm::counter_

Definition at line 123 of file covariance_markers_alg.h.

visualization_msgs::Marker CovarianceMarkersAlgorithm::current_marker_

Definition at line 133 of file covariance_markers_alg.h.

std::string CovarianceMarkersAlgorithm::frame_id_

Definition at line 121 of file covariance_markers_alg.h.

visualization_msgs::MarkerArray CovarianceMarkersAlgorithm::marker_array_

Definition at line 132 of file covariance_markers_alg.h.

std::string CovarianceMarkersAlgorithm::namespace_

Definition at line 122 of file covariance_markers_alg.h.

nav_msgs::Odometry CovarianceMarkersAlgorithm::odom_

Definition at line 131 of file covariance_markers_alg.h.

float CovarianceMarkersAlgorithm::scale_multiplier_

Definition at line 124 of file covariance_markers_alg.h.

float CovarianceMarkersAlgorithm::scale_multiplier_z_

Definition at line 125 of file covariance_markers_alg.h.

---

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

• covariance_markers_alg.h
• covariance_markers_alg.cpp