YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::dev::StubImplInteractionModeRaw Class Reference

Stub implementation of IInteractionMode interface. More...

#include <yarp/dev/ImplementInteractionMode.h>

+ Inheritance diagram for yarp::dev::StubImplInteractionModeRaw:

Public Member Functions

virtual ~StubImplInteractionModeRaw ()
 Destructor.
 
yarp::dev::ReturnValue getInteractionModeRaw (int axis, yarp::dev::InteractionModeEnum &mode) override
 Get the current interaction mode of the robot, values can be stiff or compliant.
 
yarp::dev::ReturnValue getInteractionModesRaw (const std::vector< int > &joints, std::vector< yarp::dev::InteractionModeEnum > &modes) override
 Get the current interaction mode of the robot for a set of joints, values can be stiff or compliant.
 
yarp::dev::ReturnValue getInteractionModesRaw (std::vector< yarp::dev::InteractionModeEnum > &modes) override
 Get the current interaction mode of the robot for a all the joints, values can be stiff or compliant.
 
yarp::dev::ReturnValue setInteractionModeRaw (int axis, yarp::dev::InteractionModeEnum mode) override
 Set the interaction mode of the robot, values can be stiff or compliant.
 
yarp::dev::ReturnValue setInteractionModesRaw (const std::vector< int > &joints, const std::vector< yarp::dev::InteractionModeEnum > &modes) override
 Set the interaction mode of the robot for a set of joints, values can be stiff or compliant.
 
yarp::dev::ReturnValue setInteractionModesRaw (const std::vector< yarp::dev::InteractionModeEnum > &modes) override
 Set the interaction mode of the robot for a all the joints, values can be stiff or compliant.
 
- Public Member Functions inherited from yarp::dev::IInteractionModeRaw
virtual ~IInteractionModeRaw ()
 Destructor.
 

Detailed Description

Stub implementation of IInteractionMode interface.

Inherit from this class if you want a stub implementation of methods in IInteractionModeRaw. This class allows to gradually implement an interface; you just have to implement functions that are useful for the underlying device. Another way to see this class is as a means to convert compile time errors in runtime errors.

If you use this class please be aware that the device you are wrapping might not function properly because you missed to implement useful functionalities.

Definition at line 107 of file ImplementInteractionMode.h.

Constructor & Destructor Documentation

◆ ~StubImplInteractionModeRaw()

virtual yarp::dev::StubImplInteractionModeRaw::~StubImplInteractionModeRaw ( )
inlinevirtual

Destructor.

Definition at line 113 of file ImplementInteractionMode.h.

Member Function Documentation

◆ getInteractionModeRaw()

yarp::dev::ReturnValue yarp::dev::StubImplInteractionModeRaw::getInteractionModeRaw ( int  axis,
yarp::dev::InteractionModeEnum &  mode 
)
inlineoverridevirtual

Get the current interaction mode of the robot, values can be stiff or compliant.

Parameters
axisjoint number
modecontains the requested information about interaction mode of the joint
Returns
true or false on success or failure.

Implements yarp::dev::IInteractionModeRaw.

Definition at line 115 of file ImplementInteractionMode.h.

◆ getInteractionModesRaw() [1/2]

yarp::dev::ReturnValue yarp::dev::StubImplInteractionModeRaw::getInteractionModesRaw ( const std::vector< int > &  joints,
std::vector< yarp::dev::InteractionModeEnum > &  modes 
)
inlineoverridevirtual

Get the current interaction mode of the robot for a set of joints, values can be stiff or compliant.

Parameters
n_jointshow many joints this command is referring to
jointslist of joints controlled. The size of this array is n_joints
modesarray containing the requested information about interaction mode, one value for each joint, the size is n_joints. for example: n_joint 3 joints 0 2 4 refs VOCAB_IM_STIFF VOCAB_IM_STIFF VOCAB_IM_COMPLIANT
Returns
true or false on success or failure.

Implements yarp::dev::IInteractionModeRaw.

Definition at line 120 of file ImplementInteractionMode.h.

◆ getInteractionModesRaw() [2/2]

yarp::dev::ReturnValue yarp::dev::StubImplInteractionModeRaw::getInteractionModesRaw ( std::vector< yarp::dev::InteractionModeEnum > &  modes)
inlineoverridevirtual

Get the current interaction mode of the robot for a all the joints, values can be stiff or compliant.

Parameters
modearray containing the requested information about interaction mode, one value for each joint.
Returns
true or false on success or failure.

Implements yarp::dev::IInteractionModeRaw.

Definition at line 125 of file ImplementInteractionMode.h.

◆ setInteractionModeRaw()

yarp::dev::ReturnValue yarp::dev::StubImplInteractionModeRaw::setInteractionModeRaw ( int  axis,
yarp::dev::InteractionModeEnum  mode 
)
inlineoverridevirtual

Set the interaction mode of the robot, values can be stiff or compliant.

Please note that some robot may not implement certain types of interaction, so always check the return value.

Parameters
axisjoint number
modethe desired interaction mode
Returns
true or false on success or failure.

Implements yarp::dev::IInteractionModeRaw.

Definition at line 130 of file ImplementInteractionMode.h.

◆ setInteractionModesRaw() [1/2]

yarp::dev::ReturnValue yarp::dev::StubImplInteractionModeRaw::setInteractionModesRaw ( const std::vector< int > &  joints,
const std::vector< yarp::dev::InteractionModeEnum > &  modes 
)
inlineoverridevirtual

Set the interaction mode of the robot for a set of joints, values can be stiff or compliant.

Please note that some robot may not implement certain types of interaction, so always check the return value.

Parameters
n_jointshow many joints this command is referring to
jointslist of joints controlled. The size of this array is n_joints
modesarray containing the desired interaction mode, one value for each joint, the size is n_joints. for example: n_joint 3 joints 0 2 4 refs VOCAB_IM_STIFF VOCAB_IM_STIFF VOCAB_IM_COMPLIANT
Returns
true or false on success or failure. If one or more joint fails, the return value will be false.

Implements yarp::dev::IInteractionModeRaw.

Definition at line 135 of file ImplementInteractionMode.h.

◆ setInteractionModesRaw() [2/2]

yarp::dev::ReturnValue yarp::dev::StubImplInteractionModeRaw::setInteractionModesRaw ( const std::vector< yarp::dev::InteractionModeEnum > &  modes)
inlineoverridevirtual

Set the interaction mode of the robot for a all the joints, values can be stiff or compliant.

Some robot may not implement some types of interaction, so always check the return value

Parameters
modearray with the desired interaction mode for all joints, length is the total number of joints for the part
Returns
true or false on success or failure. If one or more joint fails, the return value will be false.

Implements yarp::dev::IInteractionModeRaw.

Definition at line 140 of file ImplementInteractionMode.h.


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