YARP
Yet Another Robot Platform
Contactables.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2006-2020 Istituto Italiano di Tecnologia (IIT)
3  * All rights reserved.
4  *
5  * This software may be modified and distributed under the terms of the
6  * BSD-3-Clause license. See the accompanying LICENSE file for details.
7  */
8 
9 #ifndef YARP_OS_CONTACTABLES_H
10 #define YARP_OS_CONTACTABLES_H
11 
12 #include <yarp/os/Contactable.h>
13 
14 namespace yarp {
15 namespace os {
16 
23 class YARP_os_API Contactables
24 {
25 public:
26  virtual ~Contactables();
27 
32  virtual void add(Contactable& contactable) = 0;
33 
38  virtual void remove(Contactable& contactable) = 0;
39 
48  virtual Contact query(const std::string& name,
49  const std::string& category = "") = 0;
50 };
51 
52 } // namespace os
53 } // namespace yarp
54 
55 #endif // YARP_OS_CONTACTABLES_H
yarp::os::Contact
Represents how to reach a part of a YARP network.
Definition: Contact.h:39
yarp::os::Contactable
An abstract port.
Definition: Contactable.h:38
yarp::os::Contactables
The yarp::os::Contactables class.
Definition: Contactables.h:24
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: environment.h:18
YARP_os_API
#define YARP_os_API
Definition: api.h:19