PLCnext API Documentation  22.9.0.33
IArDataService.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include <vector>
9 #include "Arp/Io/ProfinetStack/Controller/Services/ArDataResult.hpp"
10 #include "Arp/Io/ProfinetStack/Controller/Services/ArDataServiceProxyFactory.hpp"
11 #include "Arp/Io/ProfinetStack/Controller/Services/ArInfo.hpp"
12 #include "Arp/Io/ProfinetStack/Controller/Services/DiagnosticResult.hpp"
13 #include "Arp/System/Core/delegate.hxx"
14 #include "Arp/System/Rsc/Services/IRscReadEnumerator.hxx"
15 #include "Arp/System/Rsc/Services/IRscService.hpp"
16 #include "Arp/System/Rsc/Services/IRscWriteEnumerator.hxx"
17 #include "Arp/System/Rsc/Services/RscString.hxx"
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 
32 {
33 public: // typedefs
34  using Ptr = std::shared_ptr<IArDataService>;
35  using GetAllArAttributeNamesResultDelegate = delegate<void(IRscReadEnumerator<RscString<256>>&)>;
36  using GetAllArInfoResultDelegate = delegate<void(IRscReadEnumerator<ArInfo>&)>;
37  using GetAttributeValuesAttributeNameDelegate = delegate<void(IRscWriteEnumerator<RscString<256>>&)>;
38  using GetAttributeValuesResultDelegate = delegate<void(IRscReadEnumerator<ArDataResult>&)>;
39 
40 public: // construction/destruction
42  IArDataService(void) = default;
43 
44 public: // static policy operation
45  static IRscServiceProxyFactory& GetProxyFactory(void);
46 
47 public: // abstract operations
52  virtual void GetAllArInfo(GetAllArInfoResultDelegate resultDelegate) = 0;
53 
59  virtual void GetAllArAttributeNames(uint16 arUserId, GetAllArAttributeNamesResultDelegate resultDelegate) = 0;
60 
67  virtual ArDataResult GetAttributeValue(uint16 arUserId, const RscString<256>& attributeName) = 0;
68 
75  virtual void GetAttributeValues(uint16 arUserId, GetAttributeValuesAttributeNameDelegate attributeNameDelegate, GetAttributeValuesResultDelegate resultDelegate) = 0;
76 
82  virtual std::vector<DiagnosticResult> GetArDiagnosis(const std::vector<uint16>& arUserId) = 0;
83 };
84 
86 // inline methods of class IArDataService
87 inline IRscServiceProxyFactory& IArDataService::GetProxyFactory()
88 {
89  return ArDataServiceProxyFactory::GetInstance();
90 }
91 
92 }}}}} // end of namespace Arp::Io::ProfinetStack::Controller::Services
Container for a combination of an error code and a value which is a result for a read operation to a ...
Definition: ArDataResult.hpp:30
Use this service to manage PROFINET Controller Application Relationships (AR)
Definition: IArDataService.hpp:32
IArDataService(void)=default
Constructs an IArDataService instance.
virtual void GetAllArInfo(GetAllArInfoResultDelegate resultDelegate)=0
This method returns a list of ArInfo-objects with DNS-Name and AR-User-Id of each configured profinet...
virtual ArDataResult GetAttributeValue(uint16 arUserId, const RscString< 256 > &attributeName)=0
Read a single attribute value
virtual void GetAllArAttributeNames(uint16 arUserId, GetAllArAttributeNamesResultDelegate resultDelegate)=0
This method returns an array of strings with all available attributes of specified AR-User-Id of whic...
virtual void GetAttributeValues(uint16 arUserId, GetAttributeValuesAttributeNameDelegate attributeNameDelegate, GetAttributeValuesResultDelegate resultDelegate)=0
Read a list of attribute values
virtual std::vector< DiagnosticResult > GetArDiagnosis(const std::vector< uint16 > &arUserId)=0
Read an array of diagnosis information
Interface for reading an array or an enumerator. For regular enumerators UndefinedArrayLength is used...
Definition: IRscReadEnumerator.hxx:21
Base interface for all Rsc service interface.
Definition: IRscService.hpp:19
Interface for writing an array or an enumerator. For regular enumerators UndefinedArrayLength is used...
Definition: IRscWriteEnumerator.hxx:23
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:31
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:10
Root namespace for the PLCnext API