State with sub states of an alarm. More...

Public Member Functions
	AlarmState (const AlarmState &)=default

	AlarmState (String alarmId, String alarmType, int16 severity)

	AlarmState (const String &alarmId, const String &alarmType, const String &message, const bool acitiveState, const bool ackedState, const bool confirmedState, const String &comment, const String &language, const String &user, const bool suppressedState, const int16 severity, const bool isRetain)

Public Attributes
String	AlarmId
	Unique Id of the alarm instance within the PLC.

String	AlarmType
	Type of the alarm. Use as key to lookup a localized text for the alarm message.

String	Message
	Optional message. More...

bool	ActiveState
	Indication if the alarm condition is true.

DateTime	ActiveStateChanged
	Timestamp for the last change of ActiveState.

bool	AckedState
	Acknowledged state of the alarm (the user has seen the alarm).

DateTime	AckedStateChanged
	Timestamp for the last change of AckedState.

bool	ConfirmedState
	Confirmed state of the alarm (the user has resolved the problem).

DateTime	ConfirmedStateChanged
	Timestamp for the last change of ConfirmedState.

String	Comment
	User comment to the Alarm from Acknowlege, Confirm or AddComment method.

String	Language
	Language of the user comment.

String	User
	User that most recently changed the comment.

bool	SuppressedState
	The server wants to hide the alarm.

DateTime	SuppressedStateChanged
	Timestamp for the last change of SuppressedState.

int16	Severity
	Severity between 1 and 1000 (1 = information; 1000 = fatal error).

bool	Retain
	True to indicate that the alarm should be displayed to the client.

DateTime	RetainChanged
	Timestamp for the last change of Retain.

DateTime	AlarmChanged
	Timestamp for the last change of Alarm.

std::vector< AlarmUserParameter >	UserParameters
	Up to 10 user parameters.

Detailed Description

State with sub states of an alarm.

Member Data Documentation

String Arp::System::NmPayload::Alarms::AlarmState::Message

Optional message.

Future: if Message is empty the AlarmType is the key retrieval of a translated message.

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