IIntrospectableView.h

Go to the documentation of this file.

#ifndef ZSERIO_I_INTROSPECTABLE_VIEW_INC
#define ZSERIO_I_INTROSPECTABLE_VIEW_INC
 
#include <memory>
#include <string_view>
 
#include "zserio/BitSize.h"
#include "zserio/IIntrospectableData.h"
#include "zserio/View.h"
 
namespace zserio
{
 
template <typename ALLOC = std::allocator<uint8_t>>
class IBasicIntrospectableView : public IIntrospectableData<IBasicIntrospectableView<ALLOC>, ALLOC>
{
public:
    using ConstPtr = typename IIntrospectableData<IBasicIntrospectableView<ALLOC>, ALLOC>::ConstPtr;
 
    ~IBasicIntrospectableView() override = default;
 
    virtual ConstPtr getParameter(std::string_view name) const = 0;
 
    virtual ConstPtr callFunction(std::string_view name) const = 0;
 
    virtual BasicBitBuffer<ALLOC> serialize(const ALLOC& allocator) const = 0;
    virtual BasicBitBuffer<ALLOC> serialize() const = 0;
};
 
template <typename ALLOC = std::allocator<uint8_t>>
using IBasicIntrospectableViewConstPtr = typename IBasicIntrospectableView<ALLOC>::ConstPtr;
 
using IIntrospectableView = IBasicIntrospectableView<>;
using IIntrospectableViewConstPtr = IBasicIntrospectableViewConstPtr<>;
namespace detail
{
 
template <typename T, typename ALLOC>
struct Introspectable;
 
} // namespace detail
 
template <typename T, typename ALLOC = typename T::allocator_type>
IBasicIntrospectableViewConstPtr<ALLOC> introspectable(const View<T>& view, const ALLOC& allocator = ALLOC())
{
    return detail::Introspectable<T, ALLOC>::create(view, allocator);
}
 
template <typename T, typename ALLOC = std::allocator<uint8_t>,
        std::enable_if_t<std::is_enum_v<T> || is_bitmask_v<T>, int> = 0>
IBasicIntrospectableViewConstPtr<ALLOC> introspectable(T value, const ALLOC& allocator = ALLOC())
{
    return detail::Introspectable<T, ALLOC>::create(value, allocator);
}
} // namespace zserio
 
#endif // ZSERIO_I_INTROSPECTABLE_VIEW_INC