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

#include <Walker.h>

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

Public Member Functions

 BasicDepthWalkFilter (size_t maxDepth)
 
 ~BasicDepthWalkFilter () override=default
 
bool beforeArray (const IBasicReflectableConstPtr< ALLOC > &array, const BasicFieldInfo< ALLOC > &fieldInfo) override
 
bool afterArray (const IBasicReflectableConstPtr< ALLOC > &array, const BasicFieldInfo< ALLOC > &fieldInfo) override
 
bool beforeCompound (const IBasicReflectableConstPtr< ALLOC > &compound, const BasicFieldInfo< ALLOC > &fieldInfo, size_t elementIndex) override
 
bool afterCompound (const IBasicReflectableConstPtr< ALLOC > &compound, const BasicFieldInfo< ALLOC > &fieldInfo, size_t elementIndex) override
 
bool beforeValue (const IBasicReflectableConstPtr< ALLOC > &value, const BasicFieldInfo< ALLOC > &fieldInfo, size_t elementIndex) override
 
bool afterValue (const IBasicReflectableConstPtr< ALLOC > &value, const BasicFieldInfo< ALLOC > &fieldInfo, size_t elementIndex) override
 
 BasicDepthWalkFilter (const BasicDepthWalkFilter &other)=delete
 
BasicDepthWalkFilteroperator= (const BasicDepthWalkFilter &other)=delete
 
 BasicDepthWalkFilter (BasicDepthWalkFilter &&other)=delete
 
BasicDepthWalkFilteroperator= (BasicDepthWalkFilter &&other)=delete
 
- Public Member Functions inherited from zserio::IBasicWalkFilter< ALLOC >
virtual ~IBasicWalkFilter ()=default
 

Detailed Description

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

Walk filter which allows to walk only to the given maximum depth.

Definition at line 199 of file Walker.h.

Constructor & Destructor Documentation

template<typename ALLOC >
zserio::BasicDepthWalkFilter< ALLOC >::BasicDepthWalkFilter ( size_t  maxDepth)
explicit

Constructor.

Parameters
maxDepthMaximum depth to walk to.

Definition at line 552 of file Walker.h.

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

Method generated by default.

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

Copying is disallowed!

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

Copying is disallowed!

Member Function Documentation

template<typename ALLOC >
bool zserio::BasicDepthWalkFilter< ALLOC >::afterArray ( const IBasicReflectableConstPtr< ALLOC > &  array,
const BasicFieldInfo< ALLOC > &  fieldInfo 
)
overridevirtual

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 564 of file Walker.h.

template<typename ALLOC >
bool zserio::BasicDepthWalkFilter< ALLOC >::afterCompound ( const IBasicReflectableConstPtr< ALLOC > &  compound,
const BasicFieldInfo< ALLOC > &  fieldInfo,
size_t  elementIndex 
)
overridevirtual

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 578 of file Walker.h.

template<typename ALLOC >
bool zserio::BasicDepthWalkFilter< ALLOC >::afterValue ( const IBasicReflectableConstPtr< ALLOC > &  value,
const BasicFieldInfo< ALLOC > &  fieldInfo,
size_t  elementIndex 
)
overridevirtual

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 592 of file Walker.h.

template<typename ALLOC >
bool zserio::BasicDepthWalkFilter< ALLOC >::beforeArray ( const IBasicReflectableConstPtr< ALLOC > &  array,
const BasicFieldInfo< ALLOC > &  fieldInfo 
)
overridevirtual

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 557 of file Walker.h.

template<typename ALLOC >
bool zserio::BasicDepthWalkFilter< ALLOC >::beforeCompound ( const IBasicReflectableConstPtr< ALLOC > &  compound,
const BasicFieldInfo< ALLOC > &  fieldInfo,
size_t  elementIndex 
)
overridevirtual

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 571 of file Walker.h.

template<typename ALLOC >
bool zserio::BasicDepthWalkFilter< ALLOC >::beforeValue ( const IBasicReflectableConstPtr< ALLOC > &  value,
const BasicFieldInfo< ALLOC > &  fieldInfo,
size_t  elementIndex 
)
overridevirtual

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 585 of file Walker.h.

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

Copying is disallowed!

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

Copying is disallowed!


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