PLCnext API Documentation 25.9.0.13
Classes | Enumerations | Functions
Arp::Io::ProfinetStack::System::Services Namespace Reference

Namespace for Profinet I/O system services More...

Classes

class  DcpConfirmation
 Contains DCP confirmation data of a station on a request. More...
 
class  DcpResult
 Contains information that are returned by a request. More...
 
class  IAcyclicCommunicationService
 This service enables sending implicit read record requests. More...
 
class  IConfigurationService
 This service read and writes different configuration options to the profinet system. More...
 
class  IDcpService
 This service enables sending DCP requests and retrieving confirmations. More...
 
class  PnioStatus
 Contains status information of a service call More...
 
class  RecordParameter
 Parameter to address a submodule and a record object. More...
 
class  RecordResult
 Result of the record service request. More...
 
class  Station
 Contains parameter to address and set a station name. More...
 
class  StationAddress
 Contains parameter to address and set a station network address. More...
 

Enumerations

enum class  ConfigurationErrorCode : int32 {
  None = 0 , UnknownConfiguration = 1 , UnknownComponent = 2 , InternalError = 3 ,
  InvalidValueType = 4 , InvalidValue = 5 , NotSupported = 6 , ReadOnly = 7
}
 This enumeration defines errors codes of the Arp.Io.ProfinetStack.System.Services.IConfigurationService. More...
 
enum class  DcpErrorCode : uint16 {
  None = 0 , OptionNotSupported = 1 , SuboptionNotSupported = 2 , SuboptionNotSet = 3 ,
  ResponseError = 4 , SetNotPossible = 5 , InOperation = 6 , ConfirmationOutdated = 7
}
 Contains error information on a DCP request. More...
 
enum class  StoreOption : uint16 { Temporary = 0 , Permanent = 1 }
 Contains value to specify how requested changes shall be stored. More...
 

Functions

ARP_EXPORT std::ostream & operator<< (std::ostream &os, ConfigurationErrorCode value)
 
ARP_EXPORT std::istream & operator>> (std::istream &is, ConfigurationErrorCode &value)
 
ARP_EXPORT std::ostream & operator<< (std::ostream &os, DcpErrorCode value)
 
ARP_EXPORT std::istream & operator>> (std::istream &is, DcpErrorCode &value)
 
ARP_EXPORT std::ostream & operator<< (std::ostream &os, StoreOption value)
 
ARP_EXPORT std::istream & operator>> (std::istream &is, StoreOption &value)
 

Detailed Description

Namespace for Profinet I/O system services

Enumeration Type Documentation

◆ ConfigurationErrorCode

This enumeration defines errors codes of the Arp.Io.ProfinetStack.System.Services.IConfigurationService.

Enumerator
None 

Operation was successfull

UnknownConfiguration 

Configuration option is unknown

UnknownComponent 

Profinet component with specifed name not registered

InternalError 

An internal error occured. See log for additional information.

InvalidValueType 

The value type is not as expected by the configuration option handler.

InvalidValue 

The value ist not as expected by the configuration option handler (e.g. out of range)

NotSupported 

The operation is not supported by this system or the instance.

ReadOnly 

The configuration option is read only

◆ DcpErrorCode

Contains error information on a DCP request.

Enumerator
None 

No error

OptionNotSupported 

Option is not supported

SuboptionNotSupported 

Suboption is not supported

SuboptionNotSet 

Suboption is not set

ResponseError 

Response error

SetNotPossible 

Set not possible

InOperation 

Is in operation / busy

ConfirmationOutdated 

Confirmation is outdated. because it has been fetched in time.

◆ StoreOption

Contains value to specify how requested changes shall be stored.

Enumerator
Temporary 

Changes will be stored temporarily

Permanent 

Changes will be stored permanently