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

Namespace for hardware abstraction services More...

Classes

class  DeviceControlServiceProxy
 
class  DeviceControlServiceProxyFactory
 
class  DeviceInfoServiceFactory
 
class  DeviceInfoServiceProxyFactory
 
struct  DeviceSettingItem
 Container for a (relative) setting identifier with its value. More...
 
struct  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  DeviceSettingsServiceProxy
 
class  DeviceSettingsServiceProxyFactory
 
class  DeviceStatusServiceProxy
 
class  DeviceStatusServiceProxyFactory
 
class  IDeviceControlService
 Use this service to control the device. More...
 
class  IDeviceInfoService
 Use this service to read device information. More...
 
class  IDeviceSettingsService
 Use this service to read and write device settings. More...
 
class  IDeviceStatusService
 Use this service to read device states. More...
 

Enumerations

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

Functions

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

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