_Wolframe::serialize::DDLStructSerializer Class Reference

Iterator on a DDL structure (serializer of VariantStruct) More...

#include <ddlStructSerializer.hpp>

Inheritance diagram for _Wolframe::serialize::DDLStructSerializer:

Public Member Functions
	DDLStructSerializer ()
	Default constructor. More...
	DDLStructSerializer (const types::VariantStruct *st)
	Constructor. More...
	DDLStructSerializer (const DDLStructSerializer &o)
	Copy constructor. More...
virtual	~DDLStructSerializer ()
	Destructor. More...
DDLStructSerializer &	operator= (const DDLStructSerializer &o)
	Assignment operator. More...
void	init (const langbind::TypedOutputFilterR &out, serialize::Flags::Enum flags=serialize::Flags::None)
	Serialize start initialization. More...
bool	call ()
	Call of one processing step the serializer. More...
virtual TypedInputFilter *	copy () const
	Get a self copy. More...
virtual bool	getNext (langbind::FilterBase::ElementType &type, types::VariantConst &value)
	Get the next element of the serialization. More...
virtual bool	setFlags (Flags f)
	Set the flags stearing the serialization. More...
Public Member Functions inherited from _Wolframe::langbind::TypedInputFilter
	TypedInputFilter (const char *name_)
	Constructor. More...
	TypedInputFilter (const TypedInputFilter &o)
	Copy constructor. More...
virtual	~TypedInputFilter ()
	Destructor. More...
State	state () const
	Get the current state. More...
void	setState (State s, const char *msg=0)
	Set input filter state with error message. More...
virtual void	resetIterator ()
	Set the iterator to the start (if implemented) More...
Public Member Functions inherited from _Wolframe::langbind::FilterBase
	FilterBase (const char *name_)
	FilterBase (const FilterBase &o)
virtual	~FilterBase ()
virtual const char *	getError () const
	Get the las error in case of error state. More...
void	setError (const char *msg=0)
	Set input filter error message. More...
bool	flag (Flags f) const
	Query a flag (or a set of flags) More...
Flags	flags () const
	Get all flags. More...
virtual bool	checkSetFlags (Flags) const
	Test if a flag can be set (allowed) More...
const char *	name () const
	Get the name of the filter. More...

Private Attributes
const types::VariantStruct *	m_st
Context	m_ctx
langbind::TypedOutputFilterR	m_out
DDLSerializeStateStack	m_stk

Additional Inherited Members
Public Types inherited from _Wolframe::langbind::TypedInputFilter
typedef InputFilter::State	State
Public Types inherited from _Wolframe::langbind::FilterBase
enum	ElementType { OpenTag, Attribute, Value, CloseTag }
	Content element type that describes the role of the element in the structured input. More...
enum	Flags { None =0x00, SerializeWithIndices =0x01, PropagateNoCase =0x02, PropagateNoAttr =0x04 }
Static Public Member Functions inherited from _Wolframe::langbind::FilterBase
static const char *	elementTypeName (ElementType i)
	Get the name of an ElementType as string. More...

Detailed Description

Iterator on a DDL structure (serializer of VariantStruct)

Constructor & Destructor Documentation

_Wolframe::serialize::DDLStructSerializer::DDLStructSerializer ( )

inline

Default constructor.

_Wolframe::serialize::DDLStructSerializer::DDLStructSerializer ( const types::VariantStruct *  st )

explicit

Constructor.

_Wolframe::serialize::DDLStructSerializer::DDLStructSerializer

(

const DDLStructSerializer &

o

)

Copy constructor.

virtual _Wolframe::serialize::DDLStructSerializer::~DDLStructSerializer ( )

inlinevirtual

Destructor.

Member Function Documentation

bool _Wolframe::serialize::DDLStructSerializer::call

(

)

Call of one processing step the serializer.

Remarks

The processing is finished when the call returns true. In case of false returned you have to inspect the output filter state to determine what is to do next.

Do not mix 'call()' with 'init(const langbind::TypedOutputFilterR&,Flags::Enum)' and 'getNext(langbind::FilterBase::ElementType&,types::VariantConst&)'. Use either one or the other

virtual TypedInputFilter* _Wolframe::serialize::DDLStructSerializer::copy ( ) const

inlinevirtual

Get a self copy.

Returns

allocated pointer to copy of this

Implements _Wolframe::langbind::TypedInputFilter.

virtual bool _Wolframe::serialize::DDLStructSerializer::getNext ( langbind::FilterBase::ElementType &  type, types::VariantConst &  value  )

virtual

Get the next element of the serialization.

Remarks

Do not mix 'call()' with 'init(const langbind::TypedOutputFilterR&,Flags::Enum)' and 'getNext(langbind::FilterBase::ElementType&,types::VariantConst&)'. Use either one or the other

Implements _Wolframe::langbind::TypedInputFilter.

void _Wolframe::serialize::DDLStructSerializer::init	(	const langbind::TypedOutputFilterR &	out,
		serialize::Flags::Enum	flags = serialize::Flags::None
	)

Serialize start initialization.

DDLStructSerializer& _Wolframe::serialize::DDLStructSerializer::operator=

(

const DDLStructSerializer &

o

)

Assignment operator.

virtual bool _Wolframe::serialize::DDLStructSerializer::setFlags ( Flags  f )

virtual

Set the flags stearing the serialization.

Returns

false, if not all flags have the behaviour implemented and are accepted

Reimplemented from _Wolframe::langbind::FilterBase.

Member Data Documentation

Context _Wolframe::serialize::DDLStructSerializer::m_ctx

private

langbind::TypedOutputFilterR _Wolframe::serialize::DDLStructSerializer::m_out

private

const types::VariantStruct* _Wolframe::serialize::DDLStructSerializer::m_st

private

DDLSerializeStateStack _Wolframe::serialize::DDLStructSerializer::m_stk

private

---

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

• include/serialize/ddl/ddlStructSerializer.hpp