PLCnext API Documentation 25.0.2.69
|
Public Member Functions | |
AddAlarmPayload (const String &alarmId, const String &alarmType, const int16 alarmSeverity) | |
AddAlarmPayload (const Notification &event) | |
String | GetAlarmId () const |
String | GetAlarmType () const |
int16 | GetAlarmSeverity () const |
![]() | |
SpecializedPayload (const Notification ¬ification) | |
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 | |
![]() | |
using | ValueType = RawPayloadType::value_type |
using | RscType = Arp::Base::Rsc::Commons::RscType |
using | FieldType = RscType |
![]() | |
static PayloadTypeIdType | GetPayloadTypeId () |
Returns the PayloadTypeId More... | |
static const String | GetPayloadTypeName () |
Returns the PayloadType name More... | |
![]() | |
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 size_t | FieldIndexToFormatStringIndex (size_t fieldIndex) |