ROSEE::ActionPinchLoose Class Reference

The action of pinch with two tips. More...

#include <ActionPinchLoose.h>

Inheritance diagram for ROSEE::ActionPinchLoose:

Collaboration diagram for ROSEE::ActionPinchLoose:

Classes
struct	distComp
	struct to put in order the actionStates set. More...

Public Types
typedef std::map< std::pair< std::string, std::string >, ActionPinchLoose >	Map
typedef std::pair< JointPos, double >	StateWithDistance
	A pair to "link" the JointPos with the optional info 'distance'. More...
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< ActionPrimitive >	Ptr
typedef std::shared_ptr< const ActionPrimitive >	ConstPtr
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< Action >	Ptr
typedef std::shared_ptr< const Action >	ConstPtr

Public Member Functions
	ActionPinchLoose ()
	ActionPinchLoose (unsigned int maxStoredActionStates)
	ActionPinchLoose (std::string tip1, std::string tip2)
	ActionPinchLoose (std::pair< std::string, std::string >, JointPos, double distance)
JointPos	getJointPos () const override
	Get the position related to this action. More...
JointPos	getJointPos (unsigned int index) const
std::vector< ROSEE::JointPos >	getAllJointPos () const override
	Return all the joint position stored. More...
std::vector< ROSEE::ActionPinchLoose::StateWithDistance >	getActionStates () const
	Specific get for this action to return the state with distance info. More...
bool	insertActionState (JointPos, double distance)
	function to insert a single action in the actionStates set of possible action. More...
void	print () const override
	Overridable functions, if we want to make them more action-specific. More...
void	emitYaml (YAML::Emitter &) const override
	Function to fill the argument passed with info about the action. More...
bool	fillFromYaml (YAML::const_iterator yamlIt) override
	function to fill members of the Action with infos taken from yaml files More...
Public Member Functions inherited from 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 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)
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...

Private Attributes
std::set< StateWithDistance, distComp >	actionStates
	For each pair, we want a set of action because we want to store (in general) more possible way to do that action. More...

Additional Inherited Members
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

The action of pinch with two tips.

The two tips must not collide ever (otherwise we have a TightPinch). They only need to move towards each other moving the relative joints. This PinchLoose is created because also if the tips do not collide (i.e. there is not a ActionPinchTight) we can have anyway a pinch at least to take object of a certain minimum size. All the non involved fingers are set in the default state. A pinchLoose is defined by:

• 2 tips ( that are inside fingersInvolved ), so nFingersInvolved == 2 ( members of base class Action )
• JointStates position: where the collision happens (inside actionStates )
• Optional info (inside actionStates ): the minimum distance found between the two tips. The distance is used to order, the actions in the actionStates set (make sense if maxStoredActionStates > 1 ): the less the distance is, the more we say the pinchLoose is good

Definition at line 43 of file ActionPinchLoose.h.

Member Typedef Documentation

typedef std::map< std::pair<std::string, std::string>, ActionPinchLoose > ROSEE::ActionPinchLoose::Map

Definition at line 48 of file ActionPinchLoose.h.

typedef std::pair<JointPos, double> ROSEE::ActionPinchLoose::StateWithDistance

A pair to "link" the JointPos with the optional info 'distance'.

Definition at line 53 of file ActionPinchLoose.h.

Constructor & Destructor Documentation

ROSEE::ActionPinchLoose::ActionPinchLoose

(

)

Definition at line 21 of file ActionPinchLoose.cpp.

                                        : 
    ActionPinchGeneric ("pinchLoose", 2, 3, ActionPrimitive::Type::PinchLoose) { }

ROSEE::ActionPinchLoose::ActionPinchLoose

(

unsigned int

maxStoredActionStates

)

Definition at line 24 of file ActionPinchLoose.cpp.

                                                                           : 
    ActionPinchGeneric ("pinchLoose", 2, maxStoredActionStates, ActionPrimitive::Type::PinchLoose) { }

ROSEE::ActionPinchLoose::ActionPinchLoose	(	std::string	tip1,
		std::string	tip2
	)

Definition at line 27 of file ActionPinchLoose.cpp.

                                                                       : 
    ActionPinchGeneric ("pinchLoose", 2, 3, ActionPrimitive::Type::PinchLoose) {
        fingersInvolved.insert (tip1);
        fingersInvolved.insert (tip2);
}

ROSEE::ActionPinchLoose::ActionPinchLoose	(	std::pair< std::string, std::string >	tipNames,
		JointPos	jp,
		double	distance
	)

Definition at line 33 of file ActionPinchLoose.cpp.

                                  :
    ActionPinchGeneric ("pinchLoose", 2, 3, ActionPrimitive::Type::PinchLoose )  {

    fingersInvolved.insert (tipNames.first);
    fingersInvolved.insert (tipNames.second);
    
    //different from insertState, here we are sure the set is empty (we are in costructor)
    actionStates.insert (std::make_pair (jp, distance) );
}

Member Function Documentation

void ROSEE::ActionPinchLoose::emitYaml ( YAML::Emitter &  out ) const

overridevirtual

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.

Reimplemented from ROSEE::ActionPrimitive.

Definition at line 140 of file ActionPinchLoose.cpp.

                                                              {
    
    out << YAML::Key << YAML::Flow << fingersInvolved;

    unsigned int nCont = 1;
    out << YAML::Value << YAML::BeginMap;
    out << YAML::Key << "PrimitiveType" << YAML::Value << primitiveType;
    out << YAML::Key << "ActionName" << YAML::Value << name;
    out << YAML::Key << "JointsInvolvedCount" << YAML::Value << YAML::BeginMap;
    for (const auto &jointCount : jointsInvolvedCount ) {
        out << YAML::Key << jointCount.first;
        out << YAML::Value << jointCount.second;
    }
    out << YAML::EndMap;
    
    for (const auto & actionState : actionStates) { //.second is the set of ActionState
        
        std::string contSeq = "ActionState_" + std::to_string(nCont);
        out << YAML::Key << contSeq; 
        
        out << YAML::Value << YAML::BeginMap;
            //actionState.first, the jointstates map
            out << YAML::Key << "JointStates" << YAML::Value << YAML::BeginMap;
            for (const auto &joint : actionState.first) {
                out << YAML::Key << joint.first;
                out << YAML::Value << YAML::Flow << joint.second; //vector of double is emitted like Seq
            }
            out << YAML::EndMap;
            
            //actionState.second, the optional
            out << YAML::Key << "Optional" << YAML::Value << YAML::BeginMap;
                out << YAML::Key << "distance" << YAML::Value << actionState.second;
            out << YAML::EndMap;
            
        out << YAML::EndMap;
        nCont++;
    }
    out << YAML::EndMap;

}

bool ROSEE::ActionPinchLoose::fillFromYaml ( YAML::const_iterator  yamlIt )

overridevirtual

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

Implements ROSEE::Action.

Definition at line 182 of file ActionPinchLoose.cpp.

                                                                     {
        
    std::vector <std::string> fingInvolvedVect = yamlIt->first.as <std::vector < std::string >> ();
    for (const auto &it : fingInvolvedVect) {
        fingersInvolved.insert(it);
    }

    for ( YAML::const_iterator keyValue = yamlIt->second.begin(); keyValue != yamlIt->second.end(); ++keyValue) {        
        
        std::string key = keyValue->first.as<std::string>();
        if ( key.compare("JointsInvolvedCount") == 0 ) {
            jointsInvolvedCount = keyValue->second.as < JointsInvolvedCount > ();
            
        } else if (key.compare ("ActionName") == 0 ) {
            name = keyValue->second.as <std::string> ();
        
        } else if (key.compare ("PrimitiveType") == 0) {
            ROSEE::ActionPrimitive::Type parsedType = static_cast<ROSEE::ActionPrimitive::Type> ( 
                keyValue->second.as <unsigned int>() );
            if (parsedType != primitiveType ) {
                std::cerr << "[ERROR ActionPinchLoose::" << __func__ << " parsed a type " << parsedType << 
                    " but this object has primitive type " << primitiveType << std::endl; 
                return false;
            }
            
        } else if (key.compare(0, 12, "ActionState_") == 0) { //compare 12 caracters from index 0 of key

            JointPos jointPos;
            double distance;
            for(YAML::const_iterator asEl = keyValue->second.begin(); asEl != keyValue->second.end(); ++asEl) {

                //asEl can be the map JointStates or the map Optional
                if (asEl->first.as<std::string>().compare ("JointStates") == 0 ) {
                    jointPos = asEl->second.as < JointPos >(); 
                    
                } else if (asEl->first.as<std::string>().compare ("Optional") == 0 ) {
                    distance = asEl->second["distance"].as < double >();
                    
                } else {
                    //ERRROr, only joinstates and optional at this level
                    std::cerr << "[ERROR ActionPinchLoose::" << __func__ << "not know key " 
                        << asEl->first.as<std::string>() << 
                        " found in the yaml file at this level" << std::endl; 
                    return false;
                }
            }  
            actionStates.insert ( std::make_pair (jointPos, distance));
            
        } else {
            std::cerr << "[ERROR ActionPinchLoose::" << __func__ << "not know key " << key << 
                " found in the yaml file" << std::endl; 
            return false;
        }
    }
    
    return true;
}

std::vector< ROSEE::ActionPinchLoose::StateWithDistance > ROSEE::ActionPinchLoose::getActionStates

(

)

const

Specific get for this action to return the state with distance info.

Returns

The vector (of size maxStoredActionStates) containing all the StateWithDistance objects

Definition at line 44 of file ActionPinchLoose.cpp.

                                                                                                  {
    
    std::vector < ROSEE::ActionPinchLoose::StateWithDistance > retVect;
    retVect.reserve ( actionStates.size() );
    
    for (auto it : actionStates ) {
        retVect.push_back(it);
    }
    
    return retVect;
}

std::vector< ROSEE::JointPos > ROSEE::ActionPinchLoose::getAllJointPos ( ) const

overridevirtual

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

Implements ROSEE::Action.

Definition at line 70 of file ActionPinchLoose.cpp.

                                                                        {
    
    std::vector < JointPos > retVect;
    retVect.reserve(actionStates.size());
    
    for (auto it : actionStates ) {
        retVect.push_back(it.first);
    }
    
    return retVect;
}

ROSEE::JointPos ROSEE::ActionPinchLoose::getJointPos ( ) const

overridevirtual

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

Implements ROSEE::Action.

Definition at line 56 of file ActionPinchLoose.cpp.

                                                       {
    return (actionStates.begin()->first);
}

ROSEE::JointPos ROSEE::ActionPinchLoose::getJointPos

(

unsigned int

index

)

const

Definition at line 60 of file ActionPinchLoose.cpp.

                                                                         {
    auto it = actionStates.begin();
    unsigned int i = 1;
    while (i < index ) {
        ++ it;
        ++ i;
    }
    return (it->first);
}

bool ROSEE::ActionPinchLoose::insertActionState	(	ROSEE::JointPos	jp,
		double	distance
	)

function to insert a single action in the actionStates set of possible action.

If the action is not so good (based on distance) the action is not inserted and the function return false

Parameters

JointPos	The joints position
distance	the distance from the two tips.

Returns

TRUE if the action is good and is inserted in the setActionStates FALSE if the action given as param was not good as the others in the actionStates and the set was already full (maxStoredActionStates )

Definition at line 82 of file ActionPinchLoose.cpp.

                                                                            {

    auto pairRet = actionStates.insert ( std::make_pair (jp, dist) ) ;
    
    if (actionStates.size() > maxStoredActionStates) { 
        //max capacity reached, we have to delete the last one
        auto it = pairRet.first;        
        
        if (++(it) == actionStates.end() ){
           // the new inserted is the last one and has to be erased
            actionStates.erase(pairRet.first);
            return false;
        }
        
        // the new inserted is not the last one that has to be erased
        auto lastElem = actionStates.end();
        --lastElem;
        actionStates.erase(lastElem);
    }
    
    return true;
}

void ROSEE::ActionPinchLoose::print ( ) const

overridevirtual

Overridable functions, if we want to make them more action-specific.

Reimplemented from ROSEE::Action.

Definition at line 106 of file ActionPinchLoose.cpp.

                                         {
    
    std::stringstream output;
    
    output << "ActionName: " << name << std::endl;
    
    output << "FingersInvolved: [";
    for (auto fingName : fingersInvolved){
        output << fingName << ", " ;
    }
    output.seekp (-2, output.cur); //to remove the last comma (and space)
    output << "]" << std::endl;
    
    output << "JointsInvolvedCount: " << std::endl;;
    output << jointsInvolvedCount << std::endl;

    unsigned int nActState = 1;
    for (auto itemSet : actionStates) {  //the element in the set
        output << "Action_State_" << nActState << " :" << std::endl;

        output << "\t" << "JointStates:" << std::endl;
        output << itemSet.first;
        output << "\t" << "Distance:" << std::endl;
        output << "\t\tdistance " << itemSet.second << std::endl;
            
        nActState++;
    }
    output << std::endl;
    
    std::cout << output.str();

}

Member Data Documentation

std::set< StateWithDistance, distComp > ROSEE::ActionPinchLoose::actionStates

private

For each pair, we want a set of action because we want to store (in general) more possible way to do that action.

The PinchLoose among two tips can theoretically be done in infinite ways, we store the best ways found (ordering them by the distance between fingertips)

Definition at line 105 of file ActionPinchLoose.h.

---

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

• /home/travis/build/ADVRHumanoids/ROSEndEffector/include/end_effector/GraspingActions/ActionPinchLoose.h
• /home/travis/build/ADVRHumanoids/ROSEndEffector/src/GraspingActions/ActionPinchLoose.cpp