Arp::Io::Profibus::Services::IDiagnosisService Class Reference

Use this service to get diagnostic information on Profibus system and stations More...

#include <IDiagnosisService.hpp>

Inheritance diagram for Arp::Io::Profibus::Services::IDiagnosisService:

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

Public Member Functions
	IDiagnosisService (void)=default
	Constructs an IDiagnosisService instance.
virtual uint32	ReadStationDiagnosisItem (uint8 stationAddress, StationDiagnosisItem &stationDiagnoseItem)=0
	Reads new station diagnosis of a specific Profibus slave More...
virtual uint32	ReadStationDiagnosisItems (std::vector< StationDiagnosisItem > &stationDiagnoseItem)=0
	Reads new station diagnoses of all configured stations More...
virtual SystemVariables	GetSystemVariables ()=0
	Get Profibus system variables More...
virtual std::vector< uint8 >	GetStationAddresses ()=0
	Gets station addresses of all configured Profibus slaves 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

Use this service to get diagnostic information on Profibus system and stations

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

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

Member Function Documentation

GetStationAddresses()

virtual std::vector< uint8 > Arp::Io::Profibus::Services::IDiagnosisService::GetStationAddresses ( )

pure virtual

Gets station addresses of all configured Profibus slaves

Returns

Configured station addresses

GetSystemVariables()

virtual SystemVariables Arp::Io::Profibus::Services::IDiagnosisService::GetSystemVariables ( )

pure virtual

Get Profibus system variables

Returns

Structure with defined system variables

ReadStationDiagnosisItem()

virtual uint32 Arp::Io::Profibus::Services::IDiagnosisService::ReadStationDiagnosisItem ( uint8  stationAddress, StationDiagnosisItem &  stationDiagnoseItem  )

pure virtual

Reads new station diagnosis of a specific Profibus slave

Parameters

stationAddress	Contains station address of slave to read diagnosis from
stationDiagnoseItem	Contains station diagnosis if field StationAddress equals to parameter stationAddress. Otherwise no new diagnosis for station exists.

Returns

0 if no error occured. Otherwise the error code

ReadStationDiagnosisItems()

virtual uint32 Arp::Io::Profibus::Services::IDiagnosisService::ReadStationDiagnosisItems ( std::vector< StationDiagnosisItem > &  stationDiagnoseItem )

pure virtual

Reads new station diagnoses of all configured stations

Parameters

stationDiagnoseItem

Contains new diagnosis information

Returns

0 if no error occured. Otherwise the error code

---

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

• Arp/Io/Profibus/Services/IDiagnosisService.hpp