PLCnext API Documentation 25.0.2.69
IDataAccessService.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/Base/Rsc/Commons/IRscReadEnumerator.hxx"
11#include "Arp/Base/Rsc/Commons/IRscWriteEnumerator.hxx"
12#include "Arp/Base/Core/delegate.hxx"
13#include "Arp/Base/Rsc/Commons/RscString.hxx"
14#include "Arp/Plc/Gds/Services/DataAccessError.hpp"
15#include "Arp/Plc/Gds/Services/ReadItem.hpp"
16#include "Arp/Plc/Gds/Services/WriteItem.hpp"
17
18// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IDataAccessService.cs
19
21{
22
23using namespace Arp::Base::Rsc::Commons;
24
72class ARP_EXPORT IDataAccessService : public IRscService
73{
74public: // usings
75 using Ptr = std::shared_ptr<IDataAccessService>;
80
81public: // construction/destruction
83 IDataAccessService(void) = default;
84
85public: // static policy operation
86 static IRscServiceProxyFactory& GetProxyFactory(void);
87
88public: // abstract operations
109 virtual ReadItem ReadSingle(const RscString<512>& portName) = 0;
110
130 virtual void Read(ReadPortNamesDelegate portNamesDelegate, ReadResultDelegate resultDelegate) = 0;
131
152 virtual DataAccessError WriteSingle(const WriteItem& data) = 0;
153
173 virtual void Write(WriteDataDelegate dataDelegate, WriteResultDelegate resultDelegate) = 0;
174};
175
176} // end of namespace Arp::Plc::Gds::Services
Prototyping of delegate template.
Definition: delegate.hxx:14
Interface for reading a arrays or enumerations.
Definition: IRscReadEnumerator.hxx:19
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 writing an array enumeration or enumeration of unspefied length.
Definition: IRscWriteEnumerator.hxx:20
Interface for service proxy factories to create service proxies used by RSC clients.
Definition: IRscServiceProxyFactory.hpp:22
Services for the direct data access.
Definition: IDataAccessService.hpp:73
virtual void Write(WriteDataDelegate dataDelegate, WriteResultDelegate resultDelegate)=0
Writes the given values to the given variables containing in the given Arp.Plc.Gds....
IDataAccessService(void)=default
Constructs an IDataAccessService instance.
virtual void Read(ReadPortNamesDelegate portNamesDelegate, ReadResultDelegate resultDelegate)=0
Reads the variable values directly from the given variable names.
virtual ReadItem ReadSingle(const RscString< 512 > &portName)=0
Reads the value of the variable directly from the given variable name.
virtual DataAccessError WriteSingle(const WriteItem &data)=0
Writes the given value to the given variable name containing in the given Arp.Plc....
Stores the data to be read, written by the controller and a possible data access error.
Definition: ReadItem.hpp:29
Stores the to be written data and the related variable name to be write to.
Definition: WriteItem.hpp:29
Namespace for services of the Global Data Space (GDS)
DataAccessError
This enumeration contains the possible data access errors.
Definition: DataAccessError.hpp:19