PLCnext API Documentation 25.0.2.69
Public Types | Public Member Functions | List of all members
Arp::System::NmPayload::Alarms::Internal::AlarmPayload Class Reference
Inheritance diagram for Arp::System::NmPayload::Alarms::Internal::AlarmPayload:
Inheritance graph

Public Types

using ArgumentsType = std::tuple< const char *, const char *, const char *, bool, bool, bool, bool, int16, bool, const char *, const char *, 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)
 
 AlarmPayload (const String &alarmId, const String &alarmType, const String &message, const bool activeState, const bool ackedState, const bool confirmedState, const bool suppressedState, const int16 severity, const bool isRetain, const String &comment, const String &language, const String &user)
 
 AlarmPayload (const AlarmState &alarmState)
 
 AlarmPayload (const Notification &notification)
 
AlarmState GetAlarmState () const
 
String GetAlarmId () const
 
String GetAlarmType () const
 
String GetMessage () const
 
bool GetActiveState () const
 
DateTime GetActiveStateChanged () const
 
bool GetAckedState () const
 
DateTime GetAckedStateChanged () const
 
bool GetConfirmedState () const
 
DateTime GetConfirmedStateChanged () const
 
bool GetSuppressedState () const
 
DateTime GetSuppressedStateChanged () const
 
int16 GetSeverity () const
 
bool GetRetain () const
 
DateTime GetRetainChanged () const
 
DateTime GetAlarmChanged () const
 
String GetUserParameterName (int index) const
 
RscVariant< 512 > GetUserParameterValue (int index) const
 
String GetComment () const
 
String GetLanguage () const
 
String GetUser () const
 
- 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 RawPayloadTypeGetAsRawPayloadType () 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 RawPayloadTypeGetAsRawPayloadType () 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)
 

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