PLCnext API Documentation 26.0.1.58
VariableQueryResult.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/JRsc/Commons/JRsc.hpp"
10#include "Arp/Base/Rsc/Commons/RscSerializable.hpp"
11#include "Arp/Plc/Meta/Services/Result.hpp"
12#include "Arp/Plc/Meta/Services/VariableBrowseHandle.hpp"
13#include "Arp/Plc/Meta/Services/VariableInformation.hpp"
14
15// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
16
18{
19
20using namespace Arp;
21using namespace Arp::Base::Rsc::Commons;
22using namespace Arp::Base::Rsc::Commons::Services;
23using namespace Arp::Base::JRsc::Commons;
24
26class ARP_EXPORT VariableQueryResult : public RscSerializable
27{
28public: // construction/destruction
30 VariableQueryResult(Result resultCode, const VariableInformation& variableInfo, const VariableBrowseHandle& browseHandle);
31
32public: // Properties
34 Result ResultCode = static_cast<Result>(0);
35
38
41
42public: // Rsc operations
43 void Serialize(RscWriter& writer)const;
44 void Deserialize(RscReader& reader);
45 void Serialize(JRscWriter& writer)const;
46 void Deserialize(JRscReader& reader);
47 static size_t GetFieldCount(void);
48};
49
50} // end of namespace Arp::Plc::Meta::Services
Any custom struct type which is intended to be marshalled in a Rsc serialization context,...
Definition: RscSerializable.hpp:35
Reads marshaled data of RSC services.
Definition: RscReader.hpp:34
Writes marshalled data of RSC services.
Definition: RscWriter.hpp:34
VariableBrowseHandle contains all information to efficiently identify a node in the variables tree
Definition: VariableBrowseHandle.hpp:26
Porvides information about one variable
Definition: VariableInformation.hpp:32
Result for queries for a variable
Definition: VariableQueryResult.hpp:27
VariableBrowseHandle BrowseHandle
Reference to this node. Needed to browse its children
Definition: VariableQueryResult.hpp:40
VariableInformation VariableInfo
Description of the variable
Definition: VariableQueryResult.hpp:37
VariableQueryResult(void)
Constructs an VariableQueryResult instance.
Namespace for the JSON RSC extension
Namespace for services of the Meta component
Result
Enumeration of possible results
Definition: Result.hpp:17
Root namespace for the PLCnext API