VwsAlgNode Class Reference

IRI ROS Specific Algorithm Class. More...

#include <vws_alg_node.h>

Inheritance diagram for VwsAlgNode:

List of all members.

Public Member Functions
	VwsAlgNode (void)
	Constructor.
	~VwsAlgNode (void)
	Destructor.
Protected Member Functions
void	addNodeDiagnostics (void)
	node add diagnostics
void	mainNodeThread (void)
	main node thread
void	node_config_update (Config &config, uint32_t level)
	dynamic reconfigure server callback
Private Member Functions
bool	get_vwsCallback (iri_perception_msgs::DescriptorsToVws::Request &req, iri_perception_msgs::DescriptorsToVws::Response &res)
bool	set_centroidsCallback (iri_publish_params::classifier_update_service::Request &req, iri_publish_params::classifier_update_service::Response &res)
Private Attributes
CMutex	get_vws_mutex_
ros::ServiceServer	get_vws_server_
CMutex	set_centroids_mutex_
ros::ServiceServer	set_centroids_server_

---

Detailed Description

IRI ROS Specific Algorithm Class.

Definition at line 43 of file vws_alg_node.h.

---

Constructor & Destructor Documentation

VwsAlgNode::VwsAlgNode

(

void

)

Constructor.

This constructor initializes specific class attributes and all ROS communications variables to enable message exchange.

Definition at line 3 of file vws_alg_node.cpp.

VwsAlgNode::~VwsAlgNode

(

void

)

Destructor.

This destructor frees all necessary dynamic memory allocated within this this class.

Definition at line 24 of file vws_alg_node.cpp.

---

Member Function Documentation

void VwsAlgNode::addNodeDiagnostics

(

void

)

[protected, virtual]

node add diagnostics

In this abstract function additional ROS diagnostics applied to the specific algorithms may be added.

Implements algorithm_base::IriBaseAlgorithm< VwsAlgorithm >.

Definition at line 107 of file vws_alg_node.cpp.

bool VwsAlgNode::get_vwsCallback	(	iri_perception_msgs::DescriptorsToVws::Request &	req,
		iri_perception_msgs::DescriptorsToVws::Response &	res
	)		[private]

Definition at line 71 of file vws_alg_node.cpp.

void VwsAlgNode::mainNodeThread

(

void

)

[protected, virtual]

main node thread

This is the main thread node function. Code written here will be executed in every node loop while the algorithm is on running state. Loop frequency can be tuned by modifying loop_rate attribute.

Here data related to the process loop or to ROS topics (mainly data structs related to the MSG and SRV files) must be updated. ROS publisher objects must publish their data in this process. ROS client servers may also request data to the corresponding server topics.

Implements algorithm_base::IriBaseAlgorithm< VwsAlgorithm >.

Definition at line 29 of file vws_alg_node.cpp.

void VwsAlgNode::node_config_update	(	Config &	config,
		uint32_t	level
	)		[protected, virtual]

dynamic reconfigure server callback

This method is called whenever a new configuration is received through the dynamic reconfigure. The derivated generic algorithm class must implement it.

Parameters:

config	an object with new configuration from all algorithm parameters defined in the config file.
level	integer referring the level in which the configuration has been changed.

Implements algorithm_base::IriBaseAlgorithm< VwsAlgorithm >.

Definition at line 100 of file vws_alg_node.cpp.

bool VwsAlgNode::set_centroidsCallback	(	iri_publish_params::classifier_update_service::Request &	req,
		iri_publish_params::classifier_update_service::Response &	res
	)		[private]

Definition at line 43 of file vws_alg_node.cpp.

---

Member Data Documentation

CMutex VwsAlgNode::get_vws_mutex_ [private]

Definition at line 56 of file vws_alg_node.h.

ros::ServiceServer VwsAlgNode::get_vws_server_ [private]

Definition at line 54 of file vws_alg_node.h.

CMutex VwsAlgNode::set_centroids_mutex_ [private]

Definition at line 53 of file vws_alg_node.h.

ros::ServiceServer VwsAlgNode::set_centroids_server_ [private]

Definition at line 51 of file vws_alg_node.h.

---

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

• vws_alg_node.h
• vws_alg_node.cpp