XmlWriter Class Reference

XML writer class used to build XML representations of State objects. More...

#include <ArmarXGui/gui-plugins/StatechartEditorPlugin/io/XmlWriter.h>

Inheritance diagram for XmlWriter:

Public Member Functions
QString	getXmlString (bool indent=true) const
	Builds the XML document for the state object that has been handled by serialize() before.
void	serialize (armarx::statechartmodel::StateCPtr state, const QMap< QString, StateTreeNodePtr > &uuidToNodeMap=QMap< QString, StateTreeNodePtr >())
	Builds XML data structures for serialization of the given state object.
	XmlWriter (const VariantInfoPtr &variantInfo)
Public Member Functions inherited from Visitor
virtual	~Visitor ()

Protected Member Functions
void	visitDynamicRemoteState (armarx::statechartmodel::DynamicRemoteStateCPtr dynamicRemoteState) override
void	visitEndState (armarx::statechartmodel::EndStateCPtr endState) override
void	visitLocalState (armarx::statechartmodel::LocalStateCPtr localState) override
void	visitRemoteState (armarx::statechartmodel::RemoteStateCPtr remoteState) override

Detailed Description

XML writer class used to build XML representations of State objects.

Constructor & Destructor Documentation

XmlWriter()

XmlWriter

(

const VariantInfoPtr &

variantInfo

)

Member Function Documentation

getXmlString()

QString getXmlString

(

bool

indent = true

)

const

Builds the XML document for the state object that has been handled by serialize() before.

Parameters

indent

Whether to indent the resulting XML document (for output in a file) or to output unindented XML (for snapshots).

Returns

XML document as a string.

serialize()

void serialize	(	armarx::statechartmodel::StateCPtr	state,
		const QMap< QString, StateTreeNodePtr > &	uuidToNodeMap = QMap<QString, StateTreeNodePtr>() )

Builds XML data structures for serialization of the given state object.

Afterwards, the resulting XML document can be generated using the getXmlString() method.

Parameters

state

State object that should be serialized to XML.

visitDynamicRemoteState()

void visitDynamicRemoteState ( armarx::statechartmodel::DynamicRemoteStateCPtr dynamicRemoteState )

overrideprotectedvirtual

Implements Visitor.

visitEndState()

void visitEndState ( armarx::statechartmodel::EndStateCPtr endState )

overrideprotectedvirtual

Implements Visitor.

visitLocalState()

void visitLocalState ( armarx::statechartmodel::LocalStateCPtr localState )

overrideprotectedvirtual

Implements Visitor.

visitRemoteState()

void visitRemoteState ( armarx::statechartmodel::RemoteStateCPtr remoteState )

overrideprotectedvirtual

Implements Visitor.

---

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

• ArmarXGui/gui-plugins/StatechartEditorPlugin/io/XmlWriter.h
• ArmarXGui/gui-plugins/StatechartEditorPlugin/io/XmlWriter.cpp