PLCnext API Documentation 23.6.0.37
IArDataService.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
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
21namespace Arp { namespace Io { namespace ProfinetStack { namespace Controller { namespace Services
22{
23
24using namespace Arp;
25using namespace Arp::System::Rsc::Services;
26
35{
36public: // typedefs
37 using Ptr = std::shared_ptr<IArDataService>;
38 using GetAllArAttributeNamesResultDelegate = delegate<void(IRscReadEnumerator<RscString<256>>&)>;
39 using GetAllArInfoResultDelegate = delegate<void(IRscReadEnumerator<ArInfo>&)>;
40 using GetAttributeValuesAttributeNameDelegate = delegate<void(IRscWriteEnumerator<RscString<256>>&)>;
41 using GetAttributeValuesResultDelegate = delegate<void(IRscReadEnumerator<ArDataResult>&)>;
42
43public: // construction/destruction
45 IArDataService(void) = default;
46
47public: // static policy operation
48 static IRscServiceProxyFactory& GetProxyFactory(void);
49
50public: // abstract operations
55 virtual void GetAllArInfo(GetAllArInfoResultDelegate resultDelegate) = 0;
56
62 virtual void GetAllArAttributeNames(uint16 arUserId, GetAllArAttributeNamesResultDelegate resultDelegate) = 0;
63
70 virtual ArDataResult GetAttributeValue(uint16 arUserId, const RscString<256>& attributeName) = 0;
71
78 virtual void GetAttributeValues(uint16 arUserId, GetAttributeValuesAttributeNameDelegate attributeNameDelegate, GetAttributeValuesResultDelegate resultDelegate) = 0;
79
85 virtual std::vector<DiagnosticResult> GetArDiagnosis(const std::vector<uint16>& arUserId) = 0;
86};
87
89// inline methods of class IArDataService
90inline IRscServiceProxyFactory& IArDataService::GetProxyFactory()
91{
92 return ArDataServiceProxyFactory::GetInstance();
93}
94
95}}}}} // 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:35
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 std::vector< DiagnosticResult > GetArDiagnosis(const std::vector< uint16 > &arUserId)=0
Read an array of diagnosis information
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
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:20
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:32
Namespace for classes and interfaces for the Remote Service Call implementation
Root namespace for the PLCnext API