Public Types | Public Member Functions | Public Attributes | Protected Attributes | Private Attributes
ZyonzObtainTwoClusteredLeavesAlgorithm Class Reference

IRI ROS Specific Driver Class. More...

#include <zyonz_obtain_two_clustered_leaves_alg.h>

List of all members.

Public Types

typedef
zyonz_obtain_two_clustered_leaves::ZyonzObtainTwoClusteredLeavesConfig 
Config
 define config type

Public Member Functions

void config_update (Config &new_cfg, uint32_t level=0)
 config update
bool extract_clusters (sensor_msgs::PointCloud2::ConstPtr &msg)
 extract clusters
pcl::PointCloud
< pcl::PointXYZRGB >::ConstPtr 
get_cluster_a (void)
sensor_msgs::Image * get_cluster_a_img (void)
pcl::PointCloud
< pcl::PointXYZRGB >::ConstPtr 
get_cluster_b (void)
sensor_msgs::Image * get_cluster_b_img (void)
void lock (void)
 Lock Algorithm.
bool try_enter (void)
 Tries Access to Algorithm.
void unlock (void)
 Unlock Algorithm.
 ZyonzObtainTwoClusteredLeavesAlgorithm (void)
 constructor
 ~ZyonzObtainTwoClusteredLeavesAlgorithm (void)
 Destructor.

Public Attributes

Config config_
 config variable

Protected Attributes

CMutex alg_mutex_
 define config type

Private Attributes

pcl::PointCloud< pcl::PointXYZRGB > cluster_a_
sensor_msgs::Image cluster_a_img_
pcl::PointCloud< pcl::PointXYZRGB > cluster_b_
sensor_msgs::Image cluster_b_img_

Detailed Description

IRI ROS Specific Driver Class.

Definition at line 40 of file zyonz_obtain_two_clustered_leaves_alg.h.


Member Typedef Documentation

typedef zyonz_obtain_two_clustered_leaves::ZyonzObtainTwoClusteredLeavesConfig ZyonzObtainTwoClusteredLeavesAlgorithm::Config

define config type

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

Definition at line 67 of file zyonz_obtain_two_clustered_leaves_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 5 of file zyonz_obtain_two_clustered_leaves_alg.cpp.

Destructor.

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

Definition at line 9 of file zyonz_obtain_two_clustered_leaves_alg.cpp.


Member Function Documentation

void ZyonzObtainTwoClusteredLeavesAlgorithm::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_cfgthe new driver configuration state
levellevel in which the update is taken place

Definition at line 13 of file zyonz_obtain_two_clustered_leaves_alg.cpp.

bool ZyonzObtainTwoClusteredLeavesAlgorithm::extract_clusters ( sensor_msgs::PointCloud2::ConstPtr &  msg)

extract clusters

Definition at line 24 of file zyonz_obtain_two_clustered_leaves_alg.cpp.

Definition at line 98 of file zyonz_obtain_two_clustered_leaves_alg.cpp.

Definition at line 108 of file zyonz_obtain_two_clustered_leaves_alg.cpp.

Definition at line 103 of file zyonz_obtain_two_clustered_leaves_alg.cpp.

Definition at line 113 of file zyonz_obtain_two_clustered_leaves_alg.cpp.

Lock Algorithm.

Locks access to the Algorithm class

Definition at line 92 of file zyonz_obtain_two_clustered_leaves_alg.h.

Tries Access to Algorithm.

Tries access to Algorithm

Returns:
true if the lock was adquired, false otherwise

Definition at line 108 of file zyonz_obtain_two_clustered_leaves_alg.h.

Unlock Algorithm.

Unlocks access to the Algorithm class

Definition at line 99 of file zyonz_obtain_two_clustered_leaves_alg.h.


Member Data Documentation

define config type

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

Definition at line 56 of file zyonz_obtain_two_clustered_leaves_alg.h.

Definition at line 44 of file zyonz_obtain_two_clustered_leaves_alg.h.

Definition at line 46 of file zyonz_obtain_two_clustered_leaves_alg.h.

Definition at line 45 of file zyonz_obtain_two_clustered_leaves_alg.h.

Definition at line 47 of file zyonz_obtain_two_clustered_leaves_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 75 of file zyonz_obtain_two_clustered_leaves_alg.h.


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


zyonz_obtain_two_clustered_leaves
Author(s): sfoix
autogenerated on Fri Dec 6 2013 20:35:16