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.

Definition at line 61 of file XmlWriter.h.

Constructor & Destructor Documentation

◆ XmlWriter()

XmlWriter ( const VariantInfoPtr & variantInfo)

Definition at line 41 of file XmlWriter.cpp.

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
indentWhether to indent the resulting XML document (for output in a file) or to output unindented XML (for snapshots).
Returns
XML document as a string.

Definition at line 90 of file XmlWriter.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ 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
stateState object that should be serialized to XML.

Definition at line 46 of file XmlWriter.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ visitDynamicRemoteState()

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

Implements Visitor.

Definition at line 129 of file XmlWriter.cpp.

◆ visitEndState()

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

Implements Visitor.

Definition at line 144 of file XmlWriter.cpp.

◆ visitLocalState()

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

Implements Visitor.

Definition at line 99 of file XmlWriter.cpp.

◆ visitRemoteState()

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

Implements Visitor.

Definition at line 113 of file XmlWriter.cpp.


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