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

#include <IInterbusMasterService.hpp>

Inheritance diagram for Arp::Io::Interbus::Services::IInterbusMasterService:

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

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

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

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

virtual InterbusResult	CreateConfiguration (uint16 frameReference)=0
	This operation creates a new bus configuration depending on the connected devices and activates this configuration. More...

virtual InterbusResult	ReadConfiguration (std::vector< DeviceConfiguration > &configuration)=0
	This operation reads the current bus configuration of the master. More...

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

virtual InterbusResult	ActivateConfiguration (uint16 frameReference)=0
	This operation activates a stored bus configuration if the connected bus is identical to the configuration. If the configuration is not identical the service fails. More...

virtual InterbusResult	DeactivateConfiguration (uint16 frameReference)=0
	This operation deactivates the bus configuration. More...

virtual InterbusResult	StartDataTransfer ()=0
	This operation starts the cyclic data transfer. More...

virtual InterbusResult	StopDataTransfer ()=0
	This operation stops the cyclic data transfer. More...

virtual InterbusResult	AlarmStop ()=0
	This operation resets the Interbus master. The master sends a "Long Reset" to all devices. After that 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 Interbus master

The execution of services can take some time (depends on the service). For more information to the interbus bus see "IBS SYS FW G4 UM" and "IBS SYS DIAG DSC UM". For supported features see the documentation of the used master.

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

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 InterbusResult Arp::Io::Interbus::Services::IInterbusMasterService::ActivateConfiguration ( uint16 frameReference )

pure virtual

This operation activates a stored bus configuration if the connected bus is identical to the configuration. If the configuration is not identical the service fails.

Parameters

frameReference Frame reference: Value between 1..254, but only one frame is supported in this version.

Returns: Structure with error information. Arp.Io.Interbus.Services.InterbusResult

◆ AlarmStop()

virtual InterbusResult Arp::Io::Interbus::Services::IInterbusMasterService::AlarmStop ( )

pure virtual

This operation resets the Interbus master. The master sends a "Long Reset" to all devices. After that the master stops all operations, switches to READY and deletes all configuration data in the master.

Returns: Structure with error information. Arp.Io.Interbus.Services.InterbusResult

◆ CreateConfiguration()

virtual InterbusResult Arp::Io::Interbus::Services::IInterbusMasterService::CreateConfiguration ( uint16 frameReference )

pure virtual

This operation creates a new bus configuration depending on the connected devices and activates this configuration.

Parameters

frameReference Frame reference: Value between 1..254, but only one frame is supported in this version.

Returns: Structure with error information. Arp.Io.Interbus.Services.InterbusResult

◆ DeactivateConfiguration()

virtual InterbusResult Arp::Io::Interbus::Services::IInterbusMasterService::DeactivateConfiguration ( uint16 frameReference )

pure virtual

This operation deactivates the bus configuration.

Parameters

frameReference Frame reference: Value between 1..254, but only one frame is supported in this version..

Returns: Structure with error information. Arp.Io.Interbus.Services.InterbusResult

◆ InterbusControl()

virtual uint16 Arp::Io::Interbus::Services::IInterbusMasterService::InterbusControl	(	const std::vector< uint16 > &	inData,
		std::vector< uint16 > &	outData
	)

pure virtual

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

Parameters

inData	Request data to send to the Interbus master. Format has to be according to DDI specification.
outData	Response data received from the Interbus 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.

◆ ReadConfiguration()

virtual InterbusResult Arp::Io::Interbus::Services::IInterbusMasterService::ReadConfiguration ( std::vector< DeviceConfiguration > & configuration )

pure virtual

This operation reads the current bus configuration of the master.

Parameters

configuration List of Interbus devices Arp.Io.Interbus.Services.DeviceConfiguration

Returns: Structure with error information. Arp.Io.Interbus.Services.InterbusResult

◆ StartDataTransfer()

virtual InterbusResult Arp::Io::Interbus::Services::IInterbusMasterService::StartDataTransfer ( )

pure virtual

This operation starts the cyclic data transfer.

Returns: Structure with error information. Arp.Io.Interbus.Services.InterbusResult

◆ StopDataTransfer()

virtual InterbusResult Arp::Io::Interbus::Services::IInterbusMasterService::StopDataTransfer ( )

pure virtual

This operation stops the cyclic data transfer.

Returns: Structure with error information. Arp.Io.Interbus.Services.InterbusResult

◆ WriteConfiguration()

virtual InterbusResult Arp::Io::Interbus::Services::IInterbusMasterService::WriteConfiguration	(	uint16	frameReference,
		const std::vector< DeviceConfiguration > &	configuration
	)

pure virtual

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

Parameters

frameReference	Frame reference: Value between 1..254, but only one frame is supported in this version.
configuration	List of Interbus devices Arp.Io.Interbus.Services.DeviceConfiguration

Returns: Structure with error information. Arp.Io.Interbus.Services.InterbusResult

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

Arp/Io/Interbus/Services/IInterbusMasterService.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ ActivateConfiguration()

◆ AlarmStop()

◆ CreateConfiguration()

◆ DeactivateConfiguration()

◆ InterbusControl()

◆ ReadConfiguration()

◆ StartDataTransfer()

◆ StopDataTransfer()

◆ WriteConfiguration()