Use this service for conversion of addresses and node IDs More...

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

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

Public Types inherited from Arp::Base::Rsc::Commons::IRscService
using	Ptr = std::shared_ptr< IRscService >
	The shared_ptr type of IRscService.

Public Member Functions
	IAddressConversionService (void)=default
	Constructs an IAddressConversionService instance.

virtual uint32	AddressToId (const ProfinetAddress &address, uint32 &id)=0
	Convert an address to a node ID More...

virtual uint32	IdToAddress (uint32 id, ProfinetAddress &address)=0
	Convert a node id to an address 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::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

Use this service for conversion of addresses and node IDs

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

virtual uint32 Arp::Io::ProfinetStack::Controller::Services::IAddressConversionService::AddressToId	(	const ProfinetAddress &	address,
		uint32 &	id
	)

pure virtual

Convert an address to a node ID

Parameters

address	Structure with all parameters of a PROFINET address Arp.Io.ProfinetStack.Controller.Services.ProfinetAddress
id	Node ID

virtual uint32 Arp::Io::ProfinetStack::Controller::Services::IAddressConversionService::IdToAddress	(	uint32	id,
		ProfinetAddress &	address
	)

pure virtual

Convert a node id to an address

Parameters

id	Node ID
address	Structure with all parameters of a PROFINET address Arp.Io.ProfinetStack.Controller.Services.ProfinetAddress

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