PLCnext API Documentation  22.9.0.33
ITextLookupService.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include "Arp/Io/ProfinetStack/Controller/Services/ChannelErrorTypeInfo.hpp"
9 #include "Arp/Io/ProfinetStack/Controller/Services/ChannelProcessAlarmReasonInfo.hpp"
10 #include "Arp/Io/ProfinetStack/Controller/Services/DeviceIdentityInfo.hpp"
11 #include "Arp/Io/ProfinetStack/Controller/Services/NodeIdentityInfo.hpp"
12 #include "Arp/Io/ProfinetStack/Controller/Services/TextLookupServiceProxyFactory.hpp"
13 #include "Arp/System/Rsc/Services/IRscService.hpp"
14 #include "Arp/System/Rsc/Services/RscString.hxx"
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 
33 {
34 public: // typedefs
35  using Ptr = std::shared_ptr<ITextLookupService>;
36 
37 public: // construction/destruction
39  ITextLookupService(void) = default;
40 
41 public: // static policy operation
42  static IRscServiceProxyFactory& GetProxyFactory(void);
43 
44 public: // abstract operations
52  virtual DeviceIdentityInfo GetDeviceIdentityInfo(uint16 arUserID, const RscString<6>& language = "") = 0;
53 
61  virtual NodeIdentityInfo GetNodeIdentityInfo(uint32 nodeID, const RscString<6>& language = "") = 0;
62 
72  virtual ChannelErrorTypeInfo GetChannelErrorTypeInfo(uint32 nodeID, uint16 channelErrorType, uint16 extChannelErrorType = 0, const RscString<6>& language = "") = 0;
73 
83  virtual ChannelProcessAlarmReasonInfo GetChannelProcessAlarmReasonInfo(uint32 nodeID, uint16 reason, uint16 extReason = 0, const RscString<6>& language = "") = 0;
84 };
85 
87 // inline methods of class ITextLookupService
88 inline IRscServiceProxyFactory& ITextLookupService::GetProxyFactory()
89 {
90  return TextLookupServiceProxyFactory::GetInstance();
91 }
92 
93 }}}}} // end of namespace Arp::Io::ProfinetStack::Controller::Services
This struct contains the name and help texts to a diagnosis error type.
Definition: ChannelErrorTypeInfo.hpp:25
This struct contains the name and help texts to a diagnosis process alarm reason.
Definition: ChannelProcessAlarmReasonInfo.hpp:25
This struct contains the vendor name and the device name of one device
Definition: DeviceIdentityInfo.hpp:25
This service offers methods to look up texts for the configured devices. The device specific texts ne...
Definition: ITextLookupService.hpp:33
ITextLookupService(void)=default
Constructs an ITextLookupService instance.
virtual DeviceIdentityInfo GetDeviceIdentityInfo(uint16 arUserID, const RscString< 6 > &language="")=0
Gets the vendor name and the device type name
virtual ChannelErrorTypeInfo GetChannelErrorTypeInfo(uint32 nodeID, uint16 channelErrorType, uint16 extChannelErrorType=0, const RscString< 6 > &language="")=0
Gets the text and help to channelErrorType and extChannelErrorType
virtual ChannelProcessAlarmReasonInfo GetChannelProcessAlarmReasonInfo(uint32 nodeID, uint16 reason, uint16 extReason=0, const RscString< 6 > &language="")=0
Gets the text and help to process alarm reason and ext reason
virtual NodeIdentityInfo GetNodeIdentityInfo(uint32 nodeID, const RscString< 6 > &language="")=0
Gets the module and submodule type name
Contains the ident numbers and names the corresponding module and submodule of a node.
Definition: NodeIdentityInfo.hpp:25
Base interface for all Rsc service interface.
Definition: IRscService.hpp:19
Contains a static string with string lentgh up to N characters. The string has to be null terminated.
Definition: RscString.hxx:21
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:35
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