Property.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-FileCopyrightText: 2006-2010 RobotCub Consortium
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_OS_PROPERTY_H
#define YARP_OS_PROPERTY_H
 
#include <yarp/os/Bottle.h>
#include <yarp/os/Portable.h>
#include <yarp/os/Searchable.h>
 
#include <string>
 
namespace yarp {
namespace os {
 
class YARP_os_API Property :
        public Searchable,
        public Portable
{
public:
    using Searchable::check;
    using Searchable::findGroup;
 
    Property();
 
#ifndef YARP_NO_DEPRECATED // Since YARP 3.3
    YARP_DEPRECATED_MSG("Use default constructor instead")
    Property(int hash_size);
#endif
 
    Property(const char* str);
 
 
    Property(const Property& rhs);
 
    Property(Property&& rhs) noexcept;
 
    Property(std::initializer_list<std::pair<std::string, yarp::os::Value>> values);
    ~Property() override;
 
    Property& operator=(const Property& prop);
 
    Property& operator=(Property&& prop) noexcept;
 
    // documented in Searchable
    bool check(const std::string& key) const override;
 
    void put(const std::string& key, const std::string& value);
 
    void put(const std::string& key, const Value& value);
 
    void put(const std::string& key, Value* value);
 
    void put(const std::string& key, int value);
 
    void put(const std::string& key, double value);
 
    Property& addGroup(const std::string& key);
 
    void unput(const std::string& key);
 
    // documented in Searchable
    Value& find(const std::string& key) const override;
 
    // documented in Searchable
    Bottle& findGroup(const std::string& key) const override;
 
    void clear();
 
    void fromString(const std::string& txt, bool wipe = true);
 
    void fromCommand(int argc, char* argv[], bool skipFirst = true, bool wipe = true);
 
    void fromCommand(int argc, const char* argv[], bool skipFirst = true, bool wipe = true);
 
    void fromArguments(const char* arguments, bool wipe = true);
 
    bool fromConfigFile(const std::string& fname, bool wipe = true);
 
    bool fromConfigFile(const std::string& fname,
                        Searchable& env,
                        bool wipe = true);
 
    bool fromConfigDir(const std::string& dirname,
                       const std::string& section = std::string(),
                       bool wipe = true);
 
    void fromConfig(const char* txt, bool wipe = true);
 
    void fromConfig(const char* txt,
                    Searchable& env,
                    bool wipe = true);
 
    void fromQuery(const char* url,
                   bool wipe = true);
 
 
    // documented in Searchable
    std::string toString() const override;
 
    // documented in Portable
    bool read(ConnectionReader& reader) override;
 
    // documented in Portable
    bool write(ConnectionWriter& writer) const override;
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
    class Private;
    Private* mPriv;
#endif // DOXYGEN_SHOULD_SKIP_THIS
};
 
} // namespace os
} // namespace yarp
 
#endif // YARP_OS_PROPERTY_H