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:

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
boolean	NewAlarmReceived = false
	Flag is set, if new alarm has been received More...

uint32	Id = 0
	Node id More...

uint16	BlockType = 0
	Type of alarm information More...

uint16	BlockLength = 0
	Length of alarm information in bytes More...

uint16	BlockVersion = 0
	Version of alarm information More...

uint16	AlarmType = 0
	Type of alarm More...

uint32	Api = 0
	Application Process Identifier More...

uint16	Slot = 0
	Slot number More...

uint16	Subslot = 0
	Subslot number More...

uint32	ModuleId = 0
	Module identification More...

uint32	SubmoduleId = 0
	Submodule identification More...

uint16	AlarmSpecifier = 0
	Alarm Specifier More...

uint16	UserStructId = 0
	User structure identifier More...

std::vector< uint8 >	AlarmInfoItem
	Alarm info item More...

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

reader Reference 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

writer Reference to RscWriter

Implements Arp::System::Rsc::Services::IRscSerializable.

Member Data Documentation

◆ AlarmInfoItem

std::vector<uint8> Arp::Io::ProfinetStack::Controller::Services::AlarmInfo::AlarmInfoItem

Alarm info item

◆ 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

◆ Api

uint32 Arp::Io::ProfinetStack::Controller::Services::AlarmInfo::Api = 0

Application Process Identifier

◆ BlockLength

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

Length of alarm information in bytes

◆ BlockType

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

Type of alarm information

◆ BlockVersion

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

Version of alarm information

◆ Id

uint32 Arp::Io::ProfinetStack::Controller::Services::AlarmInfo::Id = 0

Node id

◆ ModuleId

uint32 Arp::Io::ProfinetStack::Controller::Services::AlarmInfo::ModuleId = 0

Module identification

◆ NewAlarmReceived

boolean Arp::Io::ProfinetStack::Controller::Services::AlarmInfo::NewAlarmReceived = false

Flag is set, if new alarm has been received

◆ Slot

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

Slot number

◆ SubmoduleId

uint32 Arp::Io::ProfinetStack::Controller::Services::AlarmInfo::SubmoduleId = 0

Submodule identification

◆ Subslot

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

Subslot number

◆ UserStructId

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

User structure identifier

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

Arp/Io/ProfinetStack/Controller/Services/AlarmInfo.hpp

Public Member Functions

Static Public Member Functions

Public Attributes