zserio::IBasicWalkFilter< ALLOC > Class Template Reference

#include <IWalkFilter.h>

Public Types
using	Path = Vector< BasicString< RebindAlloc< ALLOC, char > >, RebindAlloc< ALLOC, BasicString< RebindAlloc< ALLOC, char > >> >

Public Member Functions
virtual	~IBasicWalkFilter ()=default
virtual bool	beforeArray (const IBasicReflectableDataConstPtr< ALLOC > &array, const BasicFieldInfo< ALLOC > &fieldInfo)=0
virtual bool	afterArray (const IBasicReflectableDataConstPtr< ALLOC > &array, const BasicFieldInfo< ALLOC > &fieldInfo)=0
virtual bool	beforeCompound (const IBasicReflectableDataConstPtr< ALLOC > &compound, const BasicFieldInfo< ALLOC > &fieldInfo, size_t elementIndex)=0
virtual bool	afterCompound (const IBasicReflectableDataConstPtr< ALLOC > &compound, const BasicFieldInfo< ALLOC > &fieldInfo, size_t elementIndex)=0
virtual bool	beforeValue (const IBasicReflectableDataConstPtr< ALLOC > &value, const BasicFieldInfo< ALLOC > &fieldInfo, size_t elementIndex)=0
virtual bool	afterValue (const IBasicReflectableDataConstPtr< ALLOC > &value, const BasicFieldInfo< ALLOC > &fieldInfo, size_t elementIndex)=0

Detailed Description

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

Interface for filters which can influence the walking.

Definition at line 15 of file IWalkFilter.h.

Member Typedef Documentation

Path

template<typename ALLOC = std::allocator<uint8_t>>

using zserio::IBasicWalkFilter< ALLOC >::Path = Vector<BasicString<RebindAlloc<ALLOC, char> >, RebindAlloc<ALLOC, BasicString<RebindAlloc<ALLOC, char> >> >

Definition at line 98 of file IWalkFilter.h.

Constructor & Destructor Documentation

~IBasicWalkFilter()

template<typename ALLOC = std::allocator<uint8_t>>

virtual zserio::IBasicWalkFilter< ALLOC >::~IBasicWalkFilter ( )

virtualdefault

Destructor.

Member Function Documentation

afterArray()

template<typename ALLOC = std::allocator<uint8_t>>

virtual bool zserio::IBasicWalkFilter< ALLOC >::afterArray ( const IBasicReflectableDataConstPtr< ALLOC > &  array, const BasicFieldInfo< ALLOC > &  fieldInfo  )

pure virtual

Called after an array.

Parameters

array	Reflectable zserio array.
fieldInfo	Array field info.

Returns

True when the walking should continue to a next sibling, false to return to the parent.

Implemented in zserio::BasicDefaultWalkFilter< std::allocator< uint8_t > >.

afterCompound()

template<typename ALLOC = std::allocator<uint8_t>>

virtual bool zserio::IBasicWalkFilter< ALLOC >::afterCompound ( const IBasicReflectableDataConstPtr< ALLOC > &  compound, const BasicFieldInfo< ALLOC > &  fieldInfo, size_t  elementIndex  )

pure virtual

Called after a compound object.

Parameters

compound	Reflectable compound zserio object.
fieldInfo	Compound field info.
elementIndex	Element 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.

Implemented in zserio::BasicDefaultWalkFilter< std::allocator< uint8_t > >.

afterValue()

template<typename ALLOC = std::allocator<uint8_t>>

virtual bool zserio::IBasicWalkFilter< ALLOC >::afterValue ( const IBasicReflectableDataConstPtr< ALLOC > &  value, const BasicFieldInfo< ALLOC > &  fieldInfo, size_t  elementIndex  )

pure virtual

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

Parameters

value	Reflectable simple value.
fieldInfo	Field info.
elementIndex	Element 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.

Implemented in zserio::BasicDefaultWalkFilter< std::allocator< uint8_t > >.

beforeArray()

template<typename ALLOC = std::allocator<uint8_t>>

virtual bool zserio::IBasicWalkFilter< ALLOC >::beforeArray ( const IBasicReflectableDataConstPtr< ALLOC > &  array, const BasicFieldInfo< ALLOC > &  fieldInfo  )

pure virtual

Called before an array.

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

Parameters

array	Reflectable zserio array.
fieldInfo	Array field info.

Returns

True when the walking should continue to the array.

Implemented in zserio::BasicDefaultWalkFilter< std::allocator< uint8_t > >.

beforeCompound()

template<typename ALLOC = std::allocator<uint8_t>>

virtual bool zserio::IBasicWalkFilter< ALLOC >::beforeCompound ( const IBasicReflectableDataConstPtr< ALLOC > &  compound, const BasicFieldInfo< ALLOC > &  fieldInfo, size_t  elementIndex  )

pure virtual

Called before a compound object.

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

Parameters

compound	Reflectable compound zserio object.
fieldInfo	Compound field info.
elementIndex	Element 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.

Implemented in zserio::BasicDefaultWalkFilter< std::allocator< uint8_t > >.

beforeValue()

template<typename ALLOC = std::allocator<uint8_t>>

virtual bool zserio::IBasicWalkFilter< ALLOC >::beforeValue ( const IBasicReflectableDataConstPtr< ALLOC > &  value, const BasicFieldInfo< ALLOC > &  fieldInfo, size_t  elementIndex  )

pure virtual

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

Parameters

value	Reflectable simple value.
fieldInfo	Field info.
elementIndex	Element 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.

Implemented in zserio::BasicDefaultWalkFilter< std::allocator< uint8_t > >.

---

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

• zserio/IWalkFilter.h