Proxy.hpp

Go to the documentation of this file.

#pragma once
#include <Pothos/Config.hpp>
#include <Pothos/Object/Object.hpp>
#include <memory>
#include <string>

namespace Pothos {

class ProxyEnvironment;
class ProxyHandle;

class POTHOS_API Proxy
{
public:

    Proxy(void);

    Proxy(const std::shared_ptr<ProxyHandle> &handle);

    Proxy(ProxyHandle *handle);

    explicit operator bool(void) const;

    std::shared_ptr<ProxyHandle> getHandle(void) const;

    std::shared_ptr<ProxyEnvironment> getEnvironment(void) const;

    template <typename ValueType>
    ValueType convert(void) const;

    template <typename ValueType>
    operator ValueType(void) const;

    template <typename ReturnType, typename... ArgsType>
    ReturnType call(const std::string &name, ArgsType&&... args) const;

    template <typename... ArgsType>
    Proxy call(const std::string &name, ArgsType&&... args) const;

    template <typename... ArgsType>
    POTHOS_DEPRECATED("Replaced by call() overload without return type")
    Proxy callProxy(const std::string &name, ArgsType&&... args) const;

    template <typename... ArgsType>
    POTHOS_DEPRECATED("Replaced by call() overload without return type")
    void callVoid(const std::string &name, ArgsType&&... args) const;

    template <typename ReturnType>
    ReturnType get(const std::string &name) const;

    Proxy get(const std::string &name) const;

    template <typename ValueType>
    void set(const std::string &name, ValueType&& value) const;

    template <typename... ArgsType>
    Proxy operator()(ArgsType&&... args) const;

    int compareTo(const Proxy &other) const;

    size_t hashCode(void) const;

    Object toObject(void) const;

    std::string toString(void) const;

    std::string getClassName(void) const;

    bool operator<(const Proxy &obj) const;

    bool operator>(const Proxy &obj) const;

private:
    std::shared_ptr<ProxyHandle> _handle;
};

POTHOS_API bool operator==(const Proxy &lhs, const Proxy &rhs);

} //namespace Pothos