PLCnext API Documentation  22.3.0.20
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  using Ptr = std::shared_ptr<IArDataService>;
34  using GetAllArInfoResultDelegate = delegate<void(IRscReadEnumerator<ArInfo>&)>;
35  using GetAllArAttributeNamesResultDelegate = delegate<void(IRscReadEnumerator<RscString<256>>&)>;
36  using GetAttributeValuesAttributeNameDelegate = delegate<void(IRscWriteEnumerator<RscString<256>>&)>;
37  using GetAttributeValuesResultDelegate = delegate<void(IRscReadEnumerator<ArDataResult>&)>;
38 
39 public: // construction/destruction
41  IArDataService(void) = default;
42 
43 public: // static policy operation
44  static IRscServiceProxyFactory& GetProxyFactory(void);
45 
46 public: // abstract operations
51  virtual void GetAllArInfo(GetAllArInfoResultDelegate resultDelegate) = 0;
52 
58  virtual void GetAllArAttributeNames(uint16 arUserId, GetAllArAttributeNamesResultDelegate resultDelegate) = 0;
59 
66  virtual ArDataResult GetAttributeValue(uint16 arUserId, const RscString<256>& attributeName) = 0;
67 
74  virtual void GetAttributeValues(uint16 arUserId, GetAttributeValuesAttributeNameDelegate attributeNameDelegate, GetAttributeValuesResultDelegate resultDelegate) = 0;
75 
81  virtual std::vector<DiagnosticResult> GetArDiagnosis(const std::vector<uint16>& arUserId) = 0;
82 };
83 
85 // inline methods of class IArDataService
86 inline IRscServiceProxyFactory& IArDataService::GetProxyFactory()
87 {
88  return ArDataServiceProxyFactory::GetInstance();
89 }
90 
91 }}}}} // end of namespace Arp::Io::ProfinetStack::Controller::Services
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:9
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
Use this service to manage PROFINET Controller Application Relationships (AR)
Definition: IArDataService.hpp:30
Root namespace for the PLCnext API
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