Zserio C++ runtime library  1.0.0
Built for Zserio 2.13.0
zserio::BasicDefaultWalkFilter< ALLOC > Class Template Reference

#include <Walker.h>

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

Public Member Functions

bool beforeArray (const IBasicReflectableConstPtr< ALLOC > &, const BasicFieldInfo< ALLOC > &) override
 
bool afterArray (const IBasicReflectableConstPtr< ALLOC > &, const BasicFieldInfo< ALLOC > &) override
 
bool beforeCompound (const IBasicReflectableConstPtr< ALLOC > &, const BasicFieldInfo< ALLOC > &, size_t) override
 
bool afterCompound (const IBasicReflectableConstPtr< ALLOC > &, const BasicFieldInfo< ALLOC > &, size_t) override
 
bool beforeValue (const IBasicReflectableConstPtr< ALLOC > &, const BasicFieldInfo< ALLOC > &, size_t) override
 
bool afterValue (const IBasicReflectableConstPtr< ALLOC > &, const BasicFieldInfo< ALLOC > &, size_t) override
 
 BasicDefaultWalkFilter ()=default
 
 ~BasicDefaultWalkFilter () override=default
 
 BasicDefaultWalkFilter (const BasicDefaultWalkFilter &other)=delete
 
BasicDefaultWalkFilteroperator= (const BasicDefaultWalkFilter &other)=delete
 
 BasicDefaultWalkFilter (BasicDefaultWalkFilter &&other)=delete
 
BasicDefaultWalkFilteroperator= (BasicDefaultWalkFilter &&other)=delete
 
- Public Member Functions inherited from zserio::IBasicWalkFilter< ALLOC >
virtual ~IBasicWalkFilter ()=default
 

Detailed Description

template<typename ALLOC = std::allocator<uint8_t>>
class zserio::BasicDefaultWalkFilter< ALLOC >

Default walk filter which filters nothing.

Definition at line 22 of file Walker.h.

Constructor & Destructor Documentation

template<typename ALLOC = std::allocator<uint8_t>>
zserio::BasicDefaultWalkFilter< ALLOC >::BasicDefaultWalkFilter ( )
default

Method generated by default.

template<typename ALLOC = std::allocator<uint8_t>>
zserio::BasicDefaultWalkFilter< ALLOC >::~BasicDefaultWalkFilter ( )
overridedefault

Method generated by default.

template<typename ALLOC = std::allocator<uint8_t>>
zserio::BasicDefaultWalkFilter< ALLOC >::BasicDefaultWalkFilter ( const BasicDefaultWalkFilter< ALLOC > &  other)
delete

Copying and moving is disallowed!

template<typename ALLOC = std::allocator<uint8_t>>
zserio::BasicDefaultWalkFilter< ALLOC >::BasicDefaultWalkFilter ( BasicDefaultWalkFilter< ALLOC > &&  other)
delete

Copying and moving is disallowed!

Member Function Documentation

template<typename ALLOC = std::allocator<uint8_t>>
bool zserio::BasicDefaultWalkFilter< ALLOC >::afterArray ( const IBasicReflectableConstPtr< ALLOC > &  array,
const BasicFieldInfo< ALLOC > &  fieldInfo 
)
inlineoverridevirtual

Called after an array.

Parameters
arrayReflectable zserio array.
fieldInfoArray field info.
Returns
True when the walking should continue to a next sibling, false to return to the parent.

Implements zserio::IBasicWalkFilter< ALLOC >.

Definition at line 165 of file Walker.h.

template<typename ALLOC = std::allocator<uint8_t>>
bool zserio::BasicDefaultWalkFilter< ALLOC >::afterCompound ( const IBasicReflectableConstPtr< ALLOC > &  compound,
const BasicFieldInfo< ALLOC > &  fieldInfo,
size_t  elementIndex 
)
inlineoverridevirtual

Called after a compound object.

Parameters
compoundReflectable compound zserio object.
fieldInfoCompound field info.
elementIndexElement index in array or WALKER_NOT_ELEMENT if the compound is not in array.
Returns
True when the walking should continue to a next sibling, false to return to the parent.

Implements zserio::IBasicWalkFilter< ALLOC >.

Definition at line 176 of file Walker.h.

template<typename ALLOC = std::allocator<uint8_t>>
bool zserio::BasicDefaultWalkFilter< ALLOC >::afterValue ( const IBasicReflectableConstPtr< ALLOC > &  value,
const BasicFieldInfo< ALLOC > &  fieldInfo,
size_t  elementIndex 
)
inlineoverridevirtual

Called after a simple (or an unset compound or array - i.e. nullptr) value.

Parameters
valueReflectable simple value.
fieldInfoField info.
elementIndexElement index in array or None if the value is not in array.
Returns
True when the walking should continue to a next sibling, false to return to the parent.

Implements zserio::IBasicWalkFilter< ALLOC >.

Definition at line 188 of file Walker.h.

template<typename ALLOC = std::allocator<uint8_t>>
bool zserio::BasicDefaultWalkFilter< ALLOC >::beforeArray ( const IBasicReflectableConstPtr< ALLOC > &  array,
const BasicFieldInfo< ALLOC > &  fieldInfo 
)
inlineoverridevirtual

Called before an array.

Note that for unset arrays (i.e. non-present optionals) the beforeValue method with nullptr is called instead!

Parameters
arrayReflectable zserio array.
fieldInfoArray field info.
Returns
True when the walking should continue to the array.

Implements zserio::IBasicWalkFilter< ALLOC >.

Definition at line 160 of file Walker.h.

template<typename ALLOC = std::allocator<uint8_t>>
bool zserio::BasicDefaultWalkFilter< ALLOC >::beforeCompound ( const IBasicReflectableConstPtr< ALLOC > &  compound,
const BasicFieldInfo< ALLOC > &  fieldInfo,
size_t  elementIndex 
)
inlineoverridevirtual

Called before a compound object.

Note that for unset compounds (i.e. non-present optionals) the beforeValue method with nullptr is called instead!

Parameters
compoundReflectable compound zserio object.
fieldInfoCompound field info.
elementIndexElement index in array or WALKER_NOT_ELEMENT if the compound is not in array.
Returns
True when the walking should continue into the compound object, false otherwise.

Implements zserio::IBasicWalkFilter< ALLOC >.

Definition at line 170 of file Walker.h.

template<typename ALLOC = std::allocator<uint8_t>>
bool zserio::BasicDefaultWalkFilter< ALLOC >::beforeValue ( const IBasicReflectableConstPtr< ALLOC > &  value,
const BasicFieldInfo< ALLOC > &  fieldInfo,
size_t  elementIndex 
)
inlineoverridevirtual

Called before a simple (or an unset compound or array - i.e. nullptr) value.

Parameters
valueReflectable simple value.
fieldInfoField info.
elementIndexElement index in array or WALKER_NOT_ELEMENT if the value is not in array.
Returns
True when the walking should continue to the simple value, false otherwise.

Implements zserio::IBasicWalkFilter< ALLOC >.

Definition at line 182 of file Walker.h.

template<typename ALLOC = std::allocator<uint8_t>>
BasicDefaultWalkFilter& zserio::BasicDefaultWalkFilter< ALLOC >::operator= ( const BasicDefaultWalkFilter< ALLOC > &  other)
delete

Copying and moving is disallowed!

template<typename ALLOC = std::allocator<uint8_t>>
BasicDefaultWalkFilter& zserio::BasicDefaultWalkFilter< ALLOC >::operator= ( BasicDefaultWalkFilter< ALLOC > &&  other)
delete

Copying and moving is disallowed!


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