PLCnext API Documentation  22.6.0.43
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::Io::ProfinetStack::Controller::Services::SubmoduleDifference Class Reference

Submodule data with differences More...

#include <SubmoduleDifference.hpp>

Inheritance diagram for Arp::Io::ProfinetStack::Controller::Services::SubmoduleDifference:
Inheritance graph

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

uint32 NodeID = 0
 Node ID More...
 
uint16 Subslot = 0
 Subslot number More...
 
uint32 IdentNumber = 0
 Submodule IdentNumber More...
 
uint16 State = 0
 Submodule state. It contains multiple information which have to be read by applying different masks on the value. More...
 

Detailed Description

Submodule data with differences

Member Function Documentation

◆ Deserialize()

void Arp::Io::ProfinetStack::Controller::Services::SubmoduleDifference::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::Io::ProfinetStack::Controller::Services::SubmoduleDifference::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

◆ IdentNumber

uint32 Arp::Io::ProfinetStack::Controller::Services::SubmoduleDifference::IdentNumber = 0

Submodule IdentNumber

◆ NodeID

uint32 Arp::Io::ProfinetStack::Controller::Services::SubmoduleDifference::NodeID = 0

Node ID

◆ State

uint16 Arp::Io::ProfinetStack::Controller::Services::SubmoduleDifference::State = 0

Submodule state. It contains multiple information which have to be read by applying different masks on the value.

If the highest bit is set, the state has to be intrepreted the following way:

MaskValueDescription
0x0007 (Additional Info)0x0000No additional info. None of the options defined for this field are activated.
0x0001Takeover is not allowed. This submodule is not available for takeover by IOSAR.
0x0008 (Advice)0x0000There is no advice available for this submodule.
0x0008At least one Advice is available for this submodule.
0x0010 (Maintenance required)0x0000There is no maintenance required for this submodule.
0x0010At least one requirement for maintenance is available for this submodule.
0x0020 (Maintenance demanded)0x0000There is no maintenance demanded for this submodule.
0x0020At least one demand for maintenance is available for this submodule.
0x0040 (Fault)0x0000There is no Fault available for this submodule.
0x0040At least one Fault is available for this submodule. There is diagnosis data available for this submodule. The diagnosis data can be read using the corresponding records or IDiagnosisQueryService.
0x0780 (AR Info)0x0000This AR is owner of the submodule.
0x0080Application Ready pending. This AR is owner of the submodule but it is blocked (e.g.parameter checking pending).
0x0100This AR is not owner of the submodule. It is locked by superordinated means.
0x0180This AR is not owner of the submodule. It is owned by another IOAR.
0x0200This AR is not owner of the submodule. It is owned by another IOSAR.
0x7800 (Ident Info)0x0000OK.
0x0800Submodule is not the same as configured, but compatible.
0x1000Wrong submodule.
0x1800No submodule.

If the highest bit is not set, the state has to be intrepreted the following way:

MaskValueDescription
0x7FFF (Detail)0x0000No submodule.
0x0001Wrong submodule.
0x0002This AR is not owner of the submodule. It is owned by an other IOAR.
0x0004Application Ready pending.
0x0007Submodule is not the same as configured, but compatible.

◆ Subslot

uint16 Arp::Io::ProfinetStack::Controller::Services::SubmoduleDifference::Subslot = 0

Subslot number


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