#include <Reflectable.h>

Inheritance diagram for zserio::ReflectableOwner< T, ALLOC >:

Collaboration diagram for zserio::ReflectableOwner< T, ALLOC >:

Public Member Functions
	ReflectableOwner ()

	ReflectableOwner (const ALLOC &allocator)

const IBasicTypeInfo< ALLOC > &	getTypeInfo () const override

bool	isArray () const override

void	initializeChildren () override

void	initialize (const vector< AnyHolder< ALLOC >, ALLOC > &typeArguments) override

size_t	initializeOffsets (size_t bitPosition) 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 >	getField (StringView name) override

IBasicReflectablePtr< ALLOC >	createField (StringView name) override

void	setField (StringView name, const AnyHolder< ALLOC > &value) override

IBasicReflectableConstPtr< ALLOC >	getParameter (StringView name) const override

IBasicReflectablePtr< ALLOC >	getParameter (StringView name) override

IBasicReflectableConstPtr< ALLOC >	callFunction (StringView name) const override

IBasicReflectablePtr< ALLOC >	callFunction (StringView name) 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 ALLOC &allocator) 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< RebindAlloc< ALLOC, char > >	toString (const ALLOC &allocator) const override

string< RebindAlloc< ALLOC, char > >	toString () const override

const ParsingInfo &	parsingInfo () const override

Public Member Functions inherited from zserio::IBasicReflectable< typename T::allocator_type >
virtual	~IBasicReflectable ()=default

virtual void	initialize (const vector< AnyHolder< typename T::allocator_type >, typename T::allocator_type > &typeArguments)=0

virtual void	setField (StringView name, const AnyHolder< typename T::allocator_type > &value)=0

virtual void	setAt (const AnyHolder< typename T::allocator_type > &value, size_t index)=0

virtual void	append (const AnyHolder< typename T::allocator_type > &value)=0

virtual AnyHolder< typename T::allocator_type >	getAnyValue (const typename T::allocator_type &allocator) const=0

virtual AnyHolder< typename T::allocator_type >	getAnyValue (const typename T::allocator_type &allocator)=0

virtual string< typename T::allocator_type >	toString (const typename T::allocator_type &allocator) const=0

Additional Inherited Members
Public Types inherited from zserio::IBasicReflectable< typename T::allocator_type >
using	Ptr = std::shared_ptr< IBasicReflectable >

using	ConstPtr = std::shared_ptr< const IBasicReflectable >

Detailed Description

template<typename T, typename ALLOC = typename T::allocator_type>
class zserio::ReflectableOwner< T, ALLOC >

Wrapper around reflectable which actually owns the reflected object.

This is needed in ZserioTreeCreator to be able to generically create the new instance of a zserio object.

Definition at line 3141 of file Reflectable.h.

Constructor & Destructor Documentation

◆ ReflectableOwner() [1/2]

template<typename T , typename ALLOC = typename T::allocator_type>

zserio::ReflectableOwner< T, ALLOC >::ReflectableOwner ( )

inline

Definition at line 3144 of file Reflectable.h.

◆ ReflectableOwner() [2/2]

template<typename T , typename ALLOC = typename T::allocator_type>

zserio::ReflectableOwner< T, ALLOC >::ReflectableOwner ( const ALLOC & allocator )

inlineexplicit

Definition at line 3148 of file Reflectable.h.

Member Function Documentation

◆ append()

template<typename T , typename ALLOC = typename T::allocator_type>

void zserio::ReflectableOwner< T, ALLOC >::append ( const AnyHolder< ALLOC > & value )

inlineoverride

Definition at line 3298 of file Reflectable.h.

◆ at() [1/2]

template<typename T , typename ALLOC = typename T::allocator_type>

IBasicReflectableConstPtr<ALLOC> zserio::ReflectableOwner< T, ALLOC >::at ( size_t index ) const

inlineoverridevirtual

Gets reflectable view to an array element.

Note: Can be called only when the reflected object is an array.

Returns: Reflectable view to an array element on the given index.

Exceptions

CppRuntimeException When the reflected object is not an array or when the given index is out of bounds of the underlying array.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3273 of file Reflectable.h.

◆ at() [2/2]

template<typename T , typename ALLOC = typename T::allocator_type>

IBasicReflectablePtr<ALLOC> zserio::ReflectableOwner< T, ALLOC >::at ( size_t index )

inlineoverridevirtual

Gets reflectable view to an array element.

Note: Can be called only when the reflected object is an array.

Returns: Reflectable view to an array element on the given index.

Exceptions

CppRuntimeException When the reflected object is not an array or when the given index is out of bounds of the underlying array.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3278 of file Reflectable.h.

◆ bitSizeOf() [1/2]

template<typename T , typename ALLOC = typename T::allocator_type>

size_t zserio::ReflectableOwner< T, ALLOC >::bitSizeOf ( ) const

inlineoverridevirtual

Gets the number of bits needed for serialization of the reflected object.

The bit stream position to be used for calculation is defaulted to zero.

Note: Works for all reflectable types except arrays!

Exceptions

CppRuntimeException When the reflected object is an array.

Returns: The size of the serialized reflected object in bits.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3188 of file Reflectable.h.

◆ bitSizeOf() [2/2]

template<typename T , typename ALLOC = typename T::allocator_type>

size_t zserio::ReflectableOwner< T, ALLOC >::bitSizeOf ( size_t bitPosition ) const

inlineoverridevirtual

Gets the number of bits needed for serialization of the reflected object.

Note: Works for all reflectable types except arrays!

Parameters

bitPosition The bit stream position to be used for calculation.

Exceptions

CppRuntimeException When the reflected object is an array.

Returns: The size of the serialized reflected object in bits.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3183 of file Reflectable.h.

◆ callFunction() [1/2]

template<typename T , typename ALLOC = typename T::allocator_type>

IBasicReflectableConstPtr<ALLOC> zserio::ReflectableOwner< T, ALLOC >::callFunction ( StringView name ) const

inlineoverridevirtual

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

name	Function schema name.

Returns: Reflectable view to the value returns from the called function.

Exceptions

CppRuntimeException When 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.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3228 of file Reflectable.h.

◆ callFunction() [2/2]

template<typename T , typename ALLOC = typename T::allocator_type>

IBasicReflectablePtr<ALLOC> zserio::ReflectableOwner< T, ALLOC >::callFunction ( StringView name )

inlineoverridevirtual

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

name	Function schema name.

Returns: Reflectable view to the value returns from the called function.

Exceptions

CppRuntimeException When 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.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3233 of file Reflectable.h.

◆ createField()

template<typename T , typename ALLOC = typename T::allocator_type>

IBasicReflectablePtr<ALLOC> zserio::ReflectableOwner< T, ALLOC >::createField ( StringView name )

inlineoverridevirtual

Creates a default constructed field within current object and returns reflectable pointer to it.

Note: When the field already exists, it's reset with the new default constructed value.

Parameters

name	Name of the optional field to create.

Returns: Reflectable to just created object.

Exceptions

CppRuntimeException When the reflected object is not a compound type or when the field with the given name doesn't exists.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3208 of file Reflectable.h.

◆ find() [1/2]

template<typename T , typename ALLOC = typename T::allocator_type>

IBasicReflectableConstPtr<ALLOC> zserio::ReflectableOwner< T, ALLOC >::find ( StringView path ) const

inlineoverridevirtual

Universal accessor to zserio entities within the zserio sub-tree represented by the reflected object.

Supports dot notation corresponding to the tree defined in zserio language. Can access fields or parameters or call functions within the zserio sub-tree.

Examples:

'fieldA.param' - Gets reflectable view to parameter 'param' within the parameterized field 'fieldA'.
'child.getValue' - Gets reflectable view to result of the function called on field ̈́'child'.
'child.nonexisting.field' - Gets nullptr since the path doesn't represent a valid entity.

Parameters

path	Dot notation corresponding to the zserio tree.

Returns: Reflectable view to the result of the given path. Returns nullptr when the path doesn't exist or when the requested operation throws CppRuntimeException.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3243 of file Reflectable.h.

◆ find() [2/2]

template<typename T , typename ALLOC = typename T::allocator_type>

IBasicReflectablePtr<ALLOC> zserio::ReflectableOwner< T, ALLOC >::find ( StringView path )

inlineoverridevirtual

Universal accessor to zserio entities within the zserio sub-tree represented by the reflected object.

Supports dot notation corresponding to the tree defined in zserio language. Can access fields or parameters or call functions within the zserio sub-tree.

Examples:

'fieldA.param' - Gets reflectable view to parameter 'param' within the parameterized field 'fieldA'.
'child.getValue' - Gets reflectable view to result of the function called on field ̈́'child'.
'child.nonexisting.field' - Gets nullptr since the path doesn't represent a valid entity.

Parameters

path	Dot notation corresponding to the zserio tree.

Returns: Reflectable view to the result of the given path. Returns nullptr when the path doesn't exist or when the requested operation throws CppRuntimeException.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3248 of file Reflectable.h.

◆ getAnyValue() [1/4]

template<typename T , typename ALLOC = typename T::allocator_type>

AnyHolder<ALLOC> zserio::ReflectableOwner< T, ALLOC >::getAnyValue ( ) const

inlineoverridevirtual

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

allocator Allocator to use for the value allocation.

Returns: Any value.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3313 of file Reflectable.h.

◆ getAnyValue() [2/4]

template<typename T , typename ALLOC = typename T::allocator_type>

AnyHolder<ALLOC> zserio::ReflectableOwner< T, ALLOC >::getAnyValue ( )

inlineoverridevirtual

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

allocator Allocator to use for the value allocation.

Returns: Any value.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3318 of file Reflectable.h.

◆ getAnyValue() [3/4]

template<typename T , typename ALLOC = typename T::allocator_type>

AnyHolder<ALLOC> zserio::ReflectableOwner< T, ALLOC >::getAnyValue ( const ALLOC & allocator ) const

inlineoverride

Definition at line 3303 of file Reflectable.h.

◆ getAnyValue() [4/4]

template<typename T , typename ALLOC = typename T::allocator_type>

AnyHolder<ALLOC> zserio::ReflectableOwner< T, ALLOC >::getAnyValue ( const ALLOC & allocator )

inlineoverride

Definition at line 3308 of file Reflectable.h.

◆ getBitBuffer()

template<typename T , typename ALLOC = typename T::allocator_type>

const BasicBitBuffer<ALLOC>& zserio::ReflectableOwner< T, ALLOC >::getBitBuffer ( ) const

inlineoverridevirtual

Gets reference to the reflected bit buffer.

Returns: Reference to the bit buffer.

Exceptions

CppRuntimeException When the reflected object is not a bit buffer (i.e. extern type).

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3376 of file Reflectable.h.

◆ getBool()

template<typename T , typename ALLOC = typename T::allocator_type>

bool zserio::ReflectableOwner< T, ALLOC >::getBool ( ) const

inlineoverridevirtual

Gets bool value of the bool reflectable.

Returns: Bool value.

Exceptions

CppRuntimeException When the reflected object is not a bool type.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3324 of file Reflectable.h.

◆ getBytes()

template<typename T , typename ALLOC = typename T::allocator_type>

Span<const uint8_t> zserio::ReflectableOwner< T, ALLOC >::getBytes ( ) const

inlineoverridevirtual

Gets byte value of the bytes reflectable.

Returns: Bytes value as a span.

Exceptions

CppRuntimeException When the reflected object is not a bytes type.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3368 of file Reflectable.h.

◆ getChoice()

template<typename T , typename ALLOC = typename T::allocator_type>

StringView zserio::ReflectableOwner< T, ALLOC >::getChoice ( ) const

inlineoverridevirtual

Gets name of the field which is active in the reflected choice type.

Note: Applicable only on zserio unions and choices.

Returns: Name of the active field (i.e. currently selected choice).

Exceptions

CppRuntimeException When the reflected object is not a choice type (or union).

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3238 of file Reflectable.h.

◆ getDouble()

template<typename T , typename ALLOC = typename T::allocator_type>

double zserio::ReflectableOwner< T, ALLOC >::getDouble ( ) const

inlineoverridevirtual

Gets double value of the double reflectable.

Returns: Double value.

Exceptions

CppRuntimeException When the reflected object is not a double type.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3364 of file Reflectable.h.

◆ getField() [1/2]

template<typename T , typename ALLOC = typename T::allocator_type>

IBasicReflectableConstPtr<ALLOC> zserio::ReflectableOwner< T, ALLOC >::getField ( StringView name ) const

inlineoverridevirtual

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

name	Field schema name.

Returns: Reflectable view to the requested field.

Exceptions

CppRuntimeException When 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.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3198 of file Reflectable.h.

◆ getField() [2/2]

template<typename T , typename ALLOC = typename T::allocator_type>

IBasicReflectablePtr<ALLOC> zserio::ReflectableOwner< T, ALLOC >::getField ( StringView name )

inlineoverridevirtual

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

name	Field schema name.

Returns: Reflectable view to the requested field.

Exceptions

CppRuntimeException When 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.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3203 of file Reflectable.h.

◆ getFloat()

template<typename T , typename ALLOC = typename T::allocator_type>

float zserio::ReflectableOwner< T, ALLOC >::getFloat ( ) const

inlineoverridevirtual

Gets float value of the float reflectable.

Returns: Float value.

Exceptions

CppRuntimeException When the reflected object is not a float type.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3360 of file Reflectable.h.

◆ getInt16()

template<typename T , typename ALLOC = typename T::allocator_type>

int16_t zserio::ReflectableOwner< T, ALLOC >::getInt16 ( ) const

inlineoverridevirtual

Gets 16-bit signed integral value of the int16_t reflectable.

Returns: 16-bit signed integral value.

Exceptions

CppRuntimeException When the reflected object is not a int16_t type.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3332 of file Reflectable.h.

◆ getInt32()

template<typename T , typename ALLOC = typename T::allocator_type>

int32_t zserio::ReflectableOwner< T, ALLOC >::getInt32 ( ) const

inlineoverridevirtual

Gets 32-bit signed integral value of the int32_t reflectable.

Returns: 32-bit signed integral value.

Exceptions

CppRuntimeException When the reflected object is not a int32_t type.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3336 of file Reflectable.h.

◆ getInt64()

template<typename T , typename ALLOC = typename T::allocator_type>

int64_t zserio::ReflectableOwner< T, ALLOC >::getInt64 ( ) const

inlineoverridevirtual

Gets 64-bit signed integral value of the int64_t reflectable.

Returns: 64-bit signed integral value.

Exceptions

CppRuntimeException When the reflected object is not a int64_t type.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3340 of file Reflectable.h.

◆ getInt8()

template<typename T , typename ALLOC = typename T::allocator_type>

int8_t zserio::ReflectableOwner< T, ALLOC >::getInt8 ( ) const

inlineoverridevirtual

Gets 8-bit signed integral value of the int8_t reflectable.

Returns: 8-bit signed integral value.

Exceptions

CppRuntimeException When the reflected object is not a int8_t type.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3328 of file Reflectable.h.

◆ getParameter() [1/2]

template<typename T , typename ALLOC = typename T::allocator_type>

IBasicReflectableConstPtr<ALLOC> zserio::ReflectableOwner< T, ALLOC >::getParameter ( StringView name ) const

inlineoverridevirtual

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

name	Parameter schema name.

Returns: Reflectable view to the requested parameter.

Exceptions

CppRuntimeException When 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.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3218 of file Reflectable.h.

◆ getParameter() [2/2]

template<typename T , typename ALLOC = typename T::allocator_type>

IBasicReflectablePtr<ALLOC> zserio::ReflectableOwner< T, ALLOC >::getParameter ( StringView name )

inlineoverridevirtual

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

name	Parameter schema name.

Returns: Reflectable view to the requested parameter.

Exceptions

CppRuntimeException When 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.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3223 of file Reflectable.h.

◆ getStringView()

template<typename T , typename ALLOC = typename T::allocator_type>

StringView zserio::ReflectableOwner< T, ALLOC >::getStringView ( ) const

inlineoverridevirtual

Gets reference to the string value of the string reflectable.

Returns: Reference to the string value.

Exceptions

CppRuntimeException When the reflected object is not a string type.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3372 of file Reflectable.h.

◆ getTypeInfo()

template<typename T , typename ALLOC = typename T::allocator_type>

const IBasicTypeInfo<ALLOC>& zserio::ReflectableOwner< T, ALLOC >::getTypeInfo ( ) const

inlineoverridevirtual

Gets type info for the current zserio object.

Returns: Reference to the static instance of type info.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3153 of file Reflectable.h.

◆ getUInt16()

template<typename T , typename ALLOC = typename T::allocator_type>

uint16_t zserio::ReflectableOwner< T, ALLOC >::getUInt16 ( ) const

inlineoverridevirtual

Gets 16-bit unsigned integral value of the uint16_t reflectable.

Returns: 16-bit unsigned integral value.

Exceptions

CppRuntimeException When the reflected object is not a uint16_t type.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3348 of file Reflectable.h.

◆ getUInt32()

template<typename T , typename ALLOC = typename T::allocator_type>

uint32_t zserio::ReflectableOwner< T, ALLOC >::getUInt32 ( ) const

inlineoverridevirtual

Gets 32-bit unsigned integral value of the uint32_t reflectable.

Returns: 32-bit unsigned integral value.

Exceptions

CppRuntimeException When the reflected object is not a uint32_t type.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3352 of file Reflectable.h.

◆ getUInt64()

template<typename T , typename ALLOC = typename T::allocator_type>

uint64_t zserio::ReflectableOwner< T, ALLOC >::getUInt64 ( ) const

inlineoverridevirtual

Gets 64-bit unsigned integral value of the uint64_t reflectable.

Returns: 64-bit unsigned integral value.

Exceptions

CppRuntimeException When the reflected object is not a uint64_t type.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3356 of file Reflectable.h.

◆ getUInt8()

template<typename T , typename ALLOC = typename T::allocator_type>

uint8_t zserio::ReflectableOwner< T, ALLOC >::getUInt8 ( ) const

inlineoverridevirtual

Gets 8-bit unsigned integral value of the uint8_t reflectable.

Returns: 8-bit unsigned integral value.

Exceptions

CppRuntimeException When the reflected object is not a uint8_t type.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3344 of file Reflectable.h.

◆ initialize()

template<typename T , typename ALLOC = typename T::allocator_type>

void zserio::ReflectableOwner< T, ALLOC >::initialize ( const vector< AnyHolder< ALLOC >, ALLOC > & typeArguments )

inlineoverride

Definition at line 3168 of file Reflectable.h.

◆ initializeChildren()

template<typename T , typename ALLOC = typename T::allocator_type>

void zserio::ReflectableOwner< T, ALLOC >::initializeChildren ( )

inlineoverridevirtual

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

CppRuntimeException When the reflected object is not a compound type.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3163 of file Reflectable.h.

◆ initializeOffsets() [1/2]

template<typename T , typename ALLOC = typename T::allocator_type>

size_t zserio::ReflectableOwner< T, ALLOC >::initializeOffsets ( )

inlineoverridevirtual

Initializes indexed offsets of the reflected compound object.

The bit stream position to be used for calculation is defaulted to zero.

Exceptions

CppRuntimeException When the reflected object is not a compound.

Returns: Updated bit position which points to the first bit after the compound.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3178 of file Reflectable.h.

◆ initializeOffsets() [2/2]

template<typename T , typename ALLOC = typename T::allocator_type>

size_t zserio::ReflectableOwner< T, ALLOC >::initializeOffsets ( size_t bitPosition )

inlineoverridevirtual

Initializes indexed offsets of the reflected compound object.

Parameters

bitPosition The bit stream position to be used for calculation.

Exceptions

CppRuntimeException When the reflected object is not a compound.

Returns: Updated bit position which points to the first bit after the compound.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3173 of file Reflectable.h.

◆ isArray()

template<typename T , typename ALLOC = typename T::allocator_type>

bool zserio::ReflectableOwner< T, ALLOC >::isArray ( ) const

inlineoverridevirtual

Gets whether the reflected object is an array.

Returns: True when the object is an array, false otherwise.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3158 of file Reflectable.h.

◆ operator[]() [1/4]

template<typename T , typename ALLOC = typename T::allocator_type>

IBasicReflectableConstPtr<ALLOC> zserio::ReflectableOwner< T, ALLOC >::operator[] ( size_t index ) const

inlineoverridevirtual

Gets reflectable view to an array element.

Note: Can be called only when the reflected object is an array.

Returns: Reflectable view to an array element on the given index.

Exceptions

CppRuntimeException When the reflected object is not an array or when the given index is out of bounds of the underlying array.

Overloaded method provided for convenience.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3283 of file Reflectable.h.

◆ operator[]() [2/4]

template<typename T , typename ALLOC = typename T::allocator_type>

IBasicReflectablePtr<ALLOC> zserio::ReflectableOwner< T, ALLOC >::operator[] ( size_t index )

inlineoverridevirtual

Gets reflectable view to an array element.

Note: Can be called only when the reflected object is an array.

Returns: Reflectable view to an array element on the given index.

Exceptions

CppRuntimeException When the reflected object is not an array or when the given index is out of bounds of the underlying array.

Overloaded method provided for convenience.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3288 of file Reflectable.h.

◆ operator[]() [3/4]

template<typename T , typename ALLOC = typename T::allocator_type>

IBasicReflectableConstPtr<ALLOC> zserio::ReflectableOwner< T, ALLOC >::operator[] ( StringView path ) const

inlineoverridevirtual

Universal accessor to zserio entities within the zserio sub-tree represented by the reflected object.

Supports dot notation corresponding to the tree defined in zserio language. Can access fields or parameters or call functions within the zserio sub-tree.

Examples:

'fieldA.param' - Gets reflectable view to parameter 'param' within the parameterized field 'fieldA'.
'child.getValue' - Gets reflectable view to result of the function called on field ̈́'child'.
'child.nonexisting.field' - Gets nullptr since the path doesn't represent a valid entity.

Parameters

path	Dot notation corresponding to the zserio tree.

Returns: Reflectable view to the result of the given path. Returns nullptr when the path doesn't exist or when the requested operation throws CppRuntimeException.

Overloaded method provided for convenience.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3253 of file Reflectable.h.

◆ operator[]() [4/4]

template<typename T , typename ALLOC = typename T::allocator_type>

IBasicReflectablePtr<ALLOC> zserio::ReflectableOwner< T, ALLOC >::operator[] ( StringView path )

inlineoverridevirtual

Universal accessor to zserio entities within the zserio sub-tree represented by the reflected object.

Supports dot notation corresponding to the tree defined in zserio language. Can access fields or parameters or call functions within the zserio sub-tree.

Examples:

'fieldA.param' - Gets reflectable view to parameter 'param' within the parameterized field 'fieldA'.
'child.getValue' - Gets reflectable view to result of the function called on field ̈́'child'.
'child.nonexisting.field' - Gets nullptr since the path doesn't represent a valid entity.

Parameters

path	Dot notation corresponding to the zserio tree.

Returns: Reflectable view to the result of the given path. Returns nullptr when the path doesn't exist or when the requested operation throws CppRuntimeException.

Overloaded method provided for convenience.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3258 of file Reflectable.h.

◆ parsingInfo()

template<typename T , typename ALLOC = typename T::allocator_type>

const ParsingInfo& zserio::ReflectableOwner< T, ALLOC >::parsingInfo ( ) const

inlineoverridevirtual

Returns the parsing information after reading of the reflectable object.

This feature is experimental and can be removed without any warning!

Note: Note that the returned parsing information is valid only directly after read! If the Zserio object has been changed after reading, the result is undefined!; The parsing information is available only for code generated using -withParsingInfo option.

Returns: The parsing information of the reflectable object.

Exceptions

CppRuntimeException If the object was compiled without the parsing info feature enabled.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3403 of file Reflectable.h.

◆ resize()

template<typename T , typename ALLOC = typename T::allocator_type>

void zserio::ReflectableOwner< T, ALLOC >::resize ( size_t size )

inlineoverridevirtual

Resizes the reflected array.

Note: Can be called only when the reflected object is an array.

Parameters

size	New array size.

Exceptions

CppRuntimeException When the reflected object is not an array.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3268 of file Reflectable.h.

◆ setAt()

template<typename T , typename ALLOC = typename T::allocator_type>

void zserio::ReflectableOwner< T, ALLOC >::setAt	(	const AnyHolder< ALLOC > &	value,
		size_t	index
	)

inlineoverride

Definition at line 3293 of file Reflectable.h.

◆ setField()

template<typename T , typename ALLOC = typename T::allocator_type>

void zserio::ReflectableOwner< T, ALLOC >::setField	(	StringView	name,
		const AnyHolder< ALLOC > &	value
	)

inlineoverride

Definition at line 3213 of file Reflectable.h.

◆ size()

template<typename T , typename ALLOC = typename T::allocator_type>

size_t zserio::ReflectableOwner< T, ALLOC >::size ( ) const

inlineoverridevirtual

Gets size of the reflected array.

Note: Can be called only when the reflected object is an array.

Returns: Size of the reflected array.

Exceptions

CppRuntimeException When the reflected object is not an array.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3263 of file Reflectable.h.

◆ toDouble()

template<typename T , typename ALLOC = typename T::allocator_type>

double zserio::ReflectableOwner< T, ALLOC >::toDouble ( ) const

inlineoverridevirtual

Converts any numeric value to double.

Works also for bitmask and enum types.

Returns: Double value.

Exceptions

CppRuntimeException When the reflected object cannot be converted to double.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3390 of file Reflectable.h.

◆ toInt()

template<typename T , typename ALLOC = typename T::allocator_type>

int64_t zserio::ReflectableOwner< T, ALLOC >::toInt ( ) const

inlineoverridevirtual

Converts any signed integral value to 64-bit signed integer.

Works also for enum types defined with signed underlying type.

Returns: 64-bit signed integral value.

Exceptions

CppRuntimeException When the reflected object cannot be converted to a signed integral value.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3382 of file Reflectable.h.

◆ toString() [1/2]

template<typename T , typename ALLOC = typename T::allocator_type>

string<RebindAlloc<ALLOC, char> > zserio::ReflectableOwner< T, ALLOC >::toString ( ) const

inlineoverridevirtual

Converts an reflected object to string.

Works for all integral types including bool, bitmask and enum types and for string types.

Note: Floating point types are not currently supported!; The conversion to string can be implemented for more types in future versions.; Overload without parameter use default constructed allocator.

Parameters

allocator Allocator to use for the string allocation.

Returns: String value representing the reflected object.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3398 of file Reflectable.h.

◆ toString() [2/2]

template<typename T , typename ALLOC = typename T::allocator_type>

string<RebindAlloc<ALLOC, char> > zserio::ReflectableOwner< T, ALLOC >::toString ( const ALLOC & allocator ) const

inlineoverride

Definition at line 3394 of file Reflectable.h.

◆ toUInt()

template<typename T , typename ALLOC = typename T::allocator_type>

uint64_t zserio::ReflectableOwner< T, ALLOC >::toUInt ( ) const

inlineoverridevirtual

Converts any unsigned integral value to 64-bit unsigned integer.

Works also for bitmask and enum typed defined with unsigned underlying type.

Returns: 64-bit unsigned integral value.

Exceptions

CppRuntimeException When the reflected object cannot be converted to an unsigned integral value.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3386 of file Reflectable.h.

◆ write()

template<typename T , typename ALLOC = typename T::allocator_type>

void zserio::ReflectableOwner< T, ALLOC >::write ( BitStreamWriter & writer ) const

inlineoverridevirtual

Writes the reflected object to a bit stream using the given bit stream writer.

Note: Works for all reflectable types except arrays!

Parameters

writer Bit stream writer to use.

Exceptions

CppRuntimeException When the reflected object is an array.

Implements zserio::IBasicReflectable< typename T::allocator_type >.

Definition at line 3193 of file Reflectable.h.

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

zserio/Reflectable.h

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename T, typename ALLOC = typename T::allocator_type> class zserio::ReflectableOwner< T, ALLOC >

Constructor & Destructor Documentation

◆ ReflectableOwner() [1/2]

◆ ReflectableOwner() [2/2]

Member Function Documentation

◆ append()

◆ at() [1/2]

◆ at() [2/2]

◆ bitSizeOf() [1/2]

◆ bitSizeOf() [2/2]

◆ callFunction() [1/2]

◆ callFunction() [2/2]

◆ createField()

◆ find() [1/2]

◆ find() [2/2]

◆ getAnyValue() [1/4]

◆ getAnyValue() [2/4]

◆ getAnyValue() [3/4]

◆ getAnyValue() [4/4]

◆ getBitBuffer()

◆ getBool()

◆ getBytes()

◆ getChoice()

◆ getDouble()

◆ getField() [1/2]

◆ getField() [2/2]

◆ getFloat()

◆ getInt16()

◆ getInt32()

◆ getInt64()

◆ getInt8()

◆ getParameter() [1/2]

◆ getParameter() [2/2]

◆ getStringView()

◆ getTypeInfo()

◆ getUInt16()

◆ getUInt32()

◆ getUInt64()

◆ getUInt8()

◆ initialize()

◆ initializeChildren()

◆ initializeOffsets() [1/2]

◆ initializeOffsets() [2/2]

◆ isArray()

◆ operator[]() [1/4]

◆ operator[]() [2/4]

◆ operator[]() [3/4]

◆ operator[]() [4/4]

◆ parsingInfo()

◆ resize()

◆ setAt()

◆ setField()

◆ size()

◆ toDouble()

◆ toInt()

◆ toString() [1/2]

◆ toString() [2/2]

◆ toUInt()

◆ write()

template<typename T, typename ALLOC = typename T::allocator_type>
class zserio::ReflectableOwner< T, ALLOC >