PLCnext API Documentation 26.0.1.58
VariableInformation.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 <vector>
12#include "Arp/Base/Rsc/Commons/RscString.hxx"
13#include "Arp/Plc/Meta/Commons/DataType.hpp"
14#include "Arp/Plc/Meta/Commons/StandardAttribute.hpp"
15#include "Arp/Plc/Meta/Services/ArrayDimension.hpp"
16#include "Arp/Plc/Meta/Services/BitSize.hpp"
17#include "Arp/Plc/Meta/Services/CustomAttribute.hpp"
18#include "Arp/Plc/Meta/Services/VariableTypeIdentifier.hpp"
19
20// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED
21
23{
24
25using namespace Arp;
26using namespace Arp::Base::Rsc::Commons;
27using namespace Arp::Base::Rsc::Commons::Services;
28using namespace Arp::Base::JRsc::Commons;
29
31class ARP_EXPORT VariableInformation : public RscSerializable
32{
33public: //usings
36
37public: // construction/destruction
39 VariableInformation(const RscString<512>& name, DataType type, const VariableTypeIdentifier& typeId, const BitSize& size, const std::vector<ArrayDimension>& arrayDimensions, StandardAttribute standardAttributes, const std::vector<CustomAttribute>& customAttributes);
40
41public: // Properties
44
46 DataType Type = static_cast<DataType>(0);
47
50
53
55 std::vector<ArrayDimension> ArrayDimensions;
56
59
61 std::vector<CustomAttribute> CustomAttributes;
62
63public: // Rsc operations
64 void Serialize(RscWriter& writer)const;
65 void Deserialize(RscReader& reader);
66 void Serialize(JRscWriter& writer)const;
67 void Deserialize(JRscReader& reader);
68 static size_t GetFieldCount(void);
69};
70
71} // 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
Collection of StandardAttribute flags
Definition: StandardAttributes.hpp:16
Provide size information.
Definition: BitSize.hpp:24
Porvides information about one variable
Definition: VariableInformation.hpp:32
RscString< 512 > Name
Name of the variable
Definition: VariableInformation.hpp:43
std::vector< CustomAttribute > CustomAttributes
Custom attributes
Definition: VariableInformation.hpp:61
BitSize Size
Size of one element of the type
Definition: VariableInformation.hpp:52
VariableInformation(void)
Constructs an VariableInformation instance.
std::vector< ArrayDimension > ArrayDimensions
Array information
Definition: VariableInformation.hpp:55
VariableTypeIdentifier TypeId
Type name of a complex type
Definition: VariableInformation.hpp:49
Identifies a complex type
Definition: VariableTypeIdentifier.hpp:25
Namespace for the JSON RSC extension
StandardAttribute
Standard attributes to types
Definition: StandardAttribute.hpp:18
DataType
This enum represents the data type of a variable.
Definition: DataType.hpp:15
Namespace for services of the Meta component
Root namespace for the PLCnext API