Payload class for a Profinet alarm More...

#include <AlarmPayload.hpp>

Inheritance diagram for Arp::System::NmPayload::Io::ProfinetStack::AlarmPayload:

Public Member Functions
	AlarmPayload (const String &alarmType, const String &deviceName, uint16 slotNumber, uint16 subslotNumber, uint32 moduleNumber, uint32 subModuleNumber, uint16 sequenceNumber, bool isChannelDiagnosis, bool isManufacturerSpecificDiagnosis, bool isSubmoduleDiagnosisState, bool isArDiagnosisState, const String &alarmText)
	Creates a payload object More...

String	GetAlarmType () const
	Returns the alarm type More...

String	GetDeviceName () const
	Returns the Profinet device name More...

uint16	GetSlotNumber () const
	Returns the slot number More...

uint16	GetSubslotNumber () const
	Returns the sub slot number More...

uint32	GetModuleNumber () const
	Returns the module number More...

uint32	GetSubModuleNumber () const
	Returns the sub module number More...

uint16	GetSequenceNumber () const
	Returns the sequence number More...

bool	GetIsChannelDiagnosis () const
	Returns true if alarm is a channel diagnosis More...

bool	GetIsManufacturerSpecificDiagnosis () const
	Return s true if alarm is manufacturer specific diagnosis More...

bool	GetIsSubmoduleDiagnosisState () const
	Return s true if alarm is submodule diagnosis More...

bool	GetIsArDiagnosisState () const
	Return s true if alarm is diagnostic information of the application reference More...

String	GetAlarmText () const
	Returns the alarm text if available More...

Public Member Functions inherited from Arp::System::Nm::SpecializedPayload< AlarmPayload >
	SpecializedPayload (const Notification &notification)
	Creates a view on a Notification object More...

	SpecializedPayload (const GenericPayload &payloadArg)
	Creates a view on a GenericPayload object More...

PayloadTypeIdType	GetId () const final
	Returns the PayloadTypeId More...

const String	GetName () const final
	Returns the PayloadTypeName More...

const RawPayloadType &	GetAsRawPayloadType () const final
	Returns a reference to the raw payload object More...

const String	ToString () const override
	Get a human readable string representation More...

RawPayloadType &&	MoveOutRawPayload ()

bool	IsReadOnly () const
	Returns true if this object is a view on a Payload More...

Additional Inherited Members
Public Types inherited from Arp::System::Nm::SpecializedPayload< AlarmPayload >
using	ValueType = RawPayloadType::value_type

using	FieldType = Arp::System::Rsc::Services::RscType

Static Public Member Functions inherited from Arp::System::Nm::SpecializedPayload< AlarmPayload >
static PayloadTypeIdType	GetPayloadTypeId ()
	Returns the PayloadTypeId More...

static const String	GetPayloadTypeName ()
	Returns the PayloadType name More...

Protected Member Functions inherited from Arp::System::Nm::SpecializedPayload< AlarmPayload >
	SpecializedPayload (const String &formatString)
	Creates a SpecializedPayload with an format string More...

void	SetFormatString (const String &formatString)
	summary>Retuns the index in the format string for a given payload field More...

size_t	AddField ()
	Adds a payload field More...

size_t	AddField ()
	Adds a payload field More...

void	SetFieldValue (size_t fieldIndex, const T &value)
	Sets the value of a payload field More...

void	SetFieldValue (size_t fieldIndex, T value)
	Sets the value of a payload field More...

const T	GetFieldValueAs (size_t fieldIndex) const
	Gets a field value with the specified type More...

const T	GetFieldValueAs (size_t fieldIndex) const
	Gets a field value with the specified type More...

size_t	GetFieldCount () const
	Gets the number of fields in the payload More...

Static Protected Member Functions inherited from Arp::System::Nm::SpecializedPayload< AlarmPayload >
static size_t	FieldIndexToFormatStringIndex (size_t fieldIndex)

Detailed Description

Payload class for a Profinet alarm

This class encapsulated all the information about a Profinet alarm. remarks>ARP_DEPRECATED("Use AlarmPayload2 instead")

Constructor & Destructor Documentation

◆ AlarmPayload()

Arp::System::NmPayload::Io::ProfinetStack::AlarmPayload::AlarmPayload	(	const String &	alarmType,
		const String &	deviceName,
		uint16	slotNumber,
		uint16	subslotNumber,
		uint32	moduleNumber,
		uint32	subModuleNumber,
		uint16	sequenceNumber,
		bool	isChannelDiagnosis,
		bool	isManufacturerSpecificDiagnosis,
		bool	isSubmoduleDiagnosisState,
		bool	isArDiagnosisState,
		const String &	alarmText
	)

Creates a payload object

Parameters

alarmType	description of the alarm type
deviceName	Profinet device name
slotNumber	slot number
subslotNumber	sub slot number
moduleNumber	module number
subModuleNumber	sub module number
sequenceNumber	sequenceNumber
isChannelDiagnosis	true, if the alarm is a channel diagnosis
isManufacturerSpecificDiagnosus	true, if the alarm is manufacturer specific diagnosis
isSubmoduleDiagnosisState	true, if alarm is submodule diagnosis
isArDiagnosisState	true, if alarm is diagnostic information of the application reference
alarmText	text of the alarm (if available)

Member Function Documentation

◆ GetAlarmText()

String Arp::System::NmPayload::Io::ProfinetStack::AlarmPayload::GetAlarmText ( ) const

Returns the alarm text if available

◆ GetAlarmType()

String Arp::System::NmPayload::Io::ProfinetStack::AlarmPayload::GetAlarmType ( ) const

Returns the alarm type

◆ GetDeviceName()

String Arp::System::NmPayload::Io::ProfinetStack::AlarmPayload::GetDeviceName ( ) const

Returns the Profinet device name

◆ GetIsArDiagnosisState()

bool Arp::System::NmPayload::Io::ProfinetStack::AlarmPayload::GetIsArDiagnosisState ( ) const

Return s true if alarm is diagnostic information of the application reference

◆ GetIsChannelDiagnosis()

bool Arp::System::NmPayload::Io::ProfinetStack::AlarmPayload::GetIsChannelDiagnosis ( ) const

Returns true if alarm is a channel diagnosis

◆ GetIsManufacturerSpecificDiagnosis()

bool Arp::System::NmPayload::Io::ProfinetStack::AlarmPayload::GetIsManufacturerSpecificDiagnosis ( ) const

Return s true if alarm is manufacturer specific diagnosis

◆ GetIsSubmoduleDiagnosisState()

bool Arp::System::NmPayload::Io::ProfinetStack::AlarmPayload::GetIsSubmoduleDiagnosisState ( ) const

Return s true if alarm is submodule diagnosis

◆ GetModuleNumber()

uint32 Arp::System::NmPayload::Io::ProfinetStack::AlarmPayload::GetModuleNumber ( ) const

Returns the module number

◆ GetSequenceNumber()

uint16 Arp::System::NmPayload::Io::ProfinetStack::AlarmPayload::GetSequenceNumber ( ) const

Returns the sequence number

◆ GetSlotNumber()

uint16 Arp::System::NmPayload::Io::ProfinetStack::AlarmPayload::GetSlotNumber ( ) const

Returns the slot number

◆ GetSubModuleNumber()

uint32 Arp::System::NmPayload::Io::ProfinetStack::AlarmPayload::GetSubModuleNumber ( ) const

Returns the sub module number

◆ GetSubslotNumber()

uint16 Arp::System::NmPayload::Io::ProfinetStack::AlarmPayload::GetSubslotNumber ( ) const

Returns the sub slot number

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

Arp/System/NmPayload/Io/ProfinetStack/AlarmPayload.hpp

Public Member Functions

Additional Inherited Members