PLCnext API Documentation 25.0.2.69
IDeviceControlService.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/Rsc/Commons/IRscService.hpp"
10#include "Arp/Device/Interface/Services/AccessErrorCode.hpp"
11
12// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IDeviceControlService.cs
13
15{
16
17using namespace Arp::Base::Rsc::Commons;
18
28class ARP_EXPORT IDeviceControlService : public IRscService
29{
30public: // usings
31 using Ptr = std::shared_ptr<IDeviceControlService>;
32
33public: // construction/destruction
35 IDeviceControlService(void) = default;
36
37public: // static policy operation
38 static IRscServiceProxyFactory& GetProxyFactory(void);
39
40public: // abstract operations
42 virtual void RestartDevice() = 0;
43
53
62};
63
64} // end of namespace Arp::Device::Interface::Services
This is the base interface of all Rsc services.
Definition: IRscService.hpp:22
std::shared_ptr< IRscService > Ptr
The shared_ptr type of IRscService.
Definition: IRscService.hpp:25
Interface for service proxy factories to create service proxies used by RSC clients.
Definition: IRscServiceProxyFactory.hpp:22
This service provides operations to control the device.
Definition: IDeviceControlService.hpp:29
virtual AccessErrorCode ResetToFactoryDefaults(uint16 resetType)=0
This operation resets the device configuration to factory default settings.
IDeviceControlService(void)=default
Constructs an IDeviceControlService instance.
virtual AccessErrorCode StartFirmwareUpdate(uint16 updateType)=0
This operation starts a firmware update.
virtual void RestartDevice()=0
This operation reboots the device.
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:29
Namespace for hardware abstraction services
AccessErrorCode
Enumeration for error codes returned from Device.Interface.Services.
Definition: AccessErrorCode.hpp:19