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

IRI ROS Specific Driver Class. More...

#include <rule_learner_alg.h>

List of all members.

Public Types

typedef
iri_rule_learner::RuleLearnerConfig 
Config
 define config type

Public Member Functions

std::vector< std::string > actions_needing_pasula_learning ()
bool add_action (std::string action_name, std::vector< uint > params)
void add_execution (std::string state)
bool add_state (std::string state)
void config_update (Config &new_cfg, uint32_t level=0)
 config update
TransitionList get_transitions ()
TransitionList get_transitions_with_actions (std::vector< std::string > actions)
void lock (void)
 Lock Algorithm.
void reset_new_transitions ()
 RuleLearnerAlgorithm (void)
 constructor
bool try_enter (void)
 Tries Access to Algorithm.
void unlock (void)
 Unlock Algorithm.
std::vector< int > update_with_pasula_rules (std::vector< std::string > actions, TransitionList transitions)
void write_transitions (TransitionList transitions)
 ~RuleLearnerAlgorithm (void)
 Destructor.

Public Attributes

Config config_
 config variable

Protected Attributes

CMutex alg_mutex_
 define config type
std::string backup_transitions_path_
std::string debugging_rules_path_
Symbol last_action_
std::string last_state_
int learning_m_
bool needs_learning_
TransitionList new_transitions_
std::string pasula_rules_path_
std::string restore_transitions_path_
RuleSet rules_
std::string rules_path_
TransitionList transitions_
std::string transitions_path_
std::string updated_rules_path_

Detailed Description

IRI ROS Specific Driver Class.

Definition at line 45 of file rule_learner_alg.h.


Member Typedef Documentation

typedef iri_rule_learner::RuleLearnerConfig RuleLearnerAlgorithm::Config

define config type

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

Definition at line 79 of file rule_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 rule_learner_alg.cpp.

Destructor.

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

Definition at line 8 of file rule_learner_alg.cpp.


Member Function Documentation

Definition at line 160 of file rule_learner_alg.cpp.

bool RuleLearnerAlgorithm::add_action ( std::string  action_name,
std::vector< uint >  params 
)

Definition at line 70 of file rule_learner_alg.cpp.

void RuleLearnerAlgorithm::add_execution ( std::string  state)

Definition at line 96 of file rule_learner_alg.cpp.

bool RuleLearnerAlgorithm::add_state ( std::string  state)

Definition at line 48 of file rule_learner_alg.cpp.

void RuleLearnerAlgorithm::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 12 of file rule_learner_alg.cpp.

Definition at line 156 of file rule_learner_alg.h.

Definition at line 171 of file rule_learner_alg.cpp.

void RuleLearnerAlgorithm::lock ( void  ) [inline]

Lock Algorithm.

Locks access to the Algorithm class

Definition at line 104 of file rule_learner_alg.h.

Definition at line 192 of file rule_learner_alg.cpp.

Tries Access to Algorithm.

Tries access to Algorithm

Returns:
true if the lock was adquired, false otherwise

Definition at line 120 of file rule_learner_alg.h.

void RuleLearnerAlgorithm::unlock ( void  ) [inline]

Unlock Algorithm.

Unlocks access to the Algorithm class

Definition at line 111 of file rule_learner_alg.h.

std::vector< int > RuleLearnerAlgorithm::update_with_pasula_rules ( std::vector< std::string >  actions,
TransitionList  transitions 
)

Definition at line 116 of file rule_learner_alg.cpp.

Definition at line 188 of file rule_learner_alg.cpp.


Member Data Documentation

define config type

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

Definition at line 54 of file rule_learner_alg.h.

Definition at line 61 of file rule_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 87 of file rule_learner_alg.h.

Definition at line 60 of file rule_learner_alg.h.

Definition at line 63 of file rule_learner_alg.h.

std::string RuleLearnerAlgorithm::last_state_ [protected]

Definition at line 64 of file rule_learner_alg.h.

Definition at line 59 of file rule_learner_alg.h.

Definition at line 65 of file rule_learner_alg.h.

Definition at line 67 of file rule_learner_alg.h.

Definition at line 60 of file rule_learner_alg.h.

Definition at line 61 of file rule_learner_alg.h.

Definition at line 68 of file rule_learner_alg.h.

std::string RuleLearnerAlgorithm::rules_path_ [protected]

Definition at line 60 of file rule_learner_alg.h.

Definition at line 67 of file rule_learner_alg.h.

std::string RuleLearnerAlgorithm::transitions_path_ [protected]

Definition at line 61 of file rule_learner_alg.h.

Definition at line 60 of file rule_learner_alg.h.


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


iri_rule_learner
Author(s): dmartinez
autogenerated on Fri Dec 6 2013 20:43:48