PLCnext API Documentation  22.6.0.43
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | List of all members
Arp::System::NmPayload::Device::PciDeviceStatePayload Class Reference

Payload class for the status of PCI extension devices More...

#include <PciDeviceStatePayload.hpp>

Inheritance diagram for Arp::System::NmPayload::Device::PciDeviceStatePayload:
Inheritance graph

Public Types

using ArgumentsType = PciDeviceState
 ArgumentsType to be used with NonBlockingNotificationRegistration3 More...
 
- Public Types inherited from Arp::System::Nm::SpecializedPayload< PciDeviceStatePayload >
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...
 
- Public Member Functions inherited from Arp::System::Nm::SpecializedPayload< PciDeviceStatePayload >
 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from Arp::System::Nm::SpecializedPayload< PciDeviceStatePayload >
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< PciDeviceStatePayload >
 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 Protected Member Functions inherited from Arp::System::Nm::SpecializedPayload< PciDeviceStatePayload >
static size_t FieldIndexToFormatStringIndex (size_t fieldIndex)
 

Detailed Description

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

Member Typedef Documentation

◆ ArgumentsType

using Arp::System::NmPayload::Device::PciDeviceStatePayload::ArgumentsType = PciDeviceState

ArgumentsType to be used with NonBlockingNotificationRegistration3

Constructor & Destructor Documentation

◆ PciDeviceStatePayload()

Arp::System::NmPayload::Device::PciDeviceStatePayload::PciDeviceStatePayload ( PciDeviceState  state)
explicit

Creates a payload object

Parameters
statestate of the device

Member Function Documentation

◆ GetState()

PciDeviceState Arp::System::NmPayload::Device::PciDeviceStatePayload::GetState ( ) const

Returns the state of the interface


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