Public Types | Public Member Functions | Public Attributes | Protected Attributes
PasulaLearnerAlgorithm Class Reference

IRI ROS Specific Driver Class. More...

#include <pasula_learner_alg.h>

List of all members.

Public Types

typedef
iri_pasula_learner::PasulaLearnerConfig 
Config
 define config type

Public Member Functions

void config_update (Config &new_cfg, uint32_t level=0)
 config update
bool learn_rules ()
void lock (void)
 Lock Algorithm.
 PasulaLearnerAlgorithm (void)
 constructor
bool try_enter (void)
 Tries Access to Algorithm.
void unlock (void)
 Unlock Algorithm.
 ~PasulaLearnerAlgorithm (void)
 Destructor.

Public Attributes

Config config_
 config variable

Protected Attributes

CMutex alg_mutex_
 define config type
double alpha_pen
double noise_lower_bound
double noise_lower_bound_default_rule
std::string rules_file
std::string symbols_file
std::string transitions_file

Detailed Description

IRI ROS Specific Driver Class.

Definition at line 39 of file pasula_learner_alg.h.


Member Typedef Documentation

typedef iri_pasula_learner::PasulaLearnerConfig PasulaLearnerAlgorithm::Config

define config type

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

Definition at line 69 of file pasula_learner_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 3 of file pasula_learner_alg.cpp.

Destructor.

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

Definition at line 7 of file pasula_learner_alg.cpp.


Member Function Documentation

void PasulaLearnerAlgorithm::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 11 of file pasula_learner_alg.cpp.

Definition at line 33 of file pasula_learner_alg.cpp.

void PasulaLearnerAlgorithm::lock ( void  ) [inline]

Lock Algorithm.

Locks access to the Algorithm class

Definition at line 94 of file pasula_learner_alg.h.

Tries Access to Algorithm.

Tries access to Algorithm

Returns:
true if the lock was adquired, false otherwise

Definition at line 110 of file pasula_learner_alg.h.

void PasulaLearnerAlgorithm::unlock ( void  ) [inline]

Unlock Algorithm.

Unlocks access to the Algorithm class

Definition at line 101 of file pasula_learner_alg.h.


Member Data Documentation

define config type

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

Definition at line 48 of file pasula_learner_alg.h.

Definition at line 56 of file pasula_learner_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 77 of file pasula_learner_alg.h.

Definition at line 58 of file pasula_learner_alg.h.

Definition at line 60 of file pasula_learner_alg.h.

std::string PasulaLearnerAlgorithm::rules_file [protected]

Definition at line 51 of file pasula_learner_alg.h.

std::string PasulaLearnerAlgorithm::symbols_file [protected]

Definition at line 53 of file pasula_learner_alg.h.

Definition at line 52 of file pasula_learner_alg.h.


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


iri_pasula_learner
Author(s): dmartinez
autogenerated on Fri Dec 6 2013 23:28:46