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

Classes
class	IAcyclicCommunicationService
	Use this service for acyclic PROFINET communication More...

class	AcyclicCommunicationServiceProxyFactory
	Proxy factory class of service IAcyclicCommunicationService More...

class	RecordParam
	Parameter to address a module. Use either the Node ID or the address consisting the station name, slot number and subslot number. More...

class	RecordResult
	Result of the record service More...

class	IAddressConversionService
	Use this service for conversion of addresses and node IDs More...

class	AddressConversionServiceProxyFactory
	Proxy factory class of service IAddressConversionService More...

class	ProfinetAddress
	This structure contains all parameters of a PROFINET address More...

class	IAlarmService
	Use this service to work receive PROFINET alarms More...

class	AlarmServiceProxyFactory
	Proxy factory class of service IAlarmService More...

class	AlarmInfo
	This structure contains all information about a received alarm. For more information read the PROFINET specification. More...

class	IArDataService
	Use this service to manage PROFINET Controller Application Relationships (AR) More...

class	ArDataServiceProxyFactory
	Proxy factory class of service IArDataService More...

class	ArDataResult
	Container for a combination of an error code and a value which is a result for a read operation to a single setting. More...

class	ArInfo
	Container for a combination of an error code and a value which is a result for a read operation to a single setting. More...

class	DiagnosticResult
	Container for a combination of an error code and a value which is a result for a read operation to a single setting. More...

class	DiagnosticInfo
	Container for a combination of an error code and a value which is a result for a read operation to a single setting. More...

class	IArManagementService
	Use this service to manage PROFINET Application Relationships (AR) More...

class	ArManagementServiceProxyFactory
	Proxy factory class of service IArManagementService More...

class	IArStatisticService
	This services provides statistic values for Profinet application relations (AR) More...

class	ArStatisticServiceProxyFactory
	Proxy factory class of service IArStatisticService More...

class	ArStatisticValue
	Contains statistic values of one application relation More...

class	IDiagnosisQueryService
	This services allows access to the diagnosis informationen of the subordinated devices. The diagnosis information of the related submodules are shadowed in a local data base. More...

class	DiagnosisQueryServiceProxyFactory
	Proxy factory class of service IDiagnosisQueryService More...

class	DiagnosisItem
	Contains diagnosis source and corresponding diagnoses. Result of Arp.Io.ProfinetStack.Controller.Services.IDiagnosisQueryService.Query. More...

class	DiagnosisSource
	Contains the information where a diagnosis is located on the device according to "Guideline for PROFINET - Diagnosis for PROFINET" More...

class	StandardDiagnosisInformation
	Contains diagnosis information in standard format. More...

class	UsiDiagnosisInformation
	Contains informationen about diagnosis, that are not in standard format. These are dedicated to fieldbus integration. More...

class	IArConfigurationService
	This service provides PROFINET AR configurations and differences More...

class	ArConfigurationServiceProxyFactory
	Proxy factory class of service IArConfigurationService More...

class	ArConfiguration
	Contains configuration for an AR More...

class	ArDifference
	Contains AR configurations with differences More...

class	API
	API data More...

class	APIDifference
	API data with differences More...

class	Module
	Module data More...

class	ModuleDifference
	Module data with differences More...

class	Submodule
	Submodule data More...

class	SubmoduleDifference
	Submodule data with differences More...

class	ITextLookupService
	This service offers methods to look up texts for the configured devices. The device specific texts need to be transfered with the project. This service only supports project related and system defined information. More...

class	TextLookupServiceProxyFactory
	Proxy factory class of service ITextLookupService More...

class	ChannelErrorTypeInfo
	This struct contains the name and help texts to a diagnosis error type. More...

class	ChannelProcessAlarmReasonInfo
	This struct contains the name and help texts to a diagnosis process alarm reason. More...

class	DeviceIdentityInfo
	This struct contains the vendor name and the device name of one device More...

class	NodeIdentityInfo
	Contains the ident numbers and names the corresponding module and submodule of a node. More...

Enumerations
enum class	ArDataAccessError : uint8 { None = 0 , NotExists = 1 , NotAuthorized = 2 , TypeMismatch = 3 , AttributeNameSyntaxError = 4 , PortNameSemanticError = 5 , IndexOutOfRange = 6 , NotImplemented = 7 , NotSupported = 8 }
	This enumeration contains the possible data access errors. More...

enum class	ChannelQualifier : uint32 { Qualifier3 = 8 , Qualifier4 = 16 , Qualifier5 = 32 , Qualifier6 = 64 , Qualifier7 = 128 , Qualifier8 = 256 , Qualifier9 = 512 , Qualifier10 = 1024 , Qualifier11 = 2048 , Qualifier12 = 4096 , Qualifier13 = 8192 , Qualifier14 = 16384 , Qualifier15 = 32768 , Qualifier16 = 65536 , Qualifier17 = 131072 , Qualifier18 = 262144 , Qualifier19 = 524288 , Qualifier20 = 1048576 , Qualifier21 = 2097152 , Qualifier22 = 4194304 , Qualifier23 = 8388608 , Qualifier24 = 16777216 , Qualifier25 = 33554432 , Qualifier26 = 67108864 , Qualifier27 = 134217728 , Qualifier28 = 268435456 , Qualifier29 = 536870912 , Qualifier30 = 1073741824 , Qualifier31 = 2147483648 , Normal = 0 , Advice = 120 , MaintenanceRequired = 130944 , MaintenanceDemanded = 134086656 , Fault = 4160749568 }
	Describes diagnosis severity. More...

enum class	DiagnosisDirection : uint16 { ManufacturerSpecific = 0 , Input = 8192 , output = 16384 , InputOutput = 24576 }
	Contains the defined values for the direction of a submodule channel More...

enum class	FilterLevel : int32 { None = 0 , AR = 1 , Module = 2 , Submodule = 3 , Channel = 4 , NodeID = 5 }
	Used to determine which values of Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource are used to filter diagnoses. More...

Functions
ARP_CXX_SYMBOL_EXPORT std::ostream &	operator<< (std::ostream &os, ArDataAccessError value)

ARP_CXX_SYMBOL_EXPORT std::istream &	operator>> (std::istream &is, ArDataAccessError &value)

ARP_CXX_SYMBOL_EXPORT std::ostream &	operator<< (std::ostream &os, ChannelQualifier value)

ARP_CXX_SYMBOL_EXPORT std::istream &	operator>> (std::istream &is, ChannelQualifier &value)

ARP_CXX_SYMBOL_EXPORT std::ostream &	operator<< (std::ostream &os, DiagnosisDirection value)

ARP_CXX_SYMBOL_EXPORT std::istream &	operator>> (std::istream &is, DiagnosisDirection &value)

ARP_CXX_SYMBOL_EXPORT std::ostream &	operator<< (std::ostream &os, FilterLevel value)

ARP_CXX_SYMBOL_EXPORT std::istream &	operator>> (std::istream &is, FilterLevel &value)

Detailed Description

Namespace for Profinet I/O controller services

Enumeration Type Documentation

◆ ArDataAccessError

enum Arp::Io::ProfinetStack::Controller::Services::ArDataAccessError : uint8

strong

This enumeration contains the possible data access errors.

Enumerator
None	No error.
NotExists	The port/variable does not exist.
NotAuthorized	The user is not authorized.
TypeMismatch	During a write operation the type of the value is not suitable for the particular port. The Arp.Io.ProfinetStack.Controller.Services.IArDataService does not convert types. The type of each value which is to be written needs to be suitable for the particular port.
AttributeNameSyntaxError	The name of the attribute as given during a write or read operation is syntactically not correct. For example the attribute name contains an index range.
PortNameSemanticError	The semantic of the name of the attribute as given during a write or read operation is semantically not correct. For example the attribute name contains an index range with a start index not lower than the end index.
IndexOutOfRange	The attribute name contains an index which is out of range. For example a the attribute is addressed as if it was a
NotImplemented	The attribute type is not implemented yet.
NotSupported	The attribute type is not supported.

◆ ChannelQualifier

enum Arp::Io::ProfinetStack::Controller::Services::ChannelQualifier : uint32

strong

Describes diagnosis severity.

Enumerator
Qualifier3	Qualifier 3
Qualifier4	Qualifier 4
Qualifier5	Qualifier 5
Qualifier6	Qualifier 6
Qualifier7	Qualifier 7
Qualifier8	Qualifier 8
Qualifier9	Qualifier 9
Qualifier10	Qualifier 10
Qualifier11	Qualifier 11
Qualifier12	Qualifier 12
Qualifier13	Qualifier 13
Qualifier14	Qualifier 14
Qualifier15	Qualifier 15
Qualifier16	Qualifier 16
Qualifier17	Qualifier 17
Qualifier18	Qualifier 18
Qualifier19	Qualifier 19
Qualifier20	Qualifier 20
Qualifier21	Qualifier 21
Qualifier22	Qualifier 22
Qualifier23	Qualifier 23
Qualifier24	Qualifier 24
Qualifier25	Qualifier 25
Qualifier26	Qualifier 26
Qualifier27	Qualifier 27
Qualifier28	Qualifier 28
Qualifier29	Qualifier 29
Qualifier30	Qualifier 30
Qualifier31	Qualifier 31
Normal	Normal severity, used if diagnosis is not QualifiedChannelDiagnosis
Advice	Normal severity with Advice, used if diagnosis is not QualifiedChannelDiagnosis
MaintenanceRequired	Maintenance required, used if diagnosis is not QualifiedChannelDiagnosis
MaintenanceDemanded	Maintenance demanded, used if diagnosis is not QualifiedChannelDiagnosis
Fault	Fault, used if diagnosis is not QualifiedChannelDiagnosis

◆ DiagnosisDirection

enum Arp::Io::ProfinetStack::Controller::Services::DiagnosisDirection : uint16

strong

Contains the defined values for the direction of a submodule channel

Enumerator
ManufacturerSpecific	Manufacturer specific direction
Input	Input direction
output	Output direction
InputOutput	Input/Output direction

◆ FilterLevel

enum Arp::Io::ProfinetStack::Controller::Services::FilterLevel : int32

strong

Used to determine which values of Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource are used to filter diagnoses.

Enumerator
None	All stored diagnoses sources will be returned.
AR	All stored diagnoses sources related to one AR will be returned. The field Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.ARUserID has to be set.
Module	All stored diagnoses sources of one module will be returned. The Fields Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.ARUserID, Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.API and Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.Slot have to be set.
Submodule	All stored diagnoses sources of one submodule will be returned. The Fields Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.ARUserID, Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.Slot, Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.API and Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.Subslot have to be set.
Channel	Returns the diagnosis source of one channel. The channel is identified by Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.ARUserID, Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.Slot, Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.Slot, Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.Subslot, Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.ChannelNumber, Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.Accumulative and Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.Direction.
NodeID	Returns all diagnoses sources of one submodule identified by Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource.NodeID.

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ ArDataAccessError

◆ ChannelQualifier

◆ DiagnosisDirection

◆ FilterLevel