PLCnext API Documentation 26.0.1.58
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::Plc::Meta::Services::VariableInformation Class Reference

Porvides information about one variable More...

#include <VariableInformation.hpp>

Inheritance diagram for Arp::Plc::Meta::Services::VariableInformation:
Inheritance graph

Public Types

using DataType = Arp::Plc::Meta::Commons::DataType
 
using StandardAttribute = Arp::Plc::Meta::Commons::StandardAttribute
 

Public Member Functions

 VariableInformation (void)
 Constructs an VariableInformation instance.
 
 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)
 Constructs an VariableInformation 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...
 
void Serialize (JRscWriter &writer) const
 Serializes the datatype. All fields of the datatype have to be serialized in use of JRscWriter. More...
 
void Deserialize (JRscReader &reader)
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of JRscReader. 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
 Name of the variable
 
DataType Type = static_cast<DataType>(0)
 Data type of the variable
 
VariableTypeIdentifier TypeId
 Type name of a complex type
 
BitSize Size
 Size of one element of the type
 
std::vector< ArrayDimensionArrayDimensions
 Array information
 
StandardAttribute StandardAttributes = static_cast<StandardAttribute>(0)
 Standard attributes
 
std::vector< CustomAttributeCustomAttributes
 Custom attributes
 

Detailed Description

Porvides information about one variable

Member Function Documentation

◆ Deserialize() [1/2]

void Arp::Plc::Meta::Services::VariableInformation::Deserialize ( JRscReader &  reader)

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

Parameters
readerReference to RscReader.

◆ Deserialize() [2/2]

void Arp::Plc::Meta::Services::VariableInformation::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::Meta::Services::VariableInformation::GetFieldCount ( void  )
static

Returns the count of fields

Returns
Count of fields.

The field count is used for serialization via Rsc

◆ Serialize() [1/2]

void Arp::Plc::Meta::Services::VariableInformation::Serialize ( JRscWriter &  writer) const

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

Parameters
writerReference to RscWriter

◆ Serialize() [2/2]

void Arp::Plc::Meta::Services::VariableInformation::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: