PLCnext API Documentation
22.6.0.43
|
Payload class for the status of PCI extension devices More...
#include <PciDeviceStatePayload.hpp>
Public Types | |
using | ArgumentsType = PciDeviceState |
ArgumentsType to be used with NonBlockingNotificationRegistration3 More... | |
![]() | |
using | ValueType = RawPayloadType::value_type |
using | FieldType = Arp::System::Rsc::Services::RscType |
Public Member Functions | |
PciDeviceStatePayload (PciDeviceState state) | |
Creates a payload object More... | |
PciDeviceState | GetState () const |
Returns the state of the interface More... | |
![]() | |
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 for the status of PCI extension devices
This class is used by the device interface to notify of the state of PCI extension modules
using Arp::System::NmPayload::Device::PciDeviceStatePayload::ArgumentsType = PciDeviceState |
ArgumentsType to be used with NonBlockingNotificationRegistration3
|
explicit |
Creates a payload object
state | state of the device |
PciDeviceState Arp::System::NmPayload::Device::PciDeviceStatePayload::GetState | ( | ) | const |
Returns the state of the interface