YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarp::dev::IAxisInfo Class Referenceabstract

Interface for getting information about specific axes, if available. More...

#include <yarp/dev/IAxisInfo.h>

+ Inheritance diagram for yarp::dev::IAxisInfo:

Public Member Functions

virtual ~IAxisInfo ()
 Destructor.
 
virtual yarp::dev::ReturnValue getAxes (size_t &ax)=0
 Get the number of controlled axes.
 
virtual yarp::dev::ReturnValue getAxisName (int axis, std::string &name)=0
 
virtual yarp::dev::ReturnValue getJointType (int axis, yarp::dev::JointTypeEnum &type)
 

Detailed Description

Interface for getting information about specific axes, if available.

Definition at line 36 of file IAxisInfo.h.

Constructor & Destructor Documentation

◆ ~IAxisInfo()

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

Destructor.

Definition at line 42 of file IAxisInfo.h.

Member Function Documentation

◆ getAxes()

virtual yarp::dev::ReturnValue yarp::dev::IAxisInfo::getAxes ( size_t &  ax)
pure virtual

Get the number of controlled axes.

This command asks the number of controlled axes for the current physical interface.

Parameters
axstorage to return param
Returns
true/false.

Implemented in ControlBoardCouplingHandler, ControlBoardRemappingEngine, FakeLaserWithMotor, FakeMotionControl, FakeMotionControlMicro, ControlBoard_nwc_yarp, and yarp::dev::ImplementAxisInfo.

◆ getAxisName()

virtual yarp::dev::ReturnValue yarp::dev::IAxisInfo::getAxisName ( int  axis,
std::string &  name 
)
pure virtual

◆ getJointType()

virtual yarp::dev::ReturnValue yarp::dev::IAxisInfo::getJointType ( int  axis,
yarp::dev::JointTypeEnum &  type 
)
inlinevirtual

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