PLCnext API Documentation 23.6.0.37
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::Io::ProfinetStack::Controller::Services::AlarmInfo Class Reference

This structure contains all information about a received alarm. For more information read the PROFINET specification. More...

#include <AlarmInfo.hpp>

Inheritance diagram for Arp::Io::ProfinetStack::Controller::Services::AlarmInfo:
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
 
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 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

boolean NewAlarmReceived = false
 Flag is set, if new alarm has been received
 
uint32 Id = 0
 Node id
 
uint16 BlockType = 0
 Type of alarm information
 
uint16 BlockLength = 0
 Length of alarm information in bytes
 
uint16 BlockVersion = 0
 Version of alarm information
 
uint16 AlarmType = 0
 Type of alarm More...
 
uint32 Api = 0
 Application Process Identifier
 
uint16 Slot = 0
 Slot number
 
uint16 Subslot = 0
 Subslot number
 
uint32 ModuleId = 0
 Module identification
 
uint32 SubmoduleId = 0
 Submodule identification
 
uint16 AlarmSpecifier = 0
 Alarm Specifier More...
 
uint16 UserStructId = 0
 User structure identifier
 
std::vector< byteAlarmInfoItem
 Alarm info item
 

Detailed Description

This structure contains all information about a received alarm. For more information read the PROFINET specification.

Member Function Documentation

◆ Deserialize()

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

◆ AlarmSpecifier

uint16 Arp::Io::ProfinetStack::Controller::Services::AlarmInfo::AlarmSpecifier = 0

Alarm Specifier

ToDo

◆ AlarmType

uint16 Arp::Io::ProfinetStack::Controller::Services::AlarmInfo::AlarmType = 0

Type of alarm

ToDo


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