PLCnext API Documentation 25.9.0.13
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Arp::Io::ProfinetStack::System::Services::DcpConfirmation Class Reference

Contains DCP confirmation data of a station on a request. More...

#include <DcpConfirmation.hpp>

Inheritance diagram for Arp::Io::ProfinetStack::System::Services::DcpConfirmation:
Inheritance graph

Public Member Functions

 DcpConfirmation (void)
 Constructs an DcpConfirmation instance.
 
 DcpConfirmation (const DcpResult &result, const RscString< 240 > &stationName, const RscString< 40 > &ipAddress, const RscString< 16 > &subnetMask, const RscString< 16 > &defaultGateway, const RscString< 18 > &macAddress, uint16 vendorId, const RscString< 128 > &deviceType)
 Constructs an DcpConfirmation instance.
 
void Serialize (RscWriter &writer) const
 Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter. More...
 
void Deserialize (RscReader &reader)
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader. More...
 
void Serialize (JRscWriter &writer) const
 Serializes the datatype. All fields of the datatype have to be serialized in use of JRscWriter. More...
 
void Deserialize (JRscReader &reader)
 Deserializes the datatype. All fields of the datatype have to be deserialized in use of JRscReader. More...
 
- Public Member Functions inherited from Arp::Base::Rsc::Commons::RscSerializable
 RscSerializable (void)=default
 The default constructor.
 

Static Public Member Functions

static size_t GetFieldCount (void)
 Returns the count of fields More...
 

Public Attributes

DcpResult Result
 Contains information on the request. If an error code is set, there is no valid data.
 
RscString< 240 > StationName
 Name of the station.
 
RscString< 40 > IpAddress
 IP address of the station.
 
RscString< 16 > SubnetMask
 Subnet mask of the station.
 
RscString< 16 > DefaultGateway
 Default gateway of the station.
 
RscString< 18 > MacAddress
 MAC address of the station.
 
uint16 VendorId = 0
 Vendor ID of the station.
 
RscString< 128 > DeviceType
 Device type of the station.
 

Detailed Description

Contains DCP confirmation data of a station on a request.

Member Function Documentation

◆ Deserialize() [1/2]

void Arp::Io::ProfinetStack::System::Services::DcpConfirmation::Deserialize ( JRscReader &  reader)

Deserializes the datatype. All fields of the datatype have to be deserialized in use of JRscReader.

Parameters
readerReference to RscReader.

◆ Deserialize() [2/2]

void Arp::Io::ProfinetStack::System::Services::DcpConfirmation::Deserialize ( RscReader reader)

Deserializes the datatype. All fields of the datatype have to be deserialized in use of RscReader.

Parameters
readerReference to RscReader.

◆ GetFieldCount()

size_t Arp::Io::ProfinetStack::System::Services::DcpConfirmation::GetFieldCount ( void  )
static

Returns the count of fields

Returns
Count of fields.

The field count is used for serialization via Rsc

◆ Serialize() [1/2]

void Arp::Io::ProfinetStack::System::Services::DcpConfirmation::Serialize ( JRscWriter &  writer) const

Serializes the datatype. All fields of the datatype have to be serialized in use of JRscWriter.

Parameters
writerReference to RscWriter

◆ Serialize() [2/2]

void Arp::Io::ProfinetStack::System::Services::DcpConfirmation::Serialize ( RscWriter writer) const

Serializes the datatype. All fields of the datatype have to be serialized in use of RscWriter.

Parameters
writerReference to RscWriter

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