PLCnext API Documentation 25.0.2.69
Public Types | Public Member Functions | List of all members
Arp::System::NmPayload::Io::ProfinetStack::InterfaceAddressPayload Class Reference

Payload class with information of the interface address of a Profinet station More...

#include <InterfaceAddressPayload.hpp>

Inheritance diagram for Arp::System::NmPayload::Io::ProfinetStack::InterfaceAddressPayload:
Inheritance graph

Public Types

using ArgumentsType = std::tuple< const char *, const char *, const char *, bool >
 ArgumentsType to be used with NonBlockingNotificationRegistration3
 
- Public Types inherited from Arp::System::Nm::SpecializedPayload< InterfaceAddressPayload >
using ValueType = RawPayloadType::value_type
 
using RscType = Arp::Base::Rsc::Commons::RscType
 
using FieldType = RscType
 

Public Member Functions

 InterfaceAddressPayload (const ArgumentsType &args)
 Creates a payload object
 
 InterfaceAddressPayload (const String ipAddress, const String &netmask, const String &gateway, bool isVolatile)
 Creates a payload object More...
 
String GetIpAddress () const
 Returns the IP address
 
String GetNetmask () const
 Returns the netmask
 
String GetGateway () const
 Returns the gateway
 
bool IsVolatile () const
 Returns true, if the parameters are volatile
 
 SpecializedPayload (const Notification &notification)
 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< InterfaceAddressPayload >
 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
 
virtual PayloadTypeIdType GetId () const =0
 Returns the PayloadTypeId More...
 
virtual const String GetName () const =0
 Returns the PayloadTypeName More...
 
virtual const RawPayloadTypeGetAsRawPayloadType () 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< InterfaceAddressPayload >
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< InterfaceAddressPayload >
 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< InterfaceAddressPayload >
static size_t FieldIndexToFormatStringIndex (size_t fieldIndex)
 

Detailed Description

Payload class with information of the interface address of a Profinet station

This payload class is used by both the Profinet I/O controller and Profinet Device to notify about changes of the ip addresses.

Constructor & Destructor Documentation

◆ InterfaceAddressPayload()

Arp::System::NmPayload::Io::ProfinetStack::InterfaceAddressPayload::InterfaceAddressPayload ( const String  ipAddress,
const String netmask,
const String gateway,
bool  isVolatile 
)

Creates a payload object

Parameters
ipAddressIP address
netmaskNetmask
gatewayGateway
isVolativetrue, if the parameters are volatile

Member Function Documentation

◆ SpecializedPayload() [1/3]

Arp::System::Nm::SpecializedPayload< PayloadType >::SpecializedPayload ( const GenericPayload payloadArg)
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]

Arp::System::Nm::SpecializedPayload< PayloadType >::SpecializedPayload ( const Notification notification)
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]

Arp::System::Nm::SpecializedPayload< PayloadType >::SpecializedPayload ( const String formatString)
explicit

Creates a SpecializedPayload with an format string

Parameters
formatStringFormatstring to generate a huiman readable representation

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