This service provides the access to the AXIO master. More...

#include <IAxioMasterService.hpp>

Inheritance diagram for Arp::Io::Axioline::Services::IAxioMasterService:

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

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

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

virtual uint16	AxioControl (const std::vector< uint16 > &inData, std::vector< uint16 > &outData)=0
	This operation gives raw access to AXIO service. A buffer with a service message is sent to the AXIO master and the received message is given in a buffer. More...

virtual AxioResult	CreateConfiguration (uint16 frameReference)=0
	This operation creates a new bus configuration depending on the connected devices and activates this configuration. The communication in the AXIO bus is started. More...

virtual AxioResult	ReadConfiguration (uint16 frameReference, std::vector< AxioDeviceConfiguration > &configuration)=0
	This operation reads the current bus configuration of the master. More...

virtual AxioResult	WriteConfiguration (uint16 frameReference, const std::vector< AxioDeviceConfiguration > &configuration)=0
	This operation writes an expected bus configuration to the AXIO master. More...

virtual AxioResult	ActivateConfiguration (uint16 frameReference)=0
	This operation activates a stored bus configuration if the connected bus is identical to the configuration. The communication in the AXIO bus is started. If the configuration is not identical the service fails. More...

virtual AxioResult	DeactivateConfiguration (uint16 frameReference)=0
	This operation deactivates the bus configuration. The communication in the AXIO bus is stopped. More...

virtual AxioResult	ResetMaster ()=0
	This operation resets the AXIO master. The master stops all operations, switches to READY and deletes all configuration data in the master. 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 provides the access to the AXIO master.

The execution of services can take some time (depends on the service). For more information to the Axioline bus see "UM EN AXL F SYS INST" and "UM DE AXL F SYS DIAG".

This service is defined in library Arp.Io.Axioline.

Realtime Usage: This API call does not have to be deterministic in runtime behaviour, so an asynchronous execution should be considered.

Member Function Documentation

◆ ActivateConfiguration()

virtual AxioResult Arp::Io::Axioline::Services::IAxioMasterService::ActivateConfiguration ( uint16 frameReference )

pure virtual

This operation activates a stored bus configuration if the connected bus is identical to the configuration. The communication in the AXIO bus is started. If the configuration is not identical the service fails.

Parameters

frameReference Frame reference, only 1 is supported in this version.

Returns: Structure with error information.

◆ AxioControl()

virtual uint16 Arp::Io::Axioline::Services::IAxioMasterService::AxioControl	(	const std::vector< uint16 > &	inData,
		std::vector< uint16 > &	outData
	)

pure virtual

This operation gives raw access to AXIO service. A buffer with a service message is sent to the AXIO master and the received message is given in a buffer.

Parameters

inData	Request data to send to the AXIO master. Format has to be according to DDI specification.
outData	Response data received from the AXIO master. Format is according to DDI specification.

Returns: Status value. If 0 send and receive were executed successfully. Other values show an error and the receive buffer is invalid. Note: This value returns only internal communication errors. The result of the service has to be evaluated by checking the confirmation.

◆ CreateConfiguration()

virtual AxioResult Arp::Io::Axioline::Services::IAxioMasterService::CreateConfiguration ( uint16 frameReference )

pure virtual

This operation creates a new bus configuration depending on the connected devices and activates this configuration. The communication in the AXIO bus is started.

Parameters

frameReference Frame reference, only 1 is supported.

Returns: Structure with error information.

◆ DeactivateConfiguration()

virtual AxioResult Arp::Io::Axioline::Services::IAxioMasterService::DeactivateConfiguration ( uint16 frameReference )

pure virtual

This operation deactivates the bus configuration. The communication in the AXIO bus is stopped.

Parameters

frameReference Frame reference, only 1 is supported in this version.

Returns: Structure with error information.

◆ ReadConfiguration()

virtual AxioResult Arp::Io::Axioline::Services::IAxioMasterService::ReadConfiguration	(	uint16	frameReference,
		std::vector< AxioDeviceConfiguration > &	configuration
	)

pure virtual

This operation reads the current bus configuration of the master.

Parameters

frameReference	Frame reference, only 1 is supported in this version.
configuration	List of AXIO devices. Arp.Io.Axioline.Services.AxioDeviceConfiguration

Returns: Structure with error information.

◆ ResetMaster()

virtual AxioResult Arp::Io::Axioline::Services::IAxioMasterService::ResetMaster ( )

pure virtual

This operation resets the AXIO master. The master stops all operations, switches to READY and deletes all configuration data in the master.

Returns: Structure with error information.

◆ WriteConfiguration()

virtual AxioResult Arp::Io::Axioline::Services::IAxioMasterService::WriteConfiguration	(	uint16	frameReference,
		const std::vector< AxioDeviceConfiguration > &	configuration
	)

pure virtual

This operation writes an expected bus configuration to the AXIO master.

Parameters

frameReference	Frame reference, only 1 is supported in this version.
configuration	List of AXIO devices. Arp.Io.Axioline.Services.AxioDeviceConfiguration

Returns: Structure with error information.

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

Arp/Io/Axioline/Services/IAxioMasterService.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ ActivateConfiguration()

◆ AxioControl()

◆ CreateConfiguration()

◆ DeactivateConfiguration()

◆ ReadConfiguration()

◆ ResetMaster()

◆ WriteConfiguration()