Arp::Io::Axioline::Services::IAxioMasterService Class Reference

Provides the access to the AXIO master More...

#include <IAxioMasterService.hpp>

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

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

Public Member Functions
	IAxioMasterService (void)
	Constructs an IAxioMasterService instance. More...
virtual	~IAxioMasterService (void)
	Destructs this instance and frees all resouces. More...
virtual uint16	AxioControl (const std::vector< uint16 > &inData, std::vector< uint16 > &outData)=0
	Raw AXIO service to communicate with the AXIO master. More...
virtual AxioResult	CreateConfiguration (uint16 frameReference)=0
	Automatic creation of a new configuration More...
virtual AxioResult	ReadConfiguration (uint16 frameReference, std::vector< AxioDeviceConfiguration > &configuration)=0
	Read current configuration More...
virtual AxioResult	WriteConfiguration (uint16 frameReference, const std::vector< AxioDeviceConfiguration > &configuration)=0
	Write configuration More...
virtual AxioResult	ActivateConfiguration (uint16 frameReference)=0
	Activate configuration More...
virtual AxioResult	DeactivateConfiguration (uint16 frameReference)=0
	Deactivate configuration More...
virtual AxioResult	ResetMaster ()=0
	Reset AXIO master 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 AXIO master

Constructor & Destructor Documentation

IAxioMasterService()

Arp::Io::Axioline::Services::IAxioMasterService::IAxioMasterService ( void  )

inline

Constructs an IAxioMasterService instance.

~IAxioMasterService()

Arp::Io::Axioline::Services::IAxioMasterService::~IAxioMasterService ( void  )

inlinevirtual

Destructs this instance and frees all resouces.

Member Function Documentation

ActivateConfiguration()

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

pure virtual

Activate configuration

Parameters

frameReference

Frame reference

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

Raw AXIO service to communicate with the AXIO master.

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

CreateConfiguration()

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

pure virtual

Automatic creation of a new configuration

Parameters

frameReference

Frame reference

Returns

Structure with error information.

DeactivateConfiguration()

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

pure virtual

Deactivate configuration

Parameters

frameReference

Frame reference

Returns

Structure with error information.

ReadConfiguration()

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

pure virtual

Read current configuration

Parameters

frameReference	Frame reference
configuration	Configuration of AXIO device Arp.Io.Axioline.Services.AxioDeviceConfiguration

Returns

Structure with error information.

ResetMaster()

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

pure virtual

Reset AXIO master

Returns

Structure with error information.

WriteConfiguration()

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

pure virtual

Write configuration

Parameters

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