|
PLCnext API Documentation 23.3.0.32
|
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
|
PLCnext API Documentation 23.3.0.32
|
Payload class for state changes of PROFINET LEDs More...
#include <PnStationStatePayload.hpp>
Public Types | |
| using | ArgumentsType = std::tuple< const char *, PnStationType, bool, bool > |
| ArgumentsType to be used with NonBlockingNotificationRegistration3 | |
 Public Types inherited from Arp::System::Nm::SpecializedPayload< PnStationStatePayload > | |
| using | ValueType = RawPayloadType::value_type |
| using | FieldType = Arp::System::Rsc::Services::RscType |
Public Member Functions | |
| PnStationStatePayload (const ArgumentsType &args) | |
| Constructs the payload object | |
| PnStationStatePayload (const String &componentName, PnStationType stationType, bool bfLed, bool sfLed) | |
| Constructs the payload object More... | |
| String | GetComponentName () const |
| Return the name of the sending component | |
| PnStationType | GetStationType () const |
| Returns the station type | |
| bool | GetBfLed () const |
| Returns the state of the BF LED | |
| bool | GetSfLed () const |
| Returns the state of the SF LED | |
| Public Member Functions inherited from Arp::System::Nm::SpecializedPayload< PnStationStatePayload > | |
| 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< PnStationStatePayload > | |
| 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< PnStationStatePayload > | |
| 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< PnStationStatePayload > | |
| static size_t | FieldIndexToFormatStringIndex (size_t fieldIndex) |
Payload class for state changes of PROFINET LEDs
| Arp::System::NmPayload::Io::ProfinetStack::PnStationStatePayload::PnStationStatePayload | ( | const String & | componentName, |
| PnStationType | stationType, | ||
| bool | bfLed, | ||
| bool | sfLed | ||
| ) |
Constructs the payload object
| componentName | Name of the sending component |
| bfLed | State of the BF LED |
| sfLed | State of the SF LED |
1.9.4