PLCnext API Documentation 25.0.2.69
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

 AlarmInfo (void)
 Constructs an AlarmInfo instance.
 
 AlarmInfo (boolean newAlarmReceived, uint32 id, uint16 blockType, uint16 blockLength, uint16 blockVersion, uint16 alarmType, uint32 api, uint16 slot, uint16 subslot, uint32 moduleId, uint32 submoduleId, uint16 alarmSpecifier, uint16 userStructId, const std::vector< byte > &alarmInfoItem)
 Constructs an AlarmInfo 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

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
 
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
 
uint16 UserStructId = 0
 User structure identifier
 
std::vector< byte > AlarmInfoItem
 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)

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

Parameters
readerReference to RscReader.

◆ GetFieldCount()

size_t Arp::Io::ProfinetStack::Controller::Services::AlarmInfo::GetFieldCount ( void  )
static

Returns the count of fields

Returns
Count of fields.

The field count is used for serialization via Rsc

◆ Serialize()

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