This service read and writes different configuration options to the profinet system. More...

Inheritance diagram for Arp::Io::ProfinetStack::System::Services::IConfigurationService:

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

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

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

virtual ConfigurationErrorCode	Read (const RscString< 512 > &name, RscVariant< 512 > &value)=0
	Reads one configuration from the profinet system. More...

virtual ConfigurationErrorCode	Write (const RscString< 512 > &name, const RscVariant< 512 > &value)=0
	Writes one configuration to the profinet system. More...

virtual RscString< 512 >	GetControllerName ()=0
	Gets the instance name of the profinet controller. If no controller is registered returns an empty string. More...

virtual std::vector< RscString< 512 > >	GetDeviceNames ()=0
	Gets the instance names of all registered profinet devices. 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

This service read and writes different configuration options to the profinet system.

Name	Value	R/W	Description
DeviceID	uint16	R/W	Reads or writes the DeviceID. The DeviceID is globally assigned to all PROFINET instances.
MRPMode	uint16 (0 - off; 1 - client)	R/W	Reads or sets the MRP mode
VendorID	uint16	R/W	Reads or writes the VendorID. The VendorID is globally assigned to all PROFINET instances.
`ComponentName/StationName`	String	R/W	Reads or writes the station name of the profinet instance defined by ComponentName

ComponentName has to be replaced by the name of profinet instance (Arp.Io.PnC or Arp.Io.PnD) e.g. Arp.Io.PnD/StationName.

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 RscString< 512 > Arp::Io::ProfinetStack::System::Services::IConfigurationService::GetControllerName ( )

pure virtual

Gets the instance name of the profinet controller. If no controller is registered returns an empty string.

virtual std::vector< RscString< 512 > > Arp::Io::ProfinetStack::System::Services::IConfigurationService::GetDeviceNames ( )

pure virtual

Gets the instance names of all registered profinet devices.

virtual ConfigurationErrorCode Arp::Io::ProfinetStack::System::Services::IConfigurationService::Read	(	const RscString< 512 > &	name,
		RscVariant< 512 > &	value
	)

pure virtual

Reads one configuration from the profinet system.

Parameters

name	Name of the configuration option. For a list of available options see the detailed description of Arp.Io.ProfinetStack.System.Services.IConfigurationService.
value	Contains the read value

Returns: If operation was successfull and result contains valid value returns None, else returns specific error code.

virtual ConfigurationErrorCode Arp::Io::ProfinetStack::System::Services::IConfigurationService::Write	(	const RscString< 512 > &	name,
		const RscVariant< 512 > &	value
	)

pure virtual

Writes one configuration to the profinet system.

Parameters

name	Name of the configuration option. For a list of available options see the detailed description of Arp.Io.ProfinetStack.System.Services.IConfigurationService.
value	Contains the value of the configuration option to write

Returns: If operation was successfull and value has been written returns None, else returns specific error code.

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