PLCnext API Documentation 25.0.2.69
Classes | Enumerations | Functions
Arp::Device::Interface::Services Namespace Reference

Namespace for hardware abstraction services More...

Classes

class  DeviceSettingItem
 Container for a (relative) setting identifier with its value. More...
 
class  DeviceSettingResult
 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  IDeviceControlService
 This service provides operations to control the device. More...
 
class  IDeviceInfoService
 This service provides operations to read static information from the device. More...
 
class  IDeviceSettingsService
 This service provides operations to read and write settings from resp. to the device. More...
 
class  IDeviceStatusService
 This service provides operations to read status information from the device. More...
 

Enumerations

enum class  AccessErrorCode : int32 {
  None = 0 , UnknownError = 1 , UnknownSetting = 2 , AuthorizationFailure = 3 ,
  IncompatibleType = 4 , InvalidFormat = 5 , InvalidParameter = 6 , OutOfRange = 7
}
 Enumeration for error codes returned from Device.Interface.Services. More...
 

Functions

ARP_EXPORT std::ostream & operator<< (std::ostream &os, AccessErrorCode value)
 
ARP_EXPORT std::istream & operator>> (std::istream &is, AccessErrorCode &value)
 

Detailed Description

Namespace for hardware abstraction services

Enumeration Type Documentation

◆ AccessErrorCode

Enumeration for error codes returned from Device.Interface.Services.

Enumerator
None 

Success

UnknownError 

Unkown Error

UnknownSetting 

Unknown setting id

AuthorizationFailure 

Authorization failure

IncompatibleType 

The type of the new value is wrong

InvalidFormat 

The format of the new value is wrong

InvalidParameter 

A parameter is invalid

OutOfRange 

A value is out of range