Payload class for a Profinet alarm More...

#include <AlarmPayload.hpp>

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

Public Types
using	ArgumentsType = std::tuple< const char , const char , uint16, uint16, uint32, uint32, uint16, bool, bool, bool, bool, const char * >
	ArgumentsType to be used with NonBlockingNotificationRegistration3

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

using	RscType = Arp::Base::Rsc::Commons::RscType

using	FieldType = RscType

Public Member Functions
	AlarmPayload (const ArgumentsType &args)
	Creates a payload object

	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

String	GetDeviceName () const
	Returns the Profinet device name

uint16	GetSlotNumber () const
	Returns the slot number

uint16	GetSubslotNumber () const
	Returns the sub slot number

uint32	GetModuleNumber () const
	Returns the module number

uint32	GetSubModuleNumber () const
	Returns the sub module number

uint16	GetSequenceNumber () const
	Returns the sequence number

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

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

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

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

String	GetAlarmText () const
	Returns the alarm text if available

	SpecializedPayload (const Notification &notification)
	Creates a view on a Notification object More...

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

	SpecializedPayload (const String &formatString)
	Creates a SpecializedPayload with an format string 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

virtual PayloadTypeIdType	GetId () const =0
	Returns the PayloadTypeId More...

virtual const String	GetName () const =0
	Returns the PayloadTypeName More...

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

virtual const String	ToString () const =0
	Get a human readable string representation More...

Additional Inherited Members
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.

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

◆ SpecializedPayload() [1/3]

Arp::System::Nm::SpecializedPayload< PayloadType >::SpecializedPayload ( const GenericPayload & payloadArg )

explicit

Creates a view on a GenericPayload object

The GenericPayload is just referenced so it must stay alive to avoid dangling references.

◆ SpecializedPayload() [2/3]

Arp::System::Nm::SpecializedPayload< PayloadType >::SpecializedPayload ( const Notification & notification )

explicit

Creates a view on a Notification object

The Notification is just referenced so it must stay alive to avoid dangling references.

◆ SpecializedPayload() [3/3]

Arp::System::Nm::SpecializedPayload< PayloadType >::SpecializedPayload ( const String & formatString )

explicit

Creates a SpecializedPayload with an format string

Parameters

formatString Formatstring to generate a huiman readable representation

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

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

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AlarmPayload()

Member Function Documentation

◆ SpecializedPayload() [1/3]

◆ SpecializedPayload() [2/3]

◆ SpecializedPayload() [3/3]