PLCnext API Documentation  20.6.0.30321
Public Types | Public Member Functions | Protected Member Functions | List of all members
Arp::System::Commons::Xml::MultiXmlConfigDocument Class Reference

special version of XmlConfigDocument to include xml configuration data from other xml files inside a configuration file More...

#include <MultiXmlConfigDocument.hpp>

Inheritance diagram for Arp::System::Commons::Xml::MultiXmlConfigDocument:
Inheritance graph

Public Types

typedef XmlConfigDocument Base
 
typedef std::deque< StringFiles
 
typedef std::list< StringIncludedFiles
 

Public Member Functions

 MultiXmlConfigDocument (const String &documentXmlElementName, IXmlSerializable &content)
 Constructs an MultiXmlConfigDocument instance. More...
 
virtual ~MultiXmlConfigDocument (void)=default
 Destructs this instance and frees all resouces. More...
 
void AddFile (const String &path)
 
- Public Member Functions inherited from Arp::System::Commons::Xml::XmlConfigDocument
 XmlConfigDocument (const String &documentXmlElementName, IXmlSerializable &content)
 Constructs an XmlConfigDocument instance. More...
 
 XmlConfigDocument (MultiXmlConfigDocument &rootDocument, IXmlSerializable &content)
 Constructs an XmlConfigDocument instance. More...
 
virtual ~XmlConfigDocument (void)=default
 Destructs this instance and frees all resouces. More...
 
const StringGetPath (void) const
 Returns the path to the current file loaded by this document More...
 
IXmlSerializableGetContent (void)
 summary>Returns a pointer to the root document for MultiXmlConfigDocument More...
 
MultiXmlConfigDocumentGetRootDocument (void)
 summary>Returns the recend implemented schema version, used by XmlSerializationContext More...
 
Version GetRecentVersion (void) const
 
void Load (const String &documentPath)
 loads and parses the xml document from documentPath More...
 
bool TryLoad (const String &documentPath)
 summary>saves the content xml encoded to documentPath More...
 
void Save (const String &documentPath)
 summary>saves the content xml encoded to the file the document was loaded from More...
 
void Save (void)
 

Protected Member Functions

void ReadDocument (XmlReader &reader) override
 

Additional Inherited Members

- Protected Attributes inherited from Arp::System::Commons::Xml::XmlConfigDocument
MultiXmlConfigDocumentpRootDoc
 
IXmlSerializablecontent
 
String documentXmlElementName
 
String path
 
Version recentVersion
 

Detailed Description

special version of XmlConfigDocument to include xml configuration data from other xml files inside a configuration file

files can be included by code> Includes> /Includes> /code>

Constructor & Destructor Documentation

◆ MultiXmlConfigDocument()

Arp::System::Commons::Xml::MultiXmlConfigDocument::MultiXmlConfigDocument ( const String documentXmlElementName,
IXmlSerializable content 
)
inline

Constructs an MultiXmlConfigDocument instance.

param name="documentXmlElementName">name of the root element of the document

param name="content">class which implements IXmlSerializable and can parse documentXmlElementName</param

◆ ~MultiXmlConfigDocument()

virtual Arp::System::Commons::Xml::MultiXmlConfigDocument::~MultiXmlConfigDocument ( void  )
virtualdefault

Destructs this instance and frees all resouces.


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