PLCnext API Documentation 23.6.0.37
ITextLookupService2.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
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/TextLookupService2ProxyFactory.hpp"
13#include "Arp/Io/ProfinetStack/Controller/Services/UsiDiagnosisDetailInformation.hpp"
14#include "Arp/Io/ProfinetStack/Controller/Services/UsiDiagnosisInformation.hpp"
15#include "Arp/System/Rsc/Services/IRscService.hpp"
16#include "Arp/System/Rsc/Services/RscString.hxx"
17
18// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY ITextLookupService2.cs
19
20namespace Arp { namespace Io { namespace ProfinetStack { namespace Controller { namespace Services
21{
22
23using namespace Arp;
24using namespace Arp::System::Rsc::Services;
25
35{
36public: // typedefs
37 using Ptr = std::shared_ptr<ITextLookupService2>;
38
39public: // construction/destruction
41 ITextLookupService2(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
94 virtual UsiDiagnosisDetailInformation GetUsiDiagnosisInfo(uint32 nodeID, const UsiDiagnosisInformation& usiDiagnosis, const RscString<6>& language = "") = 0;
95};
96
98// inline methods of class ITextLookupService2
99inline IRscServiceProxyFactory& ITextLookupService2::GetProxyFactory()
100{
101 return TextLookupService2ProxyFactory::GetInstance();
102}
103
104}}}}} // 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 including USI diagnosis texts...
Definition: ITextLookupService2.hpp:35
virtual ChannelErrorTypeInfo GetChannelErrorTypeInfo(uint32 nodeID, uint16 channelErrorType, uint16 extChannelErrorType=0, const RscString< 6 > &language="")=0
Gets the text and help to channelErrorType and extChannelErrorType
ITextLookupService2(void)=default
Constructs an ITextLookupService2 instance.
virtual DeviceIdentityInfo GetDeviceIdentityInfo(uint16 arUserID, const RscString< 6 > &language="")=0
Gets the vendor name and the device type name
virtual UsiDiagnosisDetailInformation GetUsiDiagnosisInfo(uint32 nodeID, const UsiDiagnosisInformation &usiDiagnosis, const RscString< 6 > &language="")=0
Gets the text information for a USI diagnosis.
virtual NodeIdentityInfo GetNodeIdentityInfo(uint32 nodeID, const RscString< 6 > &language="")=0
Gets the module and submodule type name
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
Contains the ident numbers and names the corresponding module and submodule of a node.
Definition: NodeIdentityInfo.hpp:25
Contains diagnosis information for an USI.
Definition: UsiDiagnosisDetailInformation.hpp:27
Contains informationen about diagnosis, that are not in standard format. These are dedicated to field...
Definition: UsiDiagnosisInformation.hpp:26
Base interface for all Rsc service interface.
Definition: IRscService.hpp:20
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:36
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