PLCnext API Documentation 23.6.0.37
IDeviceControlService.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
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
14namespace Arp { namespace Device { namespace Interface { namespace Services
15{
16
17using namespace Arp;
18using namespace Arp::System::Rsc::Services;
19
30{
31public: // typedefs
32 using Ptr = std::shared_ptr<IDeviceControlService>;
33
34public: // construction/destruction
36 IDeviceControlService(void) = default;
37
38public: // static policy operation
39 static IRscServiceProxyFactory& GetProxyFactory(void);
40
41public: // abstract operations
43 virtual void RestartDevice() = 0;
44
54
63};
64
66// inline methods of class IDeviceControlService
67inline IRscServiceProxyFactory& IDeviceControlService::GetProxyFactory()
68{
69 return DeviceControlServiceProxyFactory::GetInstance();
70}
71
72}}}} // end of namespace Arp::Device::Interface::Services
This service provides operations to control the device.
Definition: IDeviceControlService.hpp:30
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.
Base interface for all Rsc service interface.
Definition: IRscService.hpp:20
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:32
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
Root namespace for the PLCnext API