PLCnext API Documentation  22.9.0.33
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::Plc::Gds::Services::VariableInfo Class Reference

Describes a subscribed variable. More...

#include <VariableInfo.hpp>

Inheritance diagram for Arp::Plc::Gds::Services::VariableInfo:
Inheritance graph

Public Types

using DataType = Arp::Plc::Commons::DataType
 

Public Member Functions

void Serialize (RscWriter &writer) const override
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
void Deserialize (RscReader &reader) override
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 
- Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable
virtual ~IRscSerializable ()=default
 default destructor More...
 

Static Public Member Functions

static constexpr size_t GetFieldCount (void)
 
- Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscSerializable
static size_t GetFieldCount (void)
 Returns the count of fields of the struct type More...
 

Public Attributes

RscString< 512 > Name
 Full name of the variable. More...
 
DataType Type = static_cast<DataType>(0)
 Arp.Plc.Gds.Services.VariableInfo.Type of the variable. More...
 

Detailed Description

Describes a subscribed variable.

The structure includes the full name of the variable e.g.: ComponentName-1/ProgramName-1.Variable_Name and the associated type (Arp.Plc.Commons.DataType) e.g.: Arp.Plc.Commons.DataType.Int8.

Member Function Documentation

◆ Deserialize()

void Arp::Plc::Gds::Services::VariableInfo::Deserialize ( RscReader reader)
inlineoverridevirtual

Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.

Parameters
readerReference to RscReader.

Implements Arp::System::Rsc::Services::IRscSerializable.

◆ Serialize()

void Arp::Plc::Gds::Services::VariableInfo::Serialize ( RscWriter writer) const
inlineoverridevirtual

Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.

Parameters
writerReference to RscWriter

Implements Arp::System::Rsc::Services::IRscSerializable.

Member Data Documentation

◆ Name

RscString<512> Arp::Plc::Gds::Services::VariableInfo::Name

Full name of the variable.

◆ Type

DataType Arp::Plc::Gds::Services::VariableInfo::Type = static_cast<DataType>(0)

The documentation for this class was generated from the following file: