PLCnext API Documentation  20.6.0.30321
Public Member Functions | Protected Member Functions | List of all members
Arp::System::Nm::NmSubscribeFailedPayload< Derived > Class Template Reference

Payload base class for failed subscriptions More...

#include <NmSubscribeFailedPayload.hpp>

Inheritance diagram for Arp::System::Nm::NmSubscribeFailedPayload< Derived >:
Inheritance graph

Public Member Functions

const String GetNotificationName () const
 Returns the affected NotificationName More...
 
- Public Member Functions inherited from Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< Derived > >
 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 More...
 

Protected Member Functions

 NmSubscribeFailedPayload (const String &formatString, const String &notificationName)
 
- Protected Member Functions inherited from Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< Derived > >
 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...
 

Additional Inherited Members

- Public Types inherited from Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< Derived > >
using ValueType = RawPayloadType::value_type
 
using FieldType = Arp::System::Rsc::Services::RscType
 
- Static Public Member Functions inherited from Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< Derived > >
static PayloadTypeIdType GetPayloadTypeId ()
 Returns the PayloadTypeId More...
 
static const String GetPayloadTypeName ()
 Returns the PayloadType name More...
 
- Static Protected Member Functions inherited from Arp::System::Nm::SpecializedPayload< NmSubscribeFailedPayload< Derived > >
static size_t FieldIndexToFormatStringIndex (size_t fieldIndex)
 

Detailed Description

template<typename Derived>
class Arp::System::Nm::NmSubscribeFailedPayload< Derived >

Payload base class for failed subscriptions

Member Function Documentation

◆ GetNotificationName()

template<typename Derived>
const String Arp::System::Nm::NmSubscribeFailedPayload< Derived >::GetNotificationName ( ) const
inline

Returns the affected NotificationName


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