The pure virtual class representing an Action. It has members that are in common to all derived class. More...
#include <Action.h>
Public Types | |
| typedef std::shared_ptr< const Action > | ConstPtr |
| typedef std::shared_ptr< Action > | Ptr |
| enum | Type { Primitive, Generic, Composed, Timed, None } |
| Enum useful to discriminate each action when, for example, we want to parse a file @remind if you change this enum, change also the ROSEEControl.msg accordingly. More... | |
Public Member Functions | |
| virtual void | emitYaml (YAML::Emitter &out) const =0 |
| Function to fill the argument passed with info about the action. Pure virtual because each derived class has different infos and stored differently. check YamlWorker to correctly emit and parse the file. More... | |
| virtual bool | fillFromYaml (YAML::const_iterator yamlIt)=0 |
| function to fill members of the Action with infos taken from yaml files More... | |
| virtual std::vector< ROSEE::JointPos > | getAllJointPos () const =0 |
| Return all the joint position stored. If the concrete (derived from Action) has only one joint position info, this function is equal to getJointPos. More... | |
| std::set< std::string > | getFingersInvolved () const |
| Get for fingersInvolved. More... | |
| virtual JointPos | getJointPos () const =0 |
| Get the position related to this action. Pure Virtual function: the derived class store this info differently so they are in charge of providing the read. More... | |
| JointsInvolvedCount | getJointsInvolvedCount () const |
| Get for jointsInvolvedCount. More... | |
| std::string | getName () const |
| Get the name of the action. More... | |
| Type | getType () const |
| virtual void | print () const |
| Overridable functions, if we want to make them more action-specific. More... | |
| virtual | ~Action () |
Protected Member Functions | |
| Action () | |
| Action (std::string actionName, Action::Type type) | |
Protected Attributes | |
| std::set< std::string > | fingersInvolved |
| JointsInvolvedCount | jointsInvolvedCount |
| std::string | name |
| Action::Type | type |
Detailed Description
The pure virtual class representing an Action. It has members that are in common to all derived class.
Member Typedef Documentation
◆ ConstPtr
| typedef std::shared_ptr<const Action> ROSEE::Action::ConstPtr |
◆ Ptr
| typedef std::shared_ptr<Action> ROSEE::Action::Ptr |
Member Enumeration Documentation
◆ Type
| enum ROSEE::Action::Type |
Constructor & Destructor Documentation
◆ ~Action()
◆ Action() [1/2]
|
protected |
Definition at line 106 of file Action.cpp.
◆ Action() [2/2]
|
protected |
Definition at line 111 of file Action.cpp.
Member Function Documentation
◆ emitYaml()
|
pure virtual |
Function to fill the argument passed with info about the action. Pure virtual because each derived class has different infos and stored differently. check YamlWorker to correctly emit and parse the file.
- Parameters
-
out the yaml-cpp emitter which store infos about the action
- Note
- this function does not print in a file, but simply fill a YAML::Emitter.
Implemented in ROSEE::ActionTimed, ROSEE::ActionComposed, ROSEE::ActionSingleJointMultipleTips, ROSEE::ActionGeneric, ROSEE::ActionPinchLoose, ROSEE::ActionMultiplePinchTight, ROSEE::ActionPinchTight, and ROSEE::ActionPrimitive.
◆ fillFromYaml()
|
pure virtual |
function to fill members of the Action with infos taken from yaml files
- Parameters
-
yamlIt a YAML::const_iterator to the node that is loaded with YAML::LoadFile(dirPath + filename). check YamlWorker to correctly parse and emit the file
Implemented in ROSEE::ActionTimed, ROSEE::ActionTrig, ROSEE::ActionComposed, ROSEE::ActionPinchLoose, ROSEE::ActionMultiplePinchTight, ROSEE::ActionGeneric, ROSEE::ActionSingleJointMultipleTips, and ROSEE::ActionPinchTight.
◆ getAllJointPos()
|
pure virtual |
Return all the joint position stored. If the concrete (derived from Action) has only one joint position info, this function is equal to getJointPos.
- Returns
- vector containing all the joint pos of the action
Implemented in ROSEE::ActionTrig, ROSEE::ActionGeneric, ROSEE::ActionTimed, ROSEE::ActionMultiplePinchTight, ROSEE::ActionSingleJointMultipleTips, ROSEE::ActionPinchLoose, and ROSEE::ActionPinchTight.
◆ getFingersInvolved()
| std::set< std::string > ROSEE::Action::getFingersInvolved | ( | ) | const |
Get for fingersInvolved.
- Returns
- std::set<std::string> the set containing all the hand's fingers involved in the action
Definition at line 125 of file Action.cpp.
◆ getJointPos()
|
pure virtual |
Get the position related to this action. Pure Virtual function: the derived class store this info differently so they are in charge of providing the read.
- Returns
- JointsPos the map indicating how the position of the joint
Implemented in ROSEE::ActionTrig, ROSEE::ActionSingleJointMultipleTips, ROSEE::ActionGeneric, ROSEE::ActionTimed, ROSEE::ActionMultiplePinchTight, ROSEE::ActionPinchLoose, and ROSEE::ActionPinchTight.
◆ getJointsInvolvedCount()
| ROSEE::JointsInvolvedCount ROSEE::Action::getJointsInvolvedCount | ( | ) | const |
Get for jointsInvolvedCount.
- Returns
- JointsInvolvedCount the map indicating how many times the joint is set by the action
Definition at line 130 of file Action.cpp.
◆ getName()
| std::string ROSEE::Action::getName | ( | ) | const |
Get the name of the action.
- Returns
- std::string the name of the action
Definition at line 116 of file Action.cpp.
◆ getType()
| ROSEE::Action::Type ROSEE::Action::getType | ( | ) | const |
Definition at line 120 of file Action.cpp.
◆ print()
|
virtual |
Overridable functions, if we want to make them more action-specific.
Reimplemented in ROSEE::ActionTimed, ROSEE::ActionPinchLoose, ROSEE::ActionMultiplePinchTight, ROSEE::ActionSingleJointMultipleTips, ROSEE::ActionPinchTight, and ROSEE::ActionComposed.
Definition at line 135 of file Action.cpp.
Member Data Documentation
◆ fingersInvolved
|
protected |
◆ jointsInvolvedCount
|
protected |
◆ name
◆ type
|
protected |
The documentation for this class was generated from the following files: