YARP
Yet Another Robot Platform
Nodes.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_NODES_H
7#define YARP_OS_NODES_H
8
10
11// forward declarations:
12namespace yarp::os {
13class Node;
14} // namespace yarp::os
15
16namespace yarp::os {
17
29{
30public:
31 Nodes();
32 virtual ~Nodes();
33
41 void add(Contactable& contactable) override;
42
47 void remove(Contactable& contactable) override;
48
55 virtual Contact query(const std::string& name,
56 const std::string& category = "") override;
57
62 virtual void update(Contactable& contactable);
63
70 Contact getParent(const std::string& name);
71
78 Contact getURI(const std::string& name);
79
86 void prepare(const std::string& name);
87
91 void interrupt();
92
99 bool enable(bool flag);
100
104 void clear();
105
110 void setActiveName(const std::string& name);
111
118 void addExternalNode(const std::string& name, Node& node);
119
124 void removeExternalNode(const std::string& name);
125
130 std::string getActiveName();
131
136 bool requireActiveName();
137
138#ifndef DOXYGEN_SHOULD_SKIP_THIS
139private:
140 class Private;
141 Private* mPriv;
142#endif // DOXYGEN_SHOULD_SKIP_THIS
143};
144
145} // namespace yarp::os
146
147
148#endif // YARP_OS_NODES_H
Represents how to reach a part of a YARP network.
Definition: Contact.h:33
An abstract port.
Definition: Contactable.h:28
The yarp::os::Contactables class.
Definition: Contactables.h:20
The Node class.
Definition: Node.h:23
The Nodes class.
Definition: Nodes.h:29
An interface to the operating system, including Port based communication.
#define YARP_os_API
Definition: api.h:18