Arp::Io::Interbus::Services::IInterbusMasterService Class Reference

Provides the access to the Interbus master More...

#include <IInterbusMasterService.hpp>

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

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

Public Member Functions
	IInterbusMasterService (void)
	Constructs an IInterbusMasterService instance. More...
virtual	~IInterbusMasterService (void)
	Destructs this instance and frees all resouces. More...
virtual uint16	InterbusControl (const std::vector< uint16 > &inData, std::vector< uint16 > &outData)=0
	Raw Interbus service to communicate with the AXIO master. More...
virtual InterbusResult	CreateConfiguration (uint16 frameReference)=0
	Automatic creation of a new configuration More...
virtual InterbusResult	ReadConfiguration (std::vector< DeviceConfiguration > &configuration)=0
	Read current configuration More...
virtual InterbusResult	WriteConfiguration (uint16 frameReference, const std::vector< DeviceConfiguration > &configuration)=0
	Write configuration More...
virtual InterbusResult	ActivateConfiguration (uint16 frameReference)=0
	Activate configuration More...
virtual InterbusResult	DeactivateConfiguration (uint16 frameReference)=0
	Deactivate configuration More...
virtual InterbusResult	StartDataTransfer ()=0
	Start cyclic data transfer More...
virtual InterbusResult	StopDataTransfer ()=0
	Stop cyclic data transfer More...
virtual InterbusResult	AlarmStop ()=0
	Trigger a long reset More...
Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
	IRscService (void)=default
	Constructs an IRscService instance. More...
virtual	~IRscService (void)=default
	Destructs this instance and frees all resouces. More...

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

Provides the access to the Interbus master

Constructor & Destructor Documentation

IInterbusMasterService()

Arp::Io::Interbus::Services::IInterbusMasterService::IInterbusMasterService ( void  )

inline

Constructs an IInterbusMasterService instance.

~IInterbusMasterService()

Arp::Io::Interbus::Services::IInterbusMasterService::~IInterbusMasterService ( void  )

inlinevirtual

Destructs this instance and frees all resouces.

Member Function Documentation

ActivateConfiguration()

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

pure virtual

Activate configuration

Parameters

frameReference

Frame reference

Returns

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

AlarmStop()

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

pure virtual

Trigger a long reset

Returns

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

CreateConfiguration()

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

pure virtual

Automatic creation of a new configuration

Parameters

frameReference

Frame reference

Returns

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

DeactivateConfiguration()

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

pure virtual

Deactivate configuration

Parameters

frameReference

Frame reference

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

Raw Interbus service to communicate with the AXIO master.

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 (0 = No error). Note: This service only returns internal errors. Negative confirmations have to be evaluated by user.

ReadConfiguration()

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

pure virtual

Read current configuration

Parameters

configuration

Configuration 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

Start cyclic data transfer

Returns

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

StopDataTransfer()

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

pure virtual

Stop 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

Write configuration

Parameters

frameReference	Frame reference
configuration	Configuration 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