This service offers methods to look up texts for the configured devices including USI diagnosis texts. The device specific texts need to be transfered with the project. This service only supports project related and system defined information. More...
#include <ITextLookupService2.hpp>
Public Types | |
| using | Ptr = std::shared_ptr< ITextLookupService2 > |
 Public Types inherited from Arp::Io::ProfinetStack::Controller::Services::ITextLookupService | |
| using | Ptr = std::shared_ptr< ITextLookupService > |
| Public Types inherited from Arp::Base::Rsc::Commons::IRscService | |
| using | Ptr = std::shared_ptr< IRscService > |
| The shared_ptr type of IRscService. | |
Public Member Functions | |
| ITextLookupService2 (void)=default | |
| Constructs an ITextLookupService2 instance. | |
| virtual UsiDiagnosisDetailInformation | GetUsiDiagnosisInfo (uint32 nodeID, const UsiDiagnosisInformation &usiDiagnosis, const RscString< 6 > &language="")=0 |
| Gets the text information for a USI diagnosis. More... | |
| Public Member Functions inherited from Arp::Io::ProfinetStack::Controller::Services::ITextLookupService | |
| 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 More... | |
| virtual NodeIdentityInfo | GetNodeIdentityInfo (uint32 nodeID, const RscString< 6 > &language="")=0 |
| Gets the module and submodule type name More... | |
| virtual ChannelErrorTypeInfo | GetChannelErrorTypeInfo (uint32 nodeID, uint16 channelErrorType, uint16 extChannelErrorType=0, const RscString< 6 > &language="")=0 |
| Gets the text and help to channelErrorType and extChannelErrorType More... | |
| 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 More... | |
| Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService | |
| IRscService (void)=default | |
| The default constructor. | |
| IRscService (const IRscService &arg)=delete | |
| The deleted copy constructor. More... | |
| IRscService (IRscService &&arg) noexcept=default | |
| The default move constructor. More... | |
| IRscService & | operator= (const IRscService &arg)=delete |
| The deleted assignment operator. More... | |
| IRscService & | operator= (IRscService &&arg) noexcept=default |
| The default move-assignment operator. More... | |
| virtual | ~IRscService (void)=default |
| Destructs this instance and frees all resources. | |
Static Public Member Functions | |
| static IRscServiceProxyFactory & | GetProxyFactory (void) |
| Static Public Member Functions inherited from Arp::Io::ProfinetStack::Controller::Services::ITextLookupService | |
| static IRscServiceProxyFactory & | GetProxyFactory (void) |
| Static Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService | |
| static IRscServiceProxyFactory & | GetProxyFactory (void) |
| Returns a reference to service proxy factory to create a proxy instance of this service. More... | |
Detailed Description
This service offers methods to look up texts for the configured devices including USI diagnosis texts. The device specific texts need to be transfered with the project. This service only supports project related and system defined information.
If the given id is unknown, an exception is thrown. If the id is known but the text string not available a substitute value is returned.
This service is defined in library Arp.Io.ProfinetStack.
Realtime Usage: This API call does not have to be deterministic in runtime behaviour, so an asynchronous execution should be considered.
Member Function Documentation
◆ GetUsiDiagnosisInfo()
|
pure virtual |
Gets the text information for a USI diagnosis.
- Parameters
-
nodeID Node ID of the submodule. Throws if node ID ist unknown. usiDiagnosis USI diagnosis data. language Language code. If left empty, primary language (English) is used.
- Returns
- Detailed information about the USI diagnosis.
The documentation for this class was generated from the following file:
- Arp/Io/ProfinetStack/Controller/Services/ITextLookupService2.hpp
