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