PLCnext API Documentation  22.3.0.20
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  using Ptr = std::shared_ptr<IDeviceControlService>;
27 
28 public: // construction/destruction
30  IDeviceControlService(void) = default;
31 
32 public: // static policy operation
33  static IRscServiceProxyFactory& GetProxyFactory(void);
34 
35 public: // abstract operations
39  virtual void RestartDevice() = 0;
40 
50  virtual AccessErrorCode ResetToFactoryDefaults(uint16 resetType) = 0;
51 
61  virtual AccessErrorCode StartFirmwareUpdate(uint16 updateType) = 0;
62 };
63 
65 // inline methods of class IDeviceControlService
66 inline IRscServiceProxyFactory& IDeviceControlService::GetProxyFactory()
67 {
68  return DeviceControlServiceProxyFactory::GetInstance();
69 }
70 
71 }}}} // 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
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