ZyonzNbvGeometricSimpleAlgorithm Class Reference

IRI ROS Specific Driver Class. More...

#include <zyonz_nbv_geometric_simple_alg.h>

List of all members.

Public Types
typedef zyonz_nbv_geometric_simple::ZyonzNbvGeometricSimpleConfig	Config
	define config type
Public Member Functions
void	config_update (Config &new_cfg, uint32_t level=0)
	config update
geometry_msgs::PoseStamped::Ptr	get_nbv () const
bool	isRunning (geometry_msgs::PoseStamped &viewpoint, geometry_msgs::PoseStamped &viewpoint_roi)
void	lock (void)
	Lock Algorithm.
bool	try_enter (void)
	Tries Access to Algorithm.
void	unlock (void)
	Unlock Algorithm.
	ZyonzNbvGeometricSimpleAlgorithm (void)
	constructor
	~ZyonzNbvGeometricSimpleAlgorithm (void)
	Destructor.
Public Attributes
Config	config_
	config variable
Protected Attributes
CMutex	alg_mutex_
	define config type
Private Attributes
geometry_msgs::PoseStamped::Ptr	nbv_ptr_

---

Detailed Description

IRI ROS Specific Driver Class.

Definition at line 40 of file zyonz_nbv_geometric_simple_alg.h.

---

Member Typedef Documentation

typedef zyonz_nbv_geometric_simple::ZyonzNbvGeometricSimpleConfig ZyonzNbvGeometricSimpleAlgorithm::Config

define config type

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

Definition at line 63 of file zyonz_nbv_geometric_simple_alg.h.

---

Constructor & Destructor Documentation

ZyonzNbvGeometricSimpleAlgorithm::ZyonzNbvGeometricSimpleAlgorithm

(

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

ZyonzNbvGeometricSimpleAlgorithm::~ZyonzNbvGeometricSimpleAlgorithm

(

void

)

Destructor.

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

Definition at line 8 of file zyonz_nbv_geometric_simple_alg.cpp.

---

Member Function Documentation

void ZyonzNbvGeometricSimpleAlgorithm::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 12 of file zyonz_nbv_geometric_simple_alg.cpp.

geometry_msgs::PoseStamped::Ptr ZyonzNbvGeometricSimpleAlgorithm::get_nbv

(

)

const

Definition at line 50 of file zyonz_nbv_geometric_simple_alg.cpp.

bool ZyonzNbvGeometricSimpleAlgorithm::isRunning	(	geometry_msgs::PoseStamped &	viewpoint,
		geometry_msgs::PoseStamped &	viewpoint_roi
	)

Definition at line 23 of file zyonz_nbv_geometric_simple_alg.cpp.

void ZyonzNbvGeometricSimpleAlgorithm::lock

(

void

)

[inline]

Lock Algorithm.

Locks access to the Algorithm class

Definition at line 88 of file zyonz_nbv_geometric_simple_alg.h.

bool ZyonzNbvGeometricSimpleAlgorithm::try_enter

(

void

)

[inline]

Tries Access to Algorithm.

Tries access to Algorithm

Returns:

true if the lock was adquired, false otherwise

Definition at line 104 of file zyonz_nbv_geometric_simple_alg.h.

void ZyonzNbvGeometricSimpleAlgorithm::unlock

(

void

)

[inline]

Unlock Algorithm.

Unlocks access to the Algorithm class

Definition at line 95 of file zyonz_nbv_geometric_simple_alg.h.

---

Member Data Documentation

CMutex ZyonzNbvGeometricSimpleAlgorithm::alg_mutex_ [protected]

define config type

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

Definition at line 52 of file zyonz_nbv_geometric_simple_alg.h.

Config ZyonzNbvGeometricSimpleAlgorithm::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 71 of file zyonz_nbv_geometric_simple_alg.h.

geometry_msgs::PoseStamped::Ptr ZyonzNbvGeometricSimpleAlgorithm::nbv_ptr_ [private]

Definition at line 43 of file zyonz_nbv_geometric_simple_alg.h.

---

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

• zyonz_nbv_geometric_simple_alg.h
• zyonz_nbv_geometric_simple_alg.cpp