PLCnext API Documentation 25.0.2.69
IForceService.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 <vector>
11#include "Arp/Base/Rsc/Commons/RscString.hxx"
12#include "Arp/Plc/Gds/Services/DataAccessError.hpp"
13#include "Arp/Plc/Gds/Services/ForceItem.hpp"
14
15// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IForceService.cs
16
18{
19
20using namespace Arp::Base::Rsc::Commons;
21
32class ARP_EXPORT IForceService : public IRscService
33{
34public: // usings
35 using Ptr = std::shared_ptr<IForceService>;
36
37public: // construction/destruction
39 IForceService(void) = default;
40
41public: // static policy operation
42 static IRscServiceProxyFactory& GetProxyFactory(void);
43
44public: // abstract operations
61 virtual DataAccessError AddVariable(const ForceItem& item) = 0;
62
69 virtual void RemoveVariable(const RscString<512>& variableName) = 0;
70
77 virtual std::vector<ForceItem> GetVariables() = 0;
78
86 virtual void Reset() = 0;
87
99 virtual boolean IsForcable(const RscString<512>& variableName) = 0;
100
106 virtual boolean IsActive() = 0;
107};
108
109} // end of namespace Arp::Plc::Gds::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
A force item structure.
Definition: ForceItem.hpp:26
Service for managing and controlling force variables by the Arp GDS.
Definition: IForceService.hpp:33
IForceService(void)=default
Constructs an IForceService instance.
virtual std::vector< ForceItem > GetVariables()=0
Gets a list of all forced variables.
virtual DataAccessError AddVariable(const ForceItem &item)=0
Adds a new variable and value for forcing. Enables force mode.
virtual boolean IsActive()=0
Tests whether force mode is active.
virtual void RemoveVariable(const RscString< 512 > &variableName)=0
Resets forced variable. Disables force mode after force list is empty.
virtual void Reset()=0
Resets the force list. Disables force mode.
virtual boolean IsForcable(const RscString< 512 > &variableName)=0
Tests whether variable is forcable.
Namespace for services of the Global Data Space (GDS)
DataAccessError
This enumeration contains the possible data access errors.
Definition: DataAccessError.hpp:19