PLCnext API Documentation  22.9.0.33
IDeviceControlService.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include "Arp/Device/Interface/Services/AccessErrorCode.hpp"
9 #include "Arp/Device/Interface/Services/DeviceControlServiceProxyFactory.hpp"
10 #include "Arp/System/Rsc/Services/IRscService.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 
25 {
26 public: // typedefs
27  using Ptr = std::shared_ptr<IDeviceControlService>;
28 
29 public: // construction/destruction
31  IDeviceControlService(void) = default;
32 
33 public: // static policy operation
34  static IRscServiceProxyFactory& GetProxyFactory(void);
35 
36 public: // abstract operations
40  virtual void RestartDevice() = 0;
41 
52 
62  virtual AccessErrorCode StartFirmwareUpdate(uint16 updateType) = 0;
63 };
64 
66 // inline methods of class IDeviceControlService
67 inline IRscServiceProxyFactory& IDeviceControlService::GetProxyFactory()
68 {
69  return DeviceControlServiceProxyFactory::GetInstance();
70 }
71 
72 }}}} // end of namespace Arp::Device::Interface::Services
Use this service to control the device.
Definition: IDeviceControlService.hpp:25
virtual AccessErrorCode ResetToFactoryDefaults(uint16 resetType)=0
Reset device configuration
IDeviceControlService(void)=default
Constructs an IDeviceControlService instance.
virtual AccessErrorCode StartFirmwareUpdate(uint16 updateType)=0
Start FW update
virtual void RestartDevice()=0
Reboot the device
Base interface for all Rsc service interface.
Definition: IRscService.hpp:19
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:31
AccessErrorCode
Enumeration for error codes returned from Device.Interface.Services.
Definition: AccessErrorCode.hpp:19
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:10
Root namespace for the PLCnext API