Public Member Functions | List of all members
ROSEE::ActionPinchGeneric Class Reference

A base virtual class for the PinchTight and PinchLoose classes. It includes member and method that are in common between the two type of pinches. It derives the more generic ActionPrimitive. More...

#include <ActionPinchGeneric.h>

Inheritance diagram for ROSEE::ActionPinchGeneric:
Inheritance graph
[legend]

Public Member Functions

 ActionPinchGeneric (std::string name, ActionPrimitive::Type type)
 
 ActionPinchGeneric (std::string name, unsigned int maxStoredActionStates, ActionPrimitive::Type type)
 
 ActionPinchGeneric (std::string name, unsigned int nFingerInvolved, unsigned int maxStoredActionStates, ActionPrimitive::Type type)
 
std::set< std::string > getKeyElements () const override
 Necessary method to know the key used by the maps which store all the Actions of one type. Used by YamlWorker. More...
 
- Public Member Functions inherited from ROSEE::ActionPrimitive
virtual void emitYaml (YAML::Emitter &) const override
 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...
 
unsigned int getMaxStoredActionStates () const
 
unsigned int getnFingersInvolved () const
 
Type getPrimitiveType () const
 
void setJointsInvolvedCount (ROSEE::JointsInvolvedCount jointsInvolvedCount)
 
virtual ~ActionPrimitive ()
 
- Public Member Functions inherited from ROSEE::Action
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::JointPosgetAllJointPos () 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 ()
 

Additional Inherited Members

- Public Types inherited from ROSEE::ActionPrimitive
typedef std::shared_ptr< const ActionPrimitiveConstPtr
 
typedef std::shared_ptr< ActionPrimitivePtr
 
enum  Type {
  PinchTight, PinchLoose, MultiplePinchTight, Trig,
  TipFlex, FingFlex, SingleJointMultipleTips, None
}
 Enum useful to discriminate each primitive action when, for example, we want to parse a file @remind if you change this enum, change also the ROSEEControl.msg accordingly. More...
 
- Public Types inherited from ROSEE::Action
typedef std::shared_ptr< const ActionConstPtr
 
typedef std::shared_ptr< ActionPtr
 
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...
 
- Protected Member Functions inherited from ROSEE::ActionPrimitive
 ActionPrimitive (std::string name, unsigned int maxStoredActionStates, Type type)
 
 ActionPrimitive (std::string name, unsigned int nFingersInvolved, unsigned int maxStoredActionStates, Type type)
 Protected costructor: object creable only by derived classes. There is no default costructor (without arguments) because we want to set always these members. More...
 
- Protected Member Functions inherited from ROSEE::Action
 Action ()
 
 Action (std::string actionName, Action::Type type)
 
- Protected Attributes inherited from ROSEE::ActionPrimitive
const unsigned int maxStoredActionStates
 
unsigned int nFingersInvolved
 
const Type primitiveType
 
- Protected Attributes inherited from ROSEE::Action
std::set< std::string > fingersInvolved
 
JointsInvolvedCount jointsInvolvedCount
 
std::string name
 
Action::Type type
 

Detailed Description

A base virtual class for the PinchTight and PinchLoose classes. It includes member and method that are in common between the two type of pinches. It derives the more generic ActionPrimitive.

Definition at line 31 of file ActionPinchGeneric.h.

Constructor & Destructor Documentation

◆ ActionPinchGeneric() [1/3]

ROSEE::ActionPinchGeneric::ActionPinchGeneric ( std::string  name,
ActionPrimitive::Type  type 
)

@TODO KNOW the distance at a certain percentage? so se volgio prendere un oggetto largo 3 cm il programma sa quale รจ la percentage per avere una distanza di 3cm

Definition at line 26 of file ActionPinchGeneric.cpp.

◆ ActionPinchGeneric() [2/3]

ROSEE::ActionPinchGeneric::ActionPinchGeneric ( std::string  name,
unsigned int  maxStoredActionStates,
ActionPrimitive::Type  type 
)

Definition at line 29 of file ActionPinchGeneric.cpp.

◆ ActionPinchGeneric() [3/3]

ROSEE::ActionPinchGeneric::ActionPinchGeneric ( std::string  name,
unsigned int  nFingerInvolved,
unsigned int  maxStoredActionStates,
ActionPrimitive::Type  type 
)

Definition at line 32 of file ActionPinchGeneric.cpp.

Member Function Documentation

◆ getKeyElements()

std::set< std::string > ROSEE::ActionPinchGeneric::getKeyElements ( ) const
overridevirtual

Necessary method to know the key used by the maps which store all the Actions of one type. Used by YamlWorker.

Returns
for this class, it return the two tips names, inserted in a set because father signature say so

Implements ROSEE::ActionPrimitive.

Definition at line 36 of file ActionPinchGeneric.cpp.


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


end-effector
Author(s): Luca Muratore , Davide Torielli , Liana Bertoni
autogenerated on Sat Dec 14 2024 03:49:27