PLCnext API Documentation 25.0.2.69
ConfigSettings.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/System/Commons/Xml/IXmlSerializable.hpp"
9#include "Arp/System/Commons/Xml/DocumentTraits.hpp"
10#include <list>
11
12namespace Arp { namespace System { namespace Commons { namespace Configuration
13{
14
15using namespace Arp::System::Commons::Xml;
16
18{
19public: // construction/destruction
21 ConfigSettings(void) = default;
23 ConfigSettings(const ConfigSettings& arg) = default;
25 ConfigSettings& operator=(const ConfigSettings& arg) = default;
27 ~ConfigSettings(void) = default;
28
29public: // static fields
30 static const char* XmlElementName;
31
32public: // getter/setter
33 const String& GetPath(void)const;
34 const DocumentTraits& GetTraits(void)const;
35
36public: // IXmlSerializable operations
37 void ReadXml(XmlReader& reader, XmlSerializationContext& context)override;
38 void WriteXml(XmlWriter& writer, XmlSerializationContext& context)override;
39
40protected: // fields
41 String path;
42 DocumentTraits traits;
43};
44
45}}}} // end of namespace Arp::System::Commons::Configuration
This class represents the Arp String. The implementation is based on std::string.
Definition: String.hpp:39
void ReadXml(XmlReader &reader, XmlSerializationContext &context) override
ReadXML must be implemented by all classes which should read its context from xml files
Definition: ConfigSettings.cpp:23
~ConfigSettings(void)=default
Destructs this instance and frees all resources.
ConfigSettings & operator=(const ConfigSettings &arg)=default
Assignment operator.
ConfigSettings(const ConfigSettings &arg)=default
Copy constructor.
ConfigSettings(void)=default
Constructs an ConfigSettings instance.
This class collects several document traits.
Definition: DocumentTraits.hpp:20
Interface for all classes which should be serializable for xml
Definition: IXmlSerializable.hpp:18
Class to read an XML File. Non buffered reader, can only read forward
Definition: XmlReader.hpp:25
XML context used during XML reading and writing to hold the context information
Definition: XmlSerializationContext.hpp:27
Class to write an XML File
Definition: XmlWriter.hpp:19
Namespace for classes to read XML files
Root namespace for the PLCnext API