ROSEndEffector
ROS End-Effector package: provides a ROS-based set of standard interfaces to command robotics end-effectors in an agnostic fashion.
Public Member Functions | List of all members
ROSEE::ActionPinchGeneric Class Reference

A base virtual class for the PinchTight and PinchLoose classes. More...

#include <ActionPinchGeneric.h>

+ Inheritance diagram for ROSEE::ActionPinchGeneric:
+ Collaboration diagram for ROSEE::ActionPinchGeneric:

Public Member Functions

 ActionPinchGeneric (std::string name, ActionPrimitive::Type type)
 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 More...
 
 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. More...
 
- Public Member Functions inherited from ROSEE::ActionPrimitive
virtual ~ActionPrimitive ()
 
Type getPrimitiveType () const
 
unsigned int getMaxStoredActionStates () const
 
unsigned int getnFingersInvolved () const
 
void setJointsInvolvedCount (ROSEE::JointsInvolvedCount jointsInvolvedCount)
 
virtual void emitYaml (YAML::Emitter &) const override
 Function to fill the argument passed with info about the action. More...
 
- Public Member Functions inherited from ROSEE::Action
virtual ~Action ()
 
std::string getName () const
 Get the name of the action. More...
 
Type getType () const
 
std::set< std::string > getFingersInvolved () const
 Get for fingersInvolved. More...
 
JointsInvolvedCount getJointsInvolvedCount () const
 Get for jointsInvolvedCount. More...
 
virtual JointPos getJointPos () const =0
 Get the position related to this action. More...
 
virtual std::vector< ROSEE::JointPosgetAllJointPos () const =0
 Return all the joint position stored. More...
 
virtual void print () const
 Overridable functions, if we want to make them more action-specific. More...
 
virtual bool fillFromYaml (YAML::const_iterator yamlIt)=0
 function to fill members of the Action with infos taken from yaml files More...
 

Additional Inherited Members

- Public Types inherited from ROSEE::ActionPrimitive
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 if you change this enum, change also the ROSEEControl.msg accordingly. More...
 
typedef std::shared_ptr< ActionPrimitivePtr
 
typedef std::shared_ptr< const ActionPrimitiveConstPtr
 
- Public Types inherited from ROSEE::Action
enum  Type {
  Primitive,
  Generic,
  Composed,
  Timed,
  None
}
 Enum useful to discriminate each action when, for example, we want to parse a file if you change this enum, change also the ROSEEControl.msg accordingly. More...
 
typedef std::shared_ptr< ActionPtr
 
typedef std::shared_ptr< const ActionConstPtr
 
- 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. More...
 
- Protected Member Functions inherited from ROSEE::Action
 Action ()
 
 Action (std::string actionName, Action::Type type)
 
- Protected Attributes inherited from ROSEE::ActionPrimitive
unsigned int nFingersInvolved
 
const unsigned int maxStoredActionStates
 
const Type primitiveType
 
- Protected Attributes inherited from ROSEE::Action
std::string name
 
Action::Type type
 
std::set< std::string > fingersInvolved
 
JointsInvolvedCount jointsInvolvedCount
 

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

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

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.

26  :
27  ActionPrimitive (name, 3, type) { }
std::string name
Definition: Action.h:146
ActionPrimitive(std::string name, unsigned int maxStoredActionStates, Type type)
Action::Type type
Definition: Action.h:147
ROSEE::ActionPinchGeneric::ActionPinchGeneric ( std::string  name,
unsigned int  maxStoredActionStates,
ActionPrimitive::Type  type 
)

Definition at line 29 of file ActionPinchGeneric.cpp.

29  :
std::string name
Definition: Action.h:146
ActionPrimitive(std::string name, unsigned int maxStoredActionStates, Type type)
Action::Type type
Definition: Action.h:147
const unsigned int maxStoredActionStates
ROSEE::ActionPinchGeneric::ActionPinchGeneric ( std::string  name,
unsigned int  nFingerInvolved,
unsigned int  maxStoredActionStates,
ActionPrimitive::Type  type 
)

Definition at line 32 of file ActionPinchGeneric.cpp.

33  :
34  ActionPrimitive (name, nFingerInvolved, maxStoredActionStates, type) { }
std::string name
Definition: Action.h:146
ActionPrimitive(std::string name, unsigned int maxStoredActionStates, Type type)
Action::Type type
Definition: Action.h:147
const unsigned int maxStoredActionStates

Member Function Documentation

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.

36  {
37  return fingersInvolved;
38 }
std::set< std::string > fingersInvolved
Definition: Action.h:148

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