Zserio C++ runtime library  1.0.2
Built for Zserio 2.14.1
zserio::ReflectableConstAllocatorHolderBase< ALLOC > Class Template Reference

#include <Reflectable.h>

Inheritance diagram for zserio::ReflectableConstAllocatorHolderBase< ALLOC >:
Collaboration diagram for zserio::ReflectableConstAllocatorHolderBase< ALLOC >:

Public Member Functions

void initializeChildren () override
 
void initialize (const vector< AnyHolder< ALLOC >, ALLOC > &typeArguments) override
 
size_t initializeOffsets (size_t bitPosition) override
 
IBasicReflectablePtr< ALLOC > getField (StringView name) override
 
void setField (StringView name, const AnyHolder< ALLOC > &value) override
 
IBasicReflectablePtr< ALLOC > getParameter (StringView name) override
 
IBasicReflectablePtr< ALLOC > callFunction (StringView name) override
 
AnyHolder< ALLOC > getAnyValue (const ALLOC &allocator) override
 
- Public Member Functions inherited from zserio::ReflectableAllocatorHolderBase< ALLOC >
 ReflectableAllocatorHolderBase (const IBasicTypeInfo< ALLOC > &typeInfo, const ALLOC &allocator)
 
- Public Member Functions inherited from zserio::ReflectableBase< ALLOC >
 ReflectableBase (const IBasicTypeInfo< ALLOC > &typeInfo)
 
 ~ReflectableBase () override=0
 
const IBasicTypeInfo< ALLOC > & getTypeInfo () const override
 
bool isArray () const override
 
size_t initializeOffsets () override
 
size_t bitSizeOf (size_t bitPosition) const override
 
size_t bitSizeOf () const override
 
void write (BitStreamWriter &writer) const override
 
IBasicReflectableConstPtr< ALLOC > getField (StringView name) const override
 
IBasicReflectablePtr< ALLOC > createField (StringView name) override
 
IBasicReflectableConstPtr< ALLOC > getParameter (StringView name) const override
 
IBasicReflectableConstPtr< ALLOC > callFunction (StringView name) const override
 
StringView getChoice () const override
 
IBasicReflectableConstPtr< ALLOC > find (StringView path) const override
 
IBasicReflectablePtr< ALLOC > find (StringView path) override
 
IBasicReflectableConstPtr< ALLOC > operator[] (StringView path) const override
 
IBasicReflectablePtr< ALLOC > operator[] (StringView path) override
 
size_t size () const override
 
void resize (size_t size) override
 
IBasicReflectableConstPtr< ALLOC > at (size_t index) const override
 
IBasicReflectablePtr< ALLOC > at (size_t index) override
 
IBasicReflectableConstPtr< ALLOC > operator[] (size_t index) const override
 
IBasicReflectablePtr< ALLOC > operator[] (size_t index) override
 
void setAt (const AnyHolder< ALLOC > &value, size_t index) override
 
void append (const AnyHolder< ALLOC > &value) override
 
AnyHolder< ALLOC > getAnyValue (const ALLOC &allocator) const override
 
AnyHolder< ALLOC > getAnyValue () const override
 
AnyHolder< ALLOC > getAnyValue () override
 
bool getBool () const override
 
int8_t getInt8 () const override
 
int16_t getInt16 () const override
 
int32_t getInt32 () const override
 
int64_t getInt64 () const override
 
uint8_t getUInt8 () const override
 
uint16_t getUInt16 () const override
 
uint32_t getUInt32 () const override
 
uint64_t getUInt64 () const override
 
float getFloat () const override
 
double getDouble () const override
 
Span< const uint8_t > getBytes () const override
 
StringView getStringView () const override
 
const BasicBitBuffer< ALLOC > & getBitBuffer () const override
 
int64_t toInt () const override
 
uint64_t toUInt () const override
 
double toDouble () const override
 
string< ALLOC > toString (const ALLOC &allocator) const override
 
string< ALLOC > toString () const override
 
 ReflectableBase (const ReflectableBase &)=delete
 
ReflectableBaseoperator= (const ReflectableBase &)=delete
 
 ReflectableBase (const ReflectableBase &&)=delete
 
ReflectableBaseoperator= (const ReflectableBase &&)=delete
 
- Public Member Functions inherited from zserio::IBasicReflectable< ALLOC >
virtual ~IBasicReflectable ()=default
 
- Public Member Functions inherited from zserio::AllocatorHolder< ALLOC >
 AllocatorHolder ()
 
 AllocatorHolder (const allocator_type &allocator)
 
 AllocatorHolder (allocator_type &&allocator)
 
allocator_type get_allocator () const
 
 ~AllocatorHolder ()=default
 
 AllocatorHolder (const AllocatorHolder &other)=default
 
AllocatorHolderoperator= (const AllocatorHolder &other)=default
 
 AllocatorHolder (AllocatorHolder &&other)=default
 
AllocatorHolderoperator= (AllocatorHolder &&other)=default
 

Additional Inherited Members

- Public Types inherited from zserio::IBasicReflectable< ALLOC >
using Ptr = std::shared_ptr< IBasicReflectable >
 
using ConstPtr = std::shared_ptr< const IBasicReflectable >
 
- Public Types inherited from zserio::AllocatorHolder< ALLOC >
using allocator_type = ALLOC
 
- Protected Member Functions inherited from zserio::AllocatorHolder< ALLOC >
void set_allocator (const allocator_type &allocator)
 
void set_allocator (allocator_type &&allocator)
 
allocator_typeget_allocator_ref ()
 
const allocator_typeget_allocator_ref () const
 

Detailed Description

template<typename ALLOC>
class zserio::ReflectableConstAllocatorHolderBase< ALLOC >

Base class for constant reflectable which needs to hold an allocator.

Overrides non constant methods and throws exception with info about constness.

Definition at line 2038 of file Reflectable.h.

Member Function Documentation

◆ callFunction()

template<typename ALLOC >
IBasicReflectablePtr< ALLOC > zserio::ReflectableConstAllocatorHolderBase< ALLOC >::callFunction ( StringView  name)
overridevirtual

Calls function with the given name on the reflected zserio object and gets reflectable view to its result.

Note
Can be called only when the reflected object is a zserio compound type.
Parameters
nameFunction schema name.
Returns
Reflectable view to the value returns from the called function.
Exceptions
CppRuntimeExceptionWhen the reflected object is not a compound type or when the function with the given name doesn't exist or the the function call itself throws.

Reimplemented from zserio::ReflectableBase< ALLOC >.

Definition at line 4408 of file Reflectable.h.

◆ getAnyValue()

template<typename ALLOC >
AnyHolder< ALLOC > zserio::ReflectableConstAllocatorHolderBase< ALLOC >::getAnyValue ( const ALLOC &  allocator)
overridevirtual

Gets any value within the reflected object.

For builtin types, enums and bitmasks the value is "returned by value" - i.e. it's copied into the any holder, but note that for bytes the any holder contains Span, for string the any holder contains an appropriate StringView and for compounds, bit buffers and arrays the value is "returned by reference" - i.e. the any holder contains std::reference_wrapper<T> with the reference to the compound type or the raw array type.

Note
For bit buffers only const reference is available.
Overloads without parameter use default constructed allocator.
Parameters
allocatorAllocator to use for the value allocation.
Returns
Any value.

Reimplemented from zserio::ReflectableBase< ALLOC >.

Definition at line 4414 of file Reflectable.h.

◆ getField()

template<typename ALLOC >
IBasicReflectablePtr< ALLOC > zserio::ReflectableConstAllocatorHolderBase< ALLOC >::getField ( StringView  name)
overridevirtual

Gets reflectable view to the field (i.e. member) with the given schema name.

Note
Can be called only when the reflected object is a zserio compound type.
Parameters
nameField schema name.
Returns
Reflectable view to the requested field.
Exceptions
CppRuntimeExceptionWhen the reflected object is not a compound type or when the field with the given name doesn't exist or when the field getter itself throws.

Reimplemented from zserio::ReflectableBase< ALLOC >.

Definition at line 4390 of file Reflectable.h.

◆ getParameter()

template<typename ALLOC >
IBasicReflectablePtr< ALLOC > zserio::ReflectableConstAllocatorHolderBase< ALLOC >::getParameter ( StringView  name)
overridevirtual

Gets reflectable view to the parameter (i.e. member) with the given schema name.

Note
Can be called only when the reflected object is a zserio compound type.
Parameters
nameParameter schema name.
Returns
Reflectable view to the requested parameter.
Exceptions
CppRuntimeExceptionWhen the reflected object is not a compound type or when the parameter with the given name doesn't exist or when the parameter getter itself throws.

Reimplemented from zserio::ReflectableBase< ALLOC >.

Definition at line 4402 of file Reflectable.h.

◆ initialize()

template<typename ALLOC >
void zserio::ReflectableConstAllocatorHolderBase< ALLOC >::initialize ( const vector< AnyHolder< ALLOC >, ALLOC > &  typeArguments)
overridevirtual

Initializes the reflected parameterized compound object. Calls initialize method on the generated C++ object. Note that the arguments must exactly match. In case that the argument is a compound type, which is normally passed as a reference, it must be wrapped in a reference wrapper.

Exceptions
CppRuntimeExceptionWhen the reflected object is not parameterized or when the arguments do not match.

Reimplemented from zserio::ReflectableBase< ALLOC >.

Definition at line 4378 of file Reflectable.h.

◆ initializeChildren()

template<typename ALLOC >
void zserio::ReflectableConstAllocatorHolderBase< ALLOC >::initializeChildren
overridevirtual

Initializes children of the reflected compound. Calls initializeChildren method on the generated C++ object, which recursively initializes the whole object tree. When nothing within the object tree is parameterized, does nothing.

Note
This method is designed to be called on the top level object (i.e. root).
Exceptions
CppRuntimeExceptionWhen the reflected object is not a compound type.

Reimplemented from zserio::ReflectableBase< ALLOC >.

Definition at line 4372 of file Reflectable.h.

◆ initializeOffsets()

template<typename ALLOC >
size_t zserio::ReflectableConstAllocatorHolderBase< ALLOC >::initializeOffsets ( size_t  bitPosition)
overridevirtual

Initializes indexed offsets of the reflected compound object.

Parameters
bitPositionThe bit stream position to be used for calculation.
Exceptions
CppRuntimeExceptionWhen the reflected object is not a compound.
Returns
Updated bit position which points to the first bit after the compound.

Reimplemented from zserio::ReflectableBase< ALLOC >.

Definition at line 4384 of file Reflectable.h.

◆ setField()

template<typename ALLOC >
void zserio::ReflectableConstAllocatorHolderBase< ALLOC >::setField ( StringView  name,
const AnyHolder< ALLOC > &  value 
)
overridevirtual

Sets the field (i.e. member) with the given schema name.

Note
For optional fields, the value can be also nullptr of type std::nullptr_t which allows to reset an optional field.
Parameters
nameField schema name.
valueValue to set. The type must exactly match the type of the zserio field mapped to C++!
Exceptions
CppRuntimeExceptionWhen the reflected object is not a compound type or when the field with the given name doesn't exist or when the provided value is of a wrong type or when the field setter itself throws.

Reimplemented from zserio::ReflectableBase< ALLOC >.

Definition at line 4396 of file Reflectable.h.


The documentation for this class was generated from the following file: