PLCnext API Documentation 25.0.2.69
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

 VariableInfo (void)
 Constructs an VariableInfo instance.
 
 VariableInfo (const RscString< 512 > &name, DataType type)
 Constructs an VariableInfo instance.
 
void Serialize (RscWriter &writer) const
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
void Deserialize (RscReader &reader)
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 
- Public Member Functions inherited from Arp::Base::Rsc::Commons::RscSerializable
 RscSerializable (void)=default
 The default constructor.
 

Static Public Member Functions

static size_t GetFieldCount (void)
 Returns the count of fields More...
 

Public Attributes

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

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)

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

Parameters
readerReference to RscReader.

◆ GetFieldCount()

size_t Arp::Plc::Gds::Services::VariableInfo::GetFieldCount ( void  )
static

Returns the count of fields

Returns
Count of fields.

The field count is used for serialization via Rsc

◆ Serialize()

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

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

Parameters
writerReference to RscWriter

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