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

A force item structure. More...

#include <ForceItem.hpp>

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

Public Member Functions

 ForceItem (void)
 Constructs an ForceItem instance.
 
 ForceItem (const RscString< 512 > &variableName, const RscVariant< 512 > &forceValue)
 Constructs an ForceItem 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 > VariableName
 The instance path of the forced item.
 
RscVariant< 512 > ForceValue
 The value of the forced item.
 

Detailed Description

A force item structure.

Member Function Documentation

◆ Deserialize()

void Arp::Plc::Gds::Services::ForceItem::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::ForceItem::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::ForceItem::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: