C++ Klasse Vullen vanuit XML met IXMLSerializable in PLCnext
Samenvatting
Wist u dat de PLCnext Common Classes ingebouwde ondersteuning hebben voor XML-serialisatie? Dit artikel laat zien hoe u de IXmlSerializable-interface kunt gebruiken om de gegevens in een C++-klasse te vullen.
U kunt de interfacebeschrijving vinden in de API-documentatie van de PLCnext Common Classes.
Vereisten
Dit artikel is geschreven met de volgende setup:
PLCnext Firmware: 2020.6 LTS PLCnext C++ SDK voor Linux 64-bit 2020.6 LTS
De Gegevens
We willen onze klasse vullen met het volgende configuratiebestand.
<?xml version="1.0" encoding="UTF-8"?> <MyConfigDocument schemaVersion="1.0"> <Server dnsName="server.domain.tld" /> <FileList> <File path="$ARP_DATA_DIR$/Services/MyComponent/file1.txt" /> <File path="$ARP_DATA_DIR$/Services/MyComponent/file2.txt" /> </FileList> </MyConfigDocument>
De $ARP_DATA_DIR$-notatie is een placeholder voor een omgevingsvariabele, in dit geval ARP_DATA_DIR. U kunt de gedefinieerde Arp-omgevingsvariabelen vinden in uw apparaatinstellingenbestand op de target /etc/plcnext/Device.acf.settings.
Om de gegevens uit een XML-bestand te kunnen lezen, moeten we de IXMLSerializable-interface implementeren voor onze klasse. Om het simpel te houden heeft onze klasse maar twee data-elementen: een DNS-naam en een vector met bestandspaden.
#pragma once
#include "Arp/System/Core/Arp.h"
#include "Arp/System/Commons/Xml/IXmlSerializable.hpp"
#include <vector>
namespace MyComponent {
class MyConfiguration : public Arp::System::Commons::Xml::IXmlSerializable {
public:
MyConfiguration() = default;
~MyConfiguration() = default;
// IXMLSerializable interface
public:
void ReadXml(Arp::System::Commons::Xml::XmlReader& reader, Arp::System::Commons::Xml::XmlSerializationContext& context) override;
void WriteXml(Arp::System::Commons::Xml::XmlWriter& writer, Arp::System::Commons::Xml::XmlSerializationContext& context) override;
// De data
public:
Arp::String DnsName{""};
std::vector<Arp::String> FileList;
// Ondersteunende methodes
private:
void readFileList(Arp::System::Commons::Xml::XmlReader& reader, Arp::System::Commons::Xml::XmlSerializationContext& context);
void readFile(Arp::System::Commons::Xml::XmlReader& reader, Arp::System::Commons::Xml::XmlSerializationContext& context);
};
} // namespace MyComponent
Implementatie
We moeten de ReadXml- en WriteXml-methodes implementeren.
De WriteXml-methode is eenvoudig, we willen niet schrijven, we willen alleen de gegevens uit het XML-bestand lezen. De ReadXml-methode wordt aangeroepen als we de gegevens uit het XML-bestand willen lezen.
#include "MyConfiguration.hpp"
namespace MyComponent {
void MyConfiguration::WriteXml(Arp::System::Commons::Xml::XmlWriter& writer, Arp::System::Commons::Xml::XmlSerializationContext& context) {
// geen operatie.
return;
}
void MyConfiguration::ReadXml(Arp::System::Commons::Xml::XmlReader& reader, Arp::System::Commons::Xml::XmlSerializationContext& context) {
Arp::String elementName;
while (reader.TryReadStartElement(elementName)) {
if (elementName == Arp::System::Commons::Xml::XmlSerializationContext::IncludesXmlName) {
context.ReadIncludesElement(reader);
} else if (elementName == "Server") {
this->DnsName = reader.GetAttributeValue<Arp::String>("dnsName");
reader.ReadEndElement();
} else if (elementName == "FileList") {
this->readFileList(reader, context);
} else {
context.InvalidXmlElementOccurs(reader, elementName);
reader.ReadEndElement();
}
}
}
void MyConfiguration::readFileList(Arp::System::Commons::Xml::XmlReader& reader, Arp::System::Commons::Xml::XmlSerializationContext& context) {
if (reader.IsEmptyElement()){
return;
}
if (reader.ReadToDescendant("File")) {
this->readFile(reader, context);
while (reader.ReadToNextSibling("File")) {
this->readFile(reader, context);
}
} else {
reader.ReadEndElement();
}
}
void MyConfiguration::readFile(Arp::System::Commons::Xml::XmlReader& reader, Arp::System::Commons::Xml::XmlSerializationContext& context) {
// Gebruik 'context.ResolvePath' om placeholders in het pad te vervangen.
auto file = Arp::String(context.ResolvePath(reader.GetAttributeValue<Arp::String>("path")));
this->FileList.push_back(file);
reader.ReadEndElement();
}
} // namespace MyComponent
De Gegevens Lezen
We kunnen nu onze klasse gebruiken met de XMLConfigDocument-klasse in de LoadConfig-methode om de gegevens in onze klasse te laden.
void MyComponent::LoadConfig() {
// laad projectconfiguratie hier
using namespace Arp::System::Commons;
this->log.Info("LoadConfig");
// Eerste argument moet overeenkomen met de XML-root elementnaam.
// Onze MyConfiguration-instantie this->config wordt gevuld.
Xml::XmlConfigDocument configDoc("MyConfigDocument", this->config);
if (!Io::File::Exists(this->settingsPath)) {
this->log.Error("Configuratiebestand '{}' bestaat niet.", this->settingsPath);
return;
}
try {
configDoc.Load(this->settingsPath);
} catch (const Arp::Exception& e) {
this->log.Error(e.GetMessage());
throw InvalidConfigException(e.GetMessage());
}
}
Industriële technologie
- De Command-Line Interface Gebruiken met SPICE
- Hoe Technologie Productie Transformeert: Van 3D-printen Tot Digital Twins
- De Juiste Explosieveilige Motor Kiezen: Een Uitgebreide Gids
- Stempeltypen in de Productie: Stansen, Trekken en Gieten Uitgelegd
- Hoe testpunten PCB-testen en productie-efficiëntie verbeteren
- Hoe automatisering manufacturing transformeert: Efficiëntie verhogen & kosten snijden
- De voordelen van Augmented Reality in Industrie 4.0
- Java BufferedReader: Efficiënte karakter-stream-afhandeling
- Java-bestandsbewerkingen onder de knie krijgen met java.io – Aanmaken, lezen, schrijven en verwijderen
- Interface vs Abstracte Klasse in Java: De Juiste Abstractie Kiezen
- Java Interfaces begrijpen: Definities, Gebruik en Best Practices