Payload class for a message containing an archive name More...
#include <MessageWithArchiveNamePayload.hpp>
Inheritance diagram for Arp::System::NmPayload::NotificationLogger::MessageWithArchiveNamePayload:
Public Member Functions | |
| MessageWithArchiveNamePayload (const String &message, const String &archiveName) | |
| Creates a payload object More... | |
| String | GetArchiveName () const |
| Returns the Profinet station name More... | |
 Public Member Functions inherited from Arp::System::Nm::SpecializedPayload< MessageWithArchiveNamePayload > | |
| 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 More... | |
Additional Inherited Members | |
| Public Types inherited from Arp::System::Nm::SpecializedPayload< MessageWithArchiveNamePayload > | |
| using | ValueType = RawPayloadType::value_type |
| using | FieldType = Arp::System::Rsc::Services::RscType |
| Static Public Member Functions inherited from Arp::System::Nm::SpecializedPayload< MessageWithArchiveNamePayload > | |
| 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< MessageWithArchiveNamePayload > | |
| 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< MessageWithArchiveNamePayload > | |
| static size_t | FieldIndexToFormatStringIndex (size_t fieldIndex) |
Detailed Description
Payload class for a message containing an archive name
This payload class is used by the NotificationLogger to send notification regarding an archive.
Constructor & Destructor Documentation
◆ MessageWithArchiveNamePayload()
| Arp::System::NmPayload::NotificationLogger::MessageWithArchiveNamePayload::MessageWithArchiveNamePayload | ( | const String & | message, |
| const String & | archiveName | ||
| ) |
Creates a payload object
- Parameters
-
message message with a placeholder "{}" for the archive name archiveName archive name
Member Function Documentation
◆ GetArchiveName()
| String Arp::System::NmPayload::NotificationLogger::MessageWithArchiveNamePayload::GetArchiveName | ( | ) | const |
Returns the Profinet station name
The documentation for this class was generated from the following file:
- Arp/System/NmPayload/NotificationLogger/MessageWithArchiveNamePayload.hpp
