Nodes.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_OS_NODES_H
#define YARP_OS_NODES_H
 
#include <yarp/os/Contactables.h>
 
// forward declarations:
namespace yarp::os {
class Node;
} // namespace yarp::os
 
namespace yarp::os {
 
class YARP_os_API Nodes : public yarp::os::Contactables
{
public:
    Nodes();
    virtual ~Nodes();
 
    void add(Contactable& contactable) override;
 
    void remove(Contactable& contactable) override;
 
    virtual Contact query(const std::string& name,
                          const std::string& category = "") override;
 
    virtual void update(Contactable& contactable);
 
    Contact getParent(const std::string& name);
 
    Contact getURI(const std::string& name);
 
    void prepare(const std::string& name);
 
    void interrupt();
 
    bool enable(bool flag);
 
    void clear();
 
    void setActiveName(const std::string& name);
 
    void addExternalNode(const std::string& name, Node& node);
 
    void removeExternalNode(const std::string& name);
 
    std::string getActiveName();
 
    bool requireActiveName();
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
    class Private;
    Private* mPriv;
#endif // DOXYGEN_SHOULD_SKIP_THIS
};
 
} // namespace yarp::os
 
 
#endif // YARP_OS_NODES_H