IIntrospectableData.h

Go to the documentation of this file.

#ifndef ZSERIO_I_INTROSPECTABLE_DATA_INC
#define ZSERIO_I_INTROSPECTABLE_DATA_INC
 
#include <memory>
#include <string_view>
 
#include "zserio/Any.h"
#include "zserio/BitBuffer.h"
#include "zserio/BitStreamWriter.h"
#include "zserio/Bytes.h"
#include "zserio/RebindAlloc.h"
 
namespace zserio
{
 
// Necessary to break cyclic dependency, ITypeInfo header must include IReflectableData header as well!
template <typename ALLOC>
class IBasicTypeInfo;
 
template <typename I, typename ALLOC = std::allocator<uint8_t>>
class IIntrospectableData
{
public:
    using ConstPtr = std::shared_ptr<const I>;
 
    virtual ~IIntrospectableData() = default;
 
    virtual const IBasicTypeInfo<ALLOC>& getTypeInfo() const = 0;
 
    virtual bool isArray() const = 0;
 
    virtual ConstPtr getField(std::string_view name) const = 0;
 
    virtual std::string_view getChoice() const = 0;
 
    virtual size_t size() const = 0;
 
    virtual ConstPtr at(size_t index) const = 0;
 
    virtual ConstPtr operator[](size_t index) const = 0;
 
    virtual BasicAny<ALLOC> getAnyValue(const ALLOC& allocator) const = 0;
    virtual BasicAny<ALLOC> getAnyValue() const = 0;
    virtual bool getBool() const = 0;
 
    virtual int8_t getInt8() const = 0;
 
    virtual int16_t getInt16() const = 0;
 
    virtual int32_t getInt32() const = 0;
 
    virtual int64_t getInt64() const = 0;
 
    virtual uint8_t getUInt8() const = 0;
 
    virtual uint16_t getUInt16() const = 0;
 
    virtual uint32_t getUInt32() const = 0;
 
    virtual uint64_t getUInt64() const = 0;
 
    virtual float getFloat() const = 0;
 
    virtual double getDouble() const = 0;
 
    virtual BytesView getBytes() const = 0;
 
    virtual std::string_view getStringView() const = 0;
 
    virtual const BasicBitBuffer<ALLOC>& getBitBuffer() const = 0; // TODO[Mi-L@]: return BitBufferView?
 
    virtual int64_t toInt() const = 0;
 
    virtual uint64_t toUInt() const = 0;
 
    virtual double toDouble() const = 0;
 
    virtual BasicString<RebindAlloc<ALLOC, char>> toString(const ALLOC& allocator) const = 0;
    virtual BasicString<RebindAlloc<ALLOC, char>> toString() const = 0;
    virtual ConstPtr find(std::string_view path) const = 0;
 
    virtual ConstPtr operator[](std::string_view path) const = 0;
};
 
} // namespace zserio
 
#endif // ZSERIO_I_INTROSPECTABLE_DATA_INC