PLCnext API Documentation 23.0.2.9
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Static Public Member Functions | List of all members
Arp::System::Rsc::Services::IRscSerializable Class Referenceabstract

Marshalls structure or class data types. Serialize and Deserialize have to marshal fields in the same format and the same order. More...

#include <IRscSerializable.hpp>

Inherited by Arp::Device::Interface::Services::DeviceSettingItem, Arp::Device::Interface::Services::DeviceSettingResult, Arp::Hardware::Nim::Services::LimiterStatistic, Arp::Hardware::Nim::Services::NetloadLimiterSettings, Arp::Hardware::Nim::Services::NetloadLimiterState, Arp::Hardware::Nim::Services::NetloadLimiterStatisticResult, Arp::Io::Axioline::Services::AxioDeviceConfiguration, Arp::Io::Axioline::Services::AxioResult, Arp::Io::Axioline::Services::PdiParam, Arp::Io::Axioline::Services::PdiResult, Arp::Io::Interbus::Services::DeviceConfiguration, Arp::Io::Interbus::Services::IdentifyResult, Arp::Io::Interbus::Services::InitiateResult, Arp::Io::Interbus::Services::InterbusResult, Arp::Io::Interbus::Services::NegativeInitiateResult, Arp::Io::Interbus::Services::ObjectAddress, Arp::Io::Interbus::Services::PositiveInitiateResult, Arp::Io::Interbus::Services::StatusResult, Arp::Io::Profibus::Services::RecordParameters, Arp::Io::Profibus::Services::RecordResult, Arp::Io::Profibus::Services::StationDiagnosisItem, Arp::Io::Profibus::Services::SystemVariables, Arp::Io::ProfinetStack::Controller::Services::API, Arp::Io::ProfinetStack::Controller::Services::APIDifference, Arp::Io::ProfinetStack::Controller::Services::AlarmInfo, Arp::Io::ProfinetStack::Controller::Services::ArConfiguration, Arp::Io::ProfinetStack::Controller::Services::ArDataResult, Arp::Io::ProfinetStack::Controller::Services::ArDifference, Arp::Io::ProfinetStack::Controller::Services::ArInfo, Arp::Io::ProfinetStack::Controller::Services::ArStatisticValue, Arp::Io::ProfinetStack::Controller::Services::ChannelErrorTypeInfo, Arp::Io::ProfinetStack::Controller::Services::ChannelProcessAlarmReasonInfo, Arp::Io::ProfinetStack::Controller::Services::DeviceIdentityInfo, Arp::Io::ProfinetStack::Controller::Services::DiagnosisItem, Arp::Io::ProfinetStack::Controller::Services::DiagnosisSource, Arp::Io::ProfinetStack::Controller::Services::DiagnosticInfo, Arp::Io::ProfinetStack::Controller::Services::DiagnosticResult, Arp::Io::ProfinetStack::Controller::Services::Module, Arp::Io::ProfinetStack::Controller::Services::ModuleDifference, Arp::Io::ProfinetStack::Controller::Services::NodeIdentityInfo, Arp::Io::ProfinetStack::Controller::Services::ProfinetAddress, Arp::Io::ProfinetStack::Controller::Services::RecordParam, Arp::Io::ProfinetStack::Controller::Services::RecordResult, Arp::Io::ProfinetStack::Controller::Services::StandardDiagnosisInformation, Arp::Io::ProfinetStack::Controller::Services::Submodule, Arp::Io::ProfinetStack::Controller::Services::SubmoduleDifference, Arp::Io::ProfinetStack::Controller::Services::UsiDiagnosisInformation, Arp::Plc::Commons::Meta::ArrayDimension, Arp::Plc::Commons::Meta::CustomAttribute, Arp::Plc::Commons::Meta::DataInfo, Arp::Plc::Commons::Meta::DataTag, Arp::Plc::Commons::Meta::TypeIdentifier, Arp::Plc::Commons::Meta::TypeInfo, Arp::Plc::Gds::Services::ForceItem, Arp::Plc::Gds::Services::ReadItem, Arp::Plc::Gds::Services::VariableInfo, Arp::Plc::Gds::Services::WriteItem, Arp::Plc::Retain::Services::BackupResult, Arp::Services::DataLogger::Services::SessionProperty, Arp::Services::DataLogger::Services::TriggerRpnItem, Arp::Services::NotificationLogger::Services::NotificationFilter, Arp::Services::NotificationLogger::Services::NotificationFilter2, Arp::Services::NotificationLogger::Services::StoredNotification, Arp::Services::NotificationLogger::Services::StoredNotification2, Arp::System::Commons::Services::Io::FileSystemEntry, Arp::System::Commons::Services::Io::FileSystemTraitsEntry, Arp::System::Commons::Services::Io::ReadFileData, Arp::System::Commons::Services::Io::ReadFileInfo, Arp::System::Commons::Services::Io::SpaceInfo, Arp::System::Commons::Services::Io::TraitItem, Arp::System::Commons::Services::Io::WriteFileData, Arp::System::Commons::Services::Security::IdentityValidationResult, Arp::System::Nm::Notification, Arp::System::Nm::NotificationRegistrationInfo, and Arp::System::Um::Services::ChannelInformation.

Public Member Functions

virtual ~IRscSerializable ()=default
 default destructor
 
virtual void Serialize (RscWriter &writer) const =0
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
virtual void Deserialize (RscReader &reader)=0
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 

Static Public Member Functions

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

Detailed Description

Marshalls structure or class data types. Serialize and Deserialize have to marshal fields in the same format and the same order.

Member Function Documentation

◆ Deserialize()

virtual void Arp::System::Rsc::Services::IRscSerializable::Deserialize ( RscReader reader)
pure virtual

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

Parameters
readerReference to RscReader.

Implemented in Arp::System::Nm::Notification, Arp::System::Nm::NotificationRegistrationInfo, Arp::Device::Interface::Services::DeviceSettingItem, Arp::Device::Interface::Services::DeviceSettingResult, Arp::Hardware::Nim::Services::LimiterStatistic, Arp::Hardware::Nim::Services::NetloadLimiterSettings, Arp::Hardware::Nim::Services::NetloadLimiterState, Arp::Hardware::Nim::Services::NetloadLimiterStatisticResult, Arp::Io::Axioline::Services::AxioDeviceConfiguration, Arp::Io::Axioline::Services::AxioResult, Arp::Io::Axioline::Services::PdiParam, Arp::Io::Axioline::Services::PdiResult, Arp::Io::Interbus::Services::DeviceConfiguration, Arp::Io::Interbus::Services::IdentifyResult, Arp::Io::Interbus::Services::InitiateResult, Arp::Io::Interbus::Services::InterbusResult, Arp::Io::Interbus::Services::NegativeInitiateResult, Arp::Io::Interbus::Services::ObjectAddress, Arp::Io::Interbus::Services::PositiveInitiateResult, Arp::Io::Interbus::Services::StatusResult, Arp::Io::Profibus::Services::RecordParameters, Arp::Io::Profibus::Services::RecordResult, Arp::Io::Profibus::Services::StationDiagnosisItem, Arp::Io::Profibus::Services::SystemVariables, Arp::Io::ProfinetStack::Controller::Services::AlarmInfo, Arp::Io::ProfinetStack::Controller::Services::API, Arp::Io::ProfinetStack::Controller::Services::APIDifference, Arp::Io::ProfinetStack::Controller::Services::ArConfiguration, Arp::Io::ProfinetStack::Controller::Services::ArDataResult, Arp::Io::ProfinetStack::Controller::Services::ArDifference, Arp::Io::ProfinetStack::Controller::Services::ArInfo, Arp::Io::ProfinetStack::Controller::Services::ArStatisticValue, Arp::Io::ProfinetStack::Controller::Services::ChannelErrorTypeInfo, Arp::Io::ProfinetStack::Controller::Services::ChannelProcessAlarmReasonInfo, Arp::Io::ProfinetStack::Controller::Services::DeviceIdentityInfo, Arp::Io::ProfinetStack::Controller::Services::DiagnosisItem, Arp::Io::ProfinetStack::Controller::Services::DiagnosisSource, Arp::Io::ProfinetStack::Controller::Services::DiagnosticInfo, Arp::Io::ProfinetStack::Controller::Services::DiagnosticResult, Arp::Io::ProfinetStack::Controller::Services::Module, Arp::Io::ProfinetStack::Controller::Services::ModuleDifference, Arp::Io::ProfinetStack::Controller::Services::NodeIdentityInfo, Arp::Io::ProfinetStack::Controller::Services::ProfinetAddress, Arp::Io::ProfinetStack::Controller::Services::RecordParam, Arp::Io::ProfinetStack::Controller::Services::RecordResult, Arp::Io::ProfinetStack::Controller::Services::StandardDiagnosisInformation, Arp::Io::ProfinetStack::Controller::Services::Submodule, Arp::Io::ProfinetStack::Controller::Services::SubmoduleDifference, Arp::Io::ProfinetStack::Controller::Services::UsiDiagnosisInformation, Arp::Plc::Commons::Meta::ArrayDimension, Arp::Plc::Commons::Meta::ChildTypeInfo, Arp::Plc::Commons::Meta::CustomAttribute, Arp::Plc::Commons::Meta::DataInfo, Arp::Plc::Commons::Meta::DataTag, Arp::Plc::Commons::Meta::TypeIdentifier, Arp::Plc::Commons::Meta::TypeInfo, Arp::Plc::Gds::Services::ForceItem, Arp::Plc::Gds::Services::ReadItem, Arp::Plc::Gds::Services::VariableInfo, Arp::Plc::Gds::Services::WriteItem, Arp::Plc::Retain::Services::BackupResult, Arp::Services::DataLogger::Services::SessionProperty, Arp::Services::DataLogger::Services::TriggerRpnItem, Arp::Services::NotificationLogger::Services::NotificationFilter, Arp::Services::NotificationLogger::Services::NotificationFilter2, Arp::Services::NotificationLogger::Services::StoredNotification, Arp::Services::NotificationLogger::Services::StoredNotification2, Arp::System::Commons::Services::Io::FileSystemEntry, Arp::System::Commons::Services::Io::FileSystemTraitsEntry, Arp::System::Commons::Services::Io::ReadFileData, Arp::System::Commons::Services::Io::ReadFileInfo, Arp::System::Commons::Services::Io::SpaceInfo, Arp::System::Commons::Services::Io::TraitItem, Arp::System::Commons::Services::Io::WriteFileData, Arp::System::Commons::Services::Security::IdentityValidationResult, and Arp::System::Um::Services::ChannelInformation.

◆ GetFieldCount()

static size_t Arp::System::Rsc::Services::IRscSerializable::GetFieldCount ( void  )
static

Returns the count of fields of the struct type

Returns
Count of fields.

This is a policy operation and must be implemented in any struct as static operation.

◆ Serialize()

virtual void Arp::System::Rsc::Services::IRscSerializable::Serialize ( RscWriter writer) const
pure virtual

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

Parameters
writerReference to RscWriter

Implemented in Arp::System::Nm::Notification, Arp::System::Nm::NotificationRegistrationInfo, Arp::Device::Interface::Services::DeviceSettingItem, Arp::Device::Interface::Services::DeviceSettingResult, Arp::Hardware::Nim::Services::LimiterStatistic, Arp::Hardware::Nim::Services::NetloadLimiterSettings, Arp::Hardware::Nim::Services::NetloadLimiterState, Arp::Hardware::Nim::Services::NetloadLimiterStatisticResult, Arp::Io::Axioline::Services::AxioDeviceConfiguration, Arp::Io::Axioline::Services::AxioResult, Arp::Io::Axioline::Services::PdiParam, Arp::Io::Axioline::Services::PdiResult, Arp::Io::Interbus::Services::DeviceConfiguration, Arp::Io::Interbus::Services::IdentifyResult, Arp::Io::Interbus::Services::InitiateResult, Arp::Io::Interbus::Services::InterbusResult, Arp::Io::Interbus::Services::NegativeInitiateResult, Arp::Io::Interbus::Services::ObjectAddress, Arp::Io::Interbus::Services::PositiveInitiateResult, Arp::Io::Interbus::Services::StatusResult, Arp::Io::Profibus::Services::RecordParameters, Arp::Io::Profibus::Services::RecordResult, Arp::Io::Profibus::Services::StationDiagnosisItem, Arp::Io::Profibus::Services::SystemVariables, Arp::Io::ProfinetStack::Controller::Services::AlarmInfo, Arp::Io::ProfinetStack::Controller::Services::API, Arp::Io::ProfinetStack::Controller::Services::APIDifference, Arp::Io::ProfinetStack::Controller::Services::ArConfiguration, Arp::Io::ProfinetStack::Controller::Services::ArDataResult, Arp::Io::ProfinetStack::Controller::Services::ArDifference, Arp::Io::ProfinetStack::Controller::Services::ArInfo, Arp::Io::ProfinetStack::Controller::Services::ArStatisticValue, Arp::Io::ProfinetStack::Controller::Services::ChannelErrorTypeInfo, Arp::Io::ProfinetStack::Controller::Services::ChannelProcessAlarmReasonInfo, Arp::Io::ProfinetStack::Controller::Services::DeviceIdentityInfo, Arp::Io::ProfinetStack::Controller::Services::DiagnosisItem, Arp::Io::ProfinetStack::Controller::Services::DiagnosisSource, Arp::Io::ProfinetStack::Controller::Services::DiagnosticInfo, Arp::Io::ProfinetStack::Controller::Services::DiagnosticResult, Arp::Io::ProfinetStack::Controller::Services::Module, Arp::Io::ProfinetStack::Controller::Services::ModuleDifference, Arp::Io::ProfinetStack::Controller::Services::NodeIdentityInfo, Arp::Io::ProfinetStack::Controller::Services::ProfinetAddress, Arp::Io::ProfinetStack::Controller::Services::RecordParam, Arp::Io::ProfinetStack::Controller::Services::RecordResult, Arp::Io::ProfinetStack::Controller::Services::StandardDiagnosisInformation, Arp::Io::ProfinetStack::Controller::Services::Submodule, Arp::Io::ProfinetStack::Controller::Services::SubmoduleDifference, Arp::Io::ProfinetStack::Controller::Services::UsiDiagnosisInformation, Arp::Plc::Commons::Meta::ArrayDimension, Arp::Plc::Commons::Meta::ChildTypeInfo, Arp::Plc::Commons::Meta::CustomAttribute, Arp::Plc::Commons::Meta::DataInfo, Arp::Plc::Commons::Meta::DataTag, Arp::Plc::Commons::Meta::TypeIdentifier, Arp::Plc::Commons::Meta::TypeInfo, Arp::Plc::Gds::Services::ForceItem, Arp::Plc::Gds::Services::ReadItem, Arp::Plc::Gds::Services::VariableInfo, Arp::Plc::Gds::Services::WriteItem, Arp::Plc::Retain::Services::BackupResult, Arp::Services::DataLogger::Services::SessionProperty, Arp::Services::DataLogger::Services::TriggerRpnItem, Arp::Services::NotificationLogger::Services::NotificationFilter, Arp::Services::NotificationLogger::Services::NotificationFilter2, Arp::Services::NotificationLogger::Services::StoredNotification, Arp::Services::NotificationLogger::Services::StoredNotification2, Arp::System::Commons::Services::Io::FileSystemEntry, Arp::System::Commons::Services::Io::FileSystemTraitsEntry, Arp::System::Commons::Services::Io::ReadFileData, Arp::System::Commons::Services::Io::ReadFileInfo, Arp::System::Commons::Services::Io::SpaceInfo, Arp::System::Commons::Services::Io::TraitItem, Arp::System::Commons::Services::Io::WriteFileData, Arp::System::Commons::Services::Security::IdentityValidationResult, and Arp::System::Um::Services::ChannelInformation.


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