PLCnext API Documentation  21.0.0.35466
IDeviceControlService.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include "Arp/System/Rsc/Services/IRscService.hpp"
9 #include "DeviceControlServiceProxyFactory.hpp"
10 #include "AccessErrorCode.hpp"
11 
12 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IDeviceControlService.cs
13 
14 namespace Arp { namespace Device { namespace Interface { namespace Services
15 {
16 
17 using namespace Arp;
18 using namespace Arp::System::Rsc::Services;
19 
24 {
25 public: // typedefs
26  typedef std::shared_ptr<IDeviceControlService> Ptr;
27 
28 public: // construction/destruction
32  virtual ~IDeviceControlService(void);
33 
34 public: // static policy operation
35  static IRscServiceProxyFactory& GetProxyFactory(void);
36 
37 public: // abstract operations
41  virtual void RestartDevice() = 0;
42 
52  virtual AccessErrorCode ResetToFactoryDefaults(uint16 resetType) = 0;
53 
63  virtual AccessErrorCode StartFirmwareUpdate(uint16 updateType) = 0;
64 
65 private: // deleted methods (for non-copyable classes)
66  IDeviceControlService(const IDeviceControlService& arg) = delete;
67  IDeviceControlService& operator=(const IDeviceControlService& arg) = delete;
68 };
69 
71 // inline methods of class IDeviceControlService
73 {
74 }
75 
77 {
78 }
79 
80 inline IRscServiceProxyFactory& IDeviceControlService::GetProxyFactory()
81 {
82  return DeviceControlServiceProxyFactory::GetInstance();
83 }
84 
85 }}}} // end of namespace Arp::Device::Interface::Services
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:9
Use this service to control the device.
Definition: IDeviceControlService.hpp:23
IDeviceControlService(void)
Constructs an IDeviceControlService instance.
Definition: IDeviceControlService.hpp:72
virtual ~IDeviceControlService(void)
Destructs this instance and frees all resouces.
Definition: IDeviceControlService.hpp:76
Root namespace for the PLCnext API
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:31
Base interface for all Rsc service interface.
Definition: IRscService.hpp:18
AccessErrorCode
Enumeration for error codes returned from Device.Interface.Services.
Definition: AccessErrorCode.hpp:20