PLCnext API Documentation  22.3.0.20
ITextLookupService.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 "TextLookupServiceProxyFactory.hpp"
10 #include "Arp/System/Rsc/Services/RscString.hxx"
11 #include "ChannelErrorTypeInfo.hpp"
12 #include "ChannelProcessAlarmReasonInfo.hpp"
13 #include "DeviceIdentityInfo.hpp"
14 #include "NodeIdentityInfo.hpp"
15 
16 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY ITextLookupService.cs
17 
18 namespace Arp { namespace Io { namespace ProfinetStack { namespace Controller { namespace Services
19 {
20 
21 using namespace Arp;
22 using namespace Arp::System::Rsc::Services;
23 
32 {
33 public: // typedefs
34  using Ptr = std::shared_ptr<ITextLookupService>;
35 
36 public: // construction/destruction
38  ITextLookupService(void) = default;
39 
40 public: // static policy operation
41  static IRscServiceProxyFactory& GetProxyFactory(void);
42 
43 public: // abstract operations
51  virtual DeviceIdentityInfo GetDeviceIdentityInfo(uint16 arUserID, const RscString<6>& language = "") = 0;
52 
60  virtual NodeIdentityInfo GetNodeIdentityInfo(uint32 nodeID, const RscString<6>& language = "") = 0;
61 
71  virtual ChannelErrorTypeInfo GetChannelErrorTypeInfo(uint32 nodeID, uint16 channelErrorType, uint16 extChannelErrorType = 0, const RscString<6>& language = "") = 0;
72 
82  virtual ChannelProcessAlarmReasonInfo GetChannelProcessAlarmReasonInfo(uint32 nodeID, uint16 reason, uint16 extReason = 0, const RscString<6>& language = "") = 0;
83 };
84 
86 // inline methods of class ITextLookupService
87 inline IRscServiceProxyFactory& ITextLookupService::GetProxyFactory()
88 {
89  return TextLookupServiceProxyFactory::GetInstance();
90 }
91 
92 }}}}} // end of namespace Arp::Io::ProfinetStack::Controller::Services
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:9
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:35
This struct contains the vendor name and the device name of one device
Definition: DeviceIdentityInfo.hpp:24
Contains the ident numbers and names the corresponding module and submodule of a node.
Definition: NodeIdentityInfo.hpp:24
Root namespace for the PLCnext API
This struct contains the name and help texts to a diagnosis process alarm reason. ...
Definition: ChannelProcessAlarmReasonInfo.hpp:24
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
This struct contains the name and help texts to a diagnosis error type.
Definition: ChannelErrorTypeInfo.hpp:24
This service offers methods to look up texts for the configured devices. The device specific texts ne...
Definition: ITextLookupService.hpp:31
Contains a static string with string lentgh up to N characters. The string has to be null terminated...
Definition: RscString.hxx:18