PLCnext API Documentation
25.0.2.69
Arp
System
Commons
Configuration
IncludeElements.hpp
1
2
//
3
// Copyright Phoenix Contact GmbH & Co. KG
4
//
6
#pragma once
7
#include "
Arp/System/Core/Arp.h
"
8
#include "Arp/System/Commons/Configuration/IncludeElement.hpp"
9
#include "Arp/System/Commons/Xml/XmlReader.hpp"
10
#include "Arp/System/Commons/Xml/XmlSerializationContext.hpp"
11
12
namespace
Arp
{
namespace
System {
namespace
Commons {
namespace
Configuration
13
{
14
15
using
Arp::System::Commons::Xml::XmlReader
;
16
using
Arp::System::Commons::Xml::XmlSerializationContext
;
17
20
class
IncludeElements
21
{
22
public
:
// usings
23
using
Items = std::vector<IncludeElement>;
24
25
public
:
// construction/destruction/assignment
26
IncludeElements
(
void
);
27
explicit
IncludeElements
(
const
Items& items);
28
29
public
:
// setter/getter operations
30
const
Items&
GetItems
(
void
)
const
;
31
void
AddItem
(
const
String
& path,
const
DocumentTraits
& traits);
32
void
AddItem
(
const
IncludeElement
& item);
33
34
public
:
// operations
35
void
ReadItem
(
XmlReader
& reader,
XmlSerializationContext
& context);
36
37
private
:
// methods
38
DocumentTraits
DetermineTraits(
XmlReader
& reader,
const
XmlSerializationContext
& context)
const
;
39
40
private
:
// fields
41
Items items;
42
};
43
44
}}}}
// end of namespace Arp::System::Commons::Configuration
Arp.h
Arp::Base::Core::String
This class represents the Arp String. The implementation is based on std::string.
Definition:
String.hpp:39
Arp::System::Commons::Configuration::IncludeElement
This class contains information of a file included by ConfigurationSettings.
Definition:
IncludeElement.hpp:18
Arp::System::Commons::Configuration::IncludeElements
This class reads and holds items ofIncludeElement.
Definition:
IncludeElements.hpp:21
Arp::System::Commons::Configuration::IncludeElements::ReadItem
void ReadItem(XmlReader &reader, XmlSerializationContext &context)
Reads an include item and stores in item list.
Definition:
IncludeElements.cpp:24
Arp::System::Commons::Configuration::IncludeElements::AddItem
void AddItem(const String &path, const DocumentTraits &traits)
Adds an include item
Definition:
IncludeElements.cpp:63
Arp::System::Commons::Configuration::IncludeElements::GetItems
const Items & GetItems(void) const
Returns all available include items
Definition:
IncludeElements.cpp:53
Arp::System::Commons::Configuration::IncludeElements::IncludeElements
IncludeElements(void)
Constructs an IncludeElements instance.
Arp::System::Commons::Xml::DocumentTraits
This class collects several document traits.
Definition:
DocumentTraits.hpp:20
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:27
Arp
Root namespace for the PLCnext API
Generated on Mon May 12 2025 14:03:50 for PLCnext API Documentation by
1.9.4