PLCnext API Documentation 25.0.2.69
ITextLookupService.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/Rsc/Commons/IRscService.hpp"
10#include "Arp/Base/Rsc/Commons/RscString.hxx"
11#include "Arp/Io/ProfinetStack/Controller/Services/ChannelErrorTypeInfo.hpp"
12#include "Arp/Io/ProfinetStack/Controller/Services/ChannelProcessAlarmReasonInfo.hpp"
13#include "Arp/Io/ProfinetStack/Controller/Services/DeviceIdentityInfo.hpp"
14#include "Arp/Io/ProfinetStack/Controller/Services/NodeIdentityInfo.hpp"
15
16// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY ITextLookupService.cs
17
19{
20
21using namespace Arp::Base::Rsc::Commons;
22
34class ARP_EXPORT ITextLookupService : public IRscService
35{
36public: // usings
37 using Ptr = std::shared_ptr<ITextLookupService>;
38
39public: // construction/destruction
41 ITextLookupService(void) = default;
42
43public: // static policy operation
44 static IRscServiceProxyFactory& GetProxyFactory(void);
45
46public: // abstract operations
54 virtual DeviceIdentityInfo GetDeviceIdentityInfo(uint16 arUserID, const RscString<6>& language = "") = 0;
55
63 virtual NodeIdentityInfo GetNodeIdentityInfo(uint32 nodeID, const RscString<6>& language = "") = 0;
64
74 virtual ChannelErrorTypeInfo GetChannelErrorTypeInfo(uint32 nodeID, uint16 channelErrorType, uint16 extChannelErrorType = 0, const RscString<6>& language = "") = 0;
75
85 virtual ChannelProcessAlarmReasonInfo GetChannelProcessAlarmReasonInfo(uint32 nodeID, uint16 reason, uint16 extReason = 0, const RscString<6>& language = "") = 0;
86};
87
88} // end of namespace Arp::Io::ProfinetStack::Controller::Services
This is the base interface of all Rsc services.
Definition: IRscService.hpp:22
std::shared_ptr< IRscService > Ptr
The shared_ptr type of IRscService.
Definition: IRscService.hpp:25
Contains a static string with string lentgh up to N characters. The string shall be null terminated.
Definition: RscString.hxx:24
Interface for service proxy factories to create service proxies used by RSC clients.
Definition: IRscServiceProxyFactory.hpp:22
This struct contains the name and help texts to a diagnosis error type.
Definition: ChannelErrorTypeInfo.hpp:27
This struct contains the name and help texts to a diagnosis process alarm reason.
Definition: ChannelProcessAlarmReasonInfo.hpp:27
This struct contains the vendor name and the device name of one device
Definition: DeviceIdentityInfo.hpp:27
This service offers methods to look up texts for the configured devices. The device specific texts ne...
Definition: ITextLookupService.hpp:35
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:27
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:33
std::uint16_t uint16
The Arp unsigned integer type of 2 byte size.
Definition: PrimitiveTypes.hpp:29
Namespace for Profinet I/O controller services