Payload class for a message regarding the migration of the storage file format More...
#include <StorageFileFormatMigrationPayload.hpp>
Inheritance diagram for Arp::System::NmPayload::NotificationLogger::StorageFileFormatMigrationPayload:
Public Types | |
| using | ArgumentsType = std::tuple< const char *, const char *, StorageFileFormatMigrationResult, int, int, const char * > |
| ArgumentsType to be used with NonBlockingNotificationRegistration3 | |
 Public Types inherited from Arp::System::Nm::SpecializedPayload< StorageFileFormatMigrationPayload > | |
| using | ValueType = RawPayloadType::value_type |
| using | RscType = Arp::Base::Rsc::Commons::RscType |
| using | FieldType = RscType |
Public Member Functions | |
| StorageFileFormatMigrationPayload (const ArgumentsType &args) | |
| Creates a payload object | |
| StorageFileFormatMigrationPayload (const String &archiveName, const String &filePath, StorageFileFormatMigrationResult result, int sourceVersion, int destinationVersion, const String &backupFilePath) | |
| Creates a payload object More... | |
| String | GetArchiveName () const |
| Returns the archive name | |
| String | GetFilePath () const |
| Returns the name of the migrated file | |
| StorageFileFormatMigrationResult | GetResult () const |
| Returns the result of the migration | |
| int | GetSourceVersion () const |
| Returns the file version before the migration | |
| int | GetDestinationVersion () const |
| Returns the file version after the migration | |
| String | GetBackupFilePath () const |
| Returns the path of the backup file if it was created | |
| SpecializedPayload (const Notification ¬ification) | |
| Creates a view on a Notification object More... | |
| SpecializedPayload (const GenericPayload &payloadArg) | |
| Creates a view on a GenericPayload object More... | |
| SpecializedPayload (const String &formatString) | |
| Creates a SpecializedPayload with an format string More... | |
| Public Member Functions inherited from Arp::System::Nm::SpecializedPayload< StorageFileFormatMigrationPayload > | |
| 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 | |
| Static Public Member Functions inherited from Arp::System::Nm::SpecializedPayload< StorageFileFormatMigrationPayload > | |
| 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< StorageFileFormatMigrationPayload > | |
| 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< StorageFileFormatMigrationPayload > | |
| static size_t | FieldIndexToFormatStringIndex (size_t fieldIndex) |
Detailed Description
Payload class for a message regarding the migration of the storage file format
This payload class is used by the NotificationLogger.
Constructor & Destructor Documentation
◆ StorageFileFormatMigrationPayload()
| Arp::System::NmPayload::NotificationLogger::StorageFileFormatMigrationPayload::StorageFileFormatMigrationPayload | ( | const String & | archiveName, |
| const String & | filePath, | ||
| StorageFileFormatMigrationResult | result, | ||
| int | sourceVersion, | ||
| int | destinationVersion, | ||
| const String & | backupFilePath | ||
| ) |
Creates a payload object
- Parameters
-
archiveName archive name
Member Function Documentation
◆ SpecializedPayload() [1/3]
|
explicit |
Creates a view on a GenericPayload object
The GenericPayload is just referenced so it must stay alive to avoid dangling references.
◆ SpecializedPayload() [2/3]
|
explicit |
Creates a view on a Notification object
The Notification is just referenced so it must stay alive to avoid dangling references.
◆ SpecializedPayload() [3/3]
|
explicit |
Creates a SpecializedPayload with an format string
- Parameters
-
formatString Formatstring to generate a huiman readable representation
The documentation for this class was generated from the following files:
- Arp/System/NmPayload/NotificationLogger/StorageFileFormatMigrationPayload.hpp
- Arp/System/NmPayload/NotificationLogger/StorageFileFormatMigrationPayload.cpp
