PLCnext API Documentation  20.0.0.24462
IArDataService.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include "Arp/System/Rsc/Services/IRscService.hpp"
9 #include "ArDataServiceProxyFactory.hpp"
10 #include "ArDataResult.hpp"
11 #include "ArInfo.hpp"
12 #include "Arp/System/Core/delegate.hxx"
13 #include "Arp/System/Rsc/Services/IRscReadEnumerator.hxx"
14 #include "Arp/System/Rsc/Services/IRscWriteEnumerator.hxx"
15 #include "Arp/System/Rsc/Services/RscString.hxx"
16 #include "DiagnosticResult.hpp"
17 #include <vector>
18 
19 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IArDataService.cs
20 
21 namespace Arp { namespace Io { namespace ProfinetStack { namespace Controller { namespace Services
22 {
23 
24 using namespace Arp;
25 using namespace Arp::System::Rsc::Services;
26 
31 {
32 public: // typedefs
33  typedef std::shared_ptr<IArDataService> Ptr;
34  typedef delegate<void(IRscReadEnumerator<ArInfo>&)> GetAllArInfoResultDelegate;
35  typedef delegate<void(IRscReadEnumerator<RscString<256>>&)> GetAllArAttributeNamesResultDelegate;
36  typedef delegate<void(IRscWriteEnumerator<RscString<256>>&)> GetAttributeValuesAttributeNameDelegate;
37  typedef delegate<void(IRscReadEnumerator<ArDataResult>&)> GetAttributeValuesResultDelegate;
38 
39 public: // construction/destruction
41  IArDataService(void);
43  virtual ~IArDataService(void);
44 
45 public: // static policy operation
46  static IRscServiceProxyFactory& GetProxyFactory(void);
47 
48 public: // abstract operations
53  virtual void GetAllArInfo(GetAllArInfoResultDelegate resultDelegate) = 0;
54 
60  virtual void GetAllArAttributeNames(uint16 arUserId, GetAllArAttributeNamesResultDelegate resultDelegate) = 0;
61 
68  virtual ArDataResult GetAttributeValue(uint16 arUserId, const RscString<256>& attributeName) = 0;
69 
76  virtual void GetAttributeValues(uint16 arUserId, GetAttributeValuesAttributeNameDelegate attributeNameDelegate, GetAttributeValuesResultDelegate resultDelegate) = 0;
77 
83  virtual std::vector<DiagnosticResult> GetArDiagnosis(const std::vector<uint16>& arUserId) = 0;
84 
85 private: // deleted methods (for non-copyable classes)
86  IArDataService(const IArDataService& arg) = delete;
87  IArDataService& operator=(const IArDataService& arg) = delete;
88 };
89 
91 // inline methods of class IArDataService
93 {
94 }
95 
97 {
98 }
99 
100 inline IRscServiceProxyFactory& IArDataService::GetProxyFactory()
101 {
102  return ArDataServiceProxyFactory::GetInstance();
103 }
104 
105 }}}}} // end of namespace Arp::Io::ProfinetStack::Controller::Services
Namespace for classes and interfaces for the Remote Service Call implementation
Use this service to manage PROFINET Controller Application Relationships (AR)
Definition: IArDataService.hpp:30
IArDataService(void)
Constructs an IArDataService instance.
Definition: IArDataService.hpp:92
Root namespace for the PLCnext API
virtual ~IArDataService(void)
Destructs this instance and frees all resouces.
Definition: IArDataService.hpp:96
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:31
Base interface for all Rsc service interface.
Definition: IRscService.hpp:18
Container for a combination of an error code and a value which is a result for a read operation to a ...
Definition: ArDataResult.hpp:29