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

This interface allows users to retrieve a list which contains the names and the types of the currently running devices. More...

#include <yarp/dev/IRobotDescription.h>

+ Inheritance diagram for yarp::dev::IRobotDescription:

Public Member Functions

virtual ~IRobotDescription ()
 Destructor.
 
virtual bool getAllDevices (std::vector< DeviceDescription > &dev_list)=0
 Ask the complete list of all yarp device drivers registered by a robot description server.
 
virtual bool getAllDevicesByType (const std::string &type, std::vector< DeviceDescription > &dev_list)=0
 Ask a list of all registered yarp device drivers whose type corresponds to the given param.
 
virtual bool registerDevice (const DeviceDescription &dev)=0
 Register a new running yarp device into a robot description server.
 
virtual bool unregisterDevice (const std::string &device_name)=0
 Unregister a running yarp device from a robot description server.
 

Detailed Description

This interface allows users to retrieve a list which contains the names and the types of the currently running devices.

This list is stored in a RobotDescriptionsServer class. The user can access to the data opening a RobotDescriptionsClient in its own module.

Definition at line 32 of file IRobotDescription.h.

Constructor & Destructor Documentation

◆ ~IRobotDescription()

yarp::dev::IRobotDescription::~IRobotDescription ( )
virtualdefault

Destructor.

Member Function Documentation

◆ getAllDevices()

virtual bool yarp::dev::IRobotDescription::getAllDevices ( std::vector< DeviceDescription > &  dev_list)
pure virtual

Ask the complete list of all yarp device drivers registered by a robot description server.

Implemented in RobotDescriptionClient.

◆ getAllDevicesByType()

virtual bool yarp::dev::IRobotDescription::getAllDevicesByType ( const std::string &  type,
std::vector< DeviceDescription > &  dev_list 
)
pure virtual

Ask a list of all registered yarp device drivers whose type corresponds to the given param.

Implemented in RobotDescriptionClient.

◆ registerDevice()

virtual bool yarp::dev::IRobotDescription::registerDevice ( const DeviceDescription dev)
pure virtual

Register a new running yarp device into a robot description server.

Implemented in RobotDescriptionClient.

◆ unregisterDevice()

virtual bool yarp::dev::IRobotDescription::unregisterDevice ( const std::string &  device_name)
pure virtual

Unregister a running yarp device from a robot description server.

Implemented in RobotDescriptionClient.


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