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:

Public Types
using	ArgumentsType = std::tuple< const char , const char , const char *, bool >
	ArgumentsType to be used with NonBlockingNotificationRegistration3 More...

Public Types inherited from Arp::System::Nm::SpecializedPayload< InterfaceAddressPayload >
using	ValueType = RawPayloadType::value_type

using	FieldType = Arp::System::Rsc::Services::RscType

Public Member Functions
	InterfaceAddressPayload (const ArgumentsType &args)
	Creates a payload object More...

	InterfaceAddressPayload (const String ipAddress, const String &netmask, const String &gateway, bool isVolatile)
	Creates a payload object More...

String	GetIpAddress () const
	Returns the IP address More...

String	GetNetmask () const
	Returns the netmask More...

String	GetGateway () const
	Returns the gateway More...

bool	IsVolatile () const
	Returns true, if the parameters are volatile 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 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 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)

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.

Member Typedef Documentation

◆ ArgumentsType

using Arp::System::NmPayload::Io::ProfinetStack::InterfaceAddressPayload::ArgumentsType = std::tuple<const char*, const char*, const char*, bool>

ArgumentsType to be used with NonBlockingNotificationRegistration3

Constructor & Destructor Documentation

◆ InterfaceAddressPayload() [1/2]

Arp::System::NmPayload::Io::ProfinetStack::InterfaceAddressPayload::InterfaceAddressPayload ( const ArgumentsType & args )

explicit

Creates a payload object

◆ InterfaceAddressPayload() [2/2]

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

Creates a payload object

Parameters

ipAddress	IP address
netmask	Netmask
gateway	Gateway
isVolative	true, if the parameters are volatile

Member Function Documentation

◆ GetGateway()

String Arp::System::NmPayload::Io::ProfinetStack::InterfaceAddressPayload::GetGateway ( ) const

Returns the gateway

◆ GetIpAddress()

String Arp::System::NmPayload::Io::ProfinetStack::InterfaceAddressPayload::GetIpAddress ( ) const

Returns the IP address

◆ GetNetmask()

String Arp::System::NmPayload::Io::ProfinetStack::InterfaceAddressPayload::GetNetmask ( ) const

Returns the netmask

◆ IsVolatile()

bool Arp::System::NmPayload::Io::ProfinetStack::InterfaceAddressPayload::IsVolatile ( ) const

Returns true, if the parameters are volatile

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

Arp/System/NmPayload/Io/ProfinetStack/InterfaceAddressPayload.hpp

Public Types

Public Member Functions

Additional Inherited Members