This service offers methods to look up texts for the configured devices. The device specific texts need to be transfered with the project. This service only supports project related and system defined information. More...

#include <ITextLookupService.hpp>

Inheritance diagram for Arp::Io::ProfinetStack::Controller::Services::ITextLookupService:

Public Types
using	Ptr = std::shared_ptr< ITextLookupService >

Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscService >	Ptr

Public Member Functions
	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::System::Rsc::Services::IRscService
	IRscService (void)=default
	Constructs an IRscService instance.

virtual	~IRscService (void)=default
	Destructs this instance and frees all resouces.

Static Public Member Functions
static IRscServiceProxyFactory &	GetProxyFactory (void)

Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
static IRscServiceProxyFactory &	GetProxyFactory (void)
	Returns a reference to service proxy factory to create a proxy instance of the service More...

Detailed Description

This service offers methods to look up texts for the configured devices. 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.

Member Function Documentation

◆ GetChannelErrorTypeInfo()

virtual ChannelErrorTypeInfo Arp::Io::ProfinetStack::Controller::Services::ITextLookupService::GetChannelErrorTypeInfo	(	uint32	nodeID,
		uint16	channelErrorType,
		uint16	extChannelErrorType = `0`,
		const RscString< 6 > &	language = `""`
	)

pure virtual

Gets the text and help to channelErrorType and extChannelErrorType

If the name cannot be resolved, the service returns empty strings.

Parameters

nodeID	Node ID of the submodule. Throws if node ID ist unknown.
channelErrorType	Channel Error Type
extChannelErrorType	Extended channel error type. This is an optional parameter and can be ignored.
language	Language code. If left empty, primary language (English) is used.

Returns: Name and help texts of the given error types

◆ GetChannelProcessAlarmReasonInfo()

virtual ChannelProcessAlarmReasonInfo Arp::Io::ProfinetStack::Controller::Services::ITextLookupService::GetChannelProcessAlarmReasonInfo	(	uint32	nodeID,
		uint16	reason,
		uint16	extReason = `0`,
		const RscString< 6 > &	language = `""`
	)

pure virtual

Gets the text and help to process alarm reason and ext reason

If the name cannot be resolved, the service returns empty strings.

Parameters

nodeID	Node ID of the submodule. Throws if node ID ist unknown.
reason	Reason
extReason	Extended reason. This is an optional parameter and can be ignored.
language	Language code. If left empty, primary language (English) is used.

Returns: Name and help texts of the given reason

◆ GetDeviceIdentityInfo()

virtual DeviceIdentityInfo Arp::Io::ProfinetStack::Controller::Services::ITextLookupService::GetDeviceIdentityInfo	(	uint16	arUserID,
		const RscString< 6 > &	language = `""`
	)

pure virtual

Gets the vendor name and the device type name

Parameters

arUserID	Project specific user ID of the AR. Throws if ID is unknown.
language	Language code. If left empty, primary language (English) is used.

The arUserID can be read with the Arp.Io.ProfinetStack.Controller.Services.IArDataService

Returns: Vendor name and device type name

◆ GetNodeIdentityInfo()

virtual NodeIdentityInfo Arp::Io::ProfinetStack::Controller::Services::ITextLookupService::GetNodeIdentityInfo	(	uint32	nodeID,
		const RscString< 6 > &	language = `""`
	)

pure virtual

Gets the module and submodule type name

Parameters

nodeID	Node ID of the submodule. Throws if node ID ist unknown
language	Language code. If left empty, primary language (English) is used.

The node ID can be determined for a slot/sublot combination with the Arp.Io.ProfinetStack.Controller.Services.IAddressConversionService

Returns: Informationen about the node

The documentation for this class was generated from the following file:

Arp/Io/ProfinetStack/Controller/Services/ITextLookupService.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ GetChannelErrorTypeInfo()

◆ GetChannelProcessAlarmReasonInfo()

◆ GetDeviceIdentityInfo()

◆ GetNodeIdentityInfo()