YARP
Yet Another Robot Platform
Contactables.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
3  * SPDX-License-Identifier: BSD-3-Clause
4  */
5 
6 #ifndef YARP_OS_CONTACTABLES_H
7 #define YARP_OS_CONTACTABLES_H
8 
9 #include <yarp/os/Contactable.h>
10 
11 namespace yarp {
12 namespace os {
13 
20 class YARP_os_API Contactables
21 {
22 public:
23  virtual ~Contactables();
24 
29  virtual void add(Contactable& contactable) = 0;
30 
35  virtual void remove(Contactable& contactable) = 0;
36 
45  virtual Contact query(const std::string& name,
46  const std::string& category = "") = 0;
47 };
48 
49 } // namespace os
50 } // namespace yarp
51 
52 #endif // YARP_OS_CONTACTABLES_H
yarp::os::Contact
Represents how to reach a part of a YARP network.
Definition: Contact.h:36
yarp::os::Contactable
An abstract port.
Definition: Contactable.h:35
yarp::os::Contactables
The yarp::os::Contactables class.
Definition: Contactables.h:21
yarp::os::Contactables::add
virtual void add(Contactable &contactable)=0
add a Contactable to the container.
yarp::os::Contactables::remove
virtual void remove(Contactable &contactable)=0
remove a Contactable from the container.
yarp::os::Contactables::query
virtual Contact query(const std::string &name, const std::string &category="")=0
query the container to obtain a specified contact.
yarp
The main, catch-all namespace for YARP.
Definition: dirs.h:16
YARP_os_API
#define YARP_os_API
Definition: api.h:18