PLCnext API Documentation
22.9.0.33
|
Payload class to indicate the state of the system startup More...
#include <SystemManagerStatePayload.hpp>
Public Types | |
using | ArgumentsType = std::tuple< SystemManagerState, bool, bool > |
ArgumentsType to be used with NonBlockingNotificationRegistration3 More... | |
![]() | |
using | ValueType = RawPayloadType::value_type |
using | FieldType = Arp::System::Rsc::Services::RscType |
Public Member Functions | |
SystemManagerStatePayload (const ArgumentsType &args) | |
Create payload with state and error information More... | |
SystemManagerStatePayload (const SystemManagerState &state, bool error, bool warning) | |
Create payload with state and error information More... | |
SystemManagerState | GetState () const |
bool | GetError () const |
bool | GetWarning () 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 More... | |
Additional Inherited Members | |
![]() | |
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) |
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) |
Payload class to indicate the state of the system startup
This payload provides fields for the state, error and warning
using Arp::System::NmPayload::Acf::SystemManagerStatePayload::ArgumentsType = std::tuple<SystemManagerState, bool, bool> |
ArgumentsType to be used with NonBlockingNotificationRegistration3
|
explicit |
Create payload with state and error information
args | Arguments to construct the payload with |
Arp::System::NmPayload::Acf::SystemManagerStatePayload::SystemManagerStatePayload | ( | const SystemManagerState & | state, |
bool | error, | ||
bool | warning | ||
) |
Create payload with state and error information
state | SystemManager state |
error | true if an error occured |
warning | true if a warning is present |