PLCnext API Documentation
23.6.0.37
Arp
System
Commons
Configuration
ConfigSettings.hpp
1
2
//
3
// Copyright PHOENIX CONTACT Electronics GmbH
4
//
6
#pragma once
7
#include "
Arp/System/Core/Arp.h
"
8
#include "Arp/System/Commons/Xml/IXmlSerializable.hpp"
9
#include <list>
10
11
namespace
Arp
{
namespace
System
{
namespace
Commons {
namespace
Configuration
12
{
13
14
using namespace
Arp::System::Commons::Xml
;
15
16
class
ConfigSettings
:
public
IXmlSerializable
17
{
18
public
:
// construction/destruction
20
ConfigSettings
(
void
) =
default
;
22
ConfigSettings
(
const
ConfigSettings
& arg) =
default
;
24
ConfigSettings
&
operator=
(
const
ConfigSettings
& arg) =
default
;
26
~ConfigSettings
(
void
) =
default
;
27
28
public
:
// static fields
29
static
const
char
* XmlElementName;
30
31
public
:
// getter/setter
32
const
String
& GetPath(
void
)
const
;
33
34
public
:
// IXmlSerializable operations
35
void
ReadXml
(
XmlReader
& reader,
XmlSerializationContext
& context)
override
;
36
void
WriteXml(
XmlWriter
& writer,
XmlSerializationContext
& context)
override
;
37
38
protected
:
// fields
39
String
path;
40
};
41
43
// inline methods of class ConfigSettings
44
45
inline
const
String
& ConfigSettings::GetPath(
void
)
const
46
{
47
return
this->path;
48
}
49
50
}}}}
// end of namespace Arp::System::Commons::Configuration
Arp.h
Arp::BasicString< char8 >
Arp::System::Commons::Configuration::ConfigSettings
Definition:
ConfigSettings.hpp:17
Arp::System::Commons::Configuration::ConfigSettings::ReadXml
void ReadXml(XmlReader &reader, XmlSerializationContext &context) override
ReadXML must be implemented by all classes which should read its context from xml files
Arp::System::Commons::Configuration::ConfigSettings::~ConfigSettings
~ConfigSettings(void)=default
Destructs this instance and frees all resources.
Arp::System::Commons::Configuration::ConfigSettings::operator=
ConfigSettings & operator=(const ConfigSettings &arg)=default
Assignment operator.
Arp::System::Commons::Configuration::ConfigSettings::ConfigSettings
ConfigSettings(const ConfigSettings &arg)=default
Copy constructor.
Arp::System::Commons::Configuration::ConfigSettings::ConfigSettings
ConfigSettings(void)=default
Constructs an ConfigSettings instance.
Arp::System::Commons::Xml::IXmlSerializable
Interface for all classes which should be serializable for xml
Definition:
IXmlSerializable.hpp:18
Arp::System::Commons::Xml::XmlReader
Class to read an XML File. Non buffered reader, can only read forward
Definition:
XmlReader.hpp:25
Arp::System::Commons::Xml::XmlSerializationContext
XML context used during XML reading and writing to hold the context information
Definition:
XmlSerializationContext.hpp:26
Arp::System::Commons::Xml::XmlWriter
Class to write an XML File
Definition:
XmlWriter.hpp:19
Arp::System::Acf::ComponentCategory::System
@ System
System components used by the System, Device, Plc or Io domains.
Arp::System::Commons::Xml
Namespace for classes to read XML files
Definition:
ConfigHeader.hpp:12
Arp
Root namespace for the PLCnext API
Generated on Tue Aug 8 2023 06:35:52 for PLCnext API Documentation by
1.9.4