YARP
Yet Another Robot Platform
yarp::os::Contactables Class Referenceabstract

The yarp::os::Contactables class. More...

#include <yarp/os/Contactables.h>

+ Inheritance diagram for yarp::os::Contactables:

Detailed Description

The yarp::os::Contactables class.

Generic interface for a container of yarp::os::Contactable objects. Implemented by ROS related classes yarp::os::Node and yarp::os::Nodes.

Definition at line 23 of file Contactables.h.

Public Member Functions

virtual ~Contactables ()
 
virtual void add (Contactable &contactable)=0
 add a Contactable to the container. More...
 
virtual void remove (Contactable &contactable)=0
 remove a Contactable from the container. More...
 
virtual Contact query (const std::string &name, const std::string &category="")=0
 query the container to obtain a specified contact. More...
 

Constructor & Destructor Documentation

◆ ~Contactables()

virtual yarp::os::Contactables::~Contactables ( )
inlinevirtual

Definition at line 25 of file Contactables.h.

Member Function Documentation

◆ add()

virtual void yarp::os::Contactables::add ( Contactable contactable)
pure virtual

add a Contactable to the container.

Parameters
contactableto be added

Implemented in yarp::os::Nodes, and yarp::os::Node.

◆ query()

virtual Contact yarp::os::Contactables::query ( const std::string &  name,
const std::string &  category = "" 
)
pure virtual

query the container to obtain a specified contact.

Parameters
namethe name of the Contact
categorythe category of the Contact (tells if the Contact has a nested writer or reader, see NestedContact.category)
Returns
the first matched Contact with the specified name [and category] if found, an empty contact otherwise

Implemented in yarp::os::Nodes, and yarp::os::Node.

◆ remove()

virtual void yarp::os::Contactables::remove ( Contactable contactable)
pure virtual

remove a Contactable from the container.

Parameters
contactableto be removed

Implemented in yarp::os::Nodes, and yarp::os::Node.


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