PLCnext API Documentation  22.6.0.43
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Arp::Io::Profibus::Services::IDiagnosisService Class Referenceabstract

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

#include <IDiagnosisService.hpp>

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

Public Types

using Ptr = std::shared_ptr< IDiagnosisService >
 
- Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscServicePtr
 

Public Member Functions

 IDiagnosisService (void)=default
 Constructs an IDiagnosisService instance. More...
 
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< uint8GetStationAddresses ()=0
 Gets station addresses of all configured Profibus slaves 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

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

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

Constructor & Destructor Documentation

◆ IDiagnosisService()

Arp::Io::Profibus::Services::IDiagnosisService::IDiagnosisService ( void  )
default

Constructs an IDiagnosisService instance.

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
stationAddressContains station address of slave to read diagnosis from
stationDiagnoseItemContains 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
stationDiagnoseItemContains new diagnosis information
Returns
0 if no error occured. Otherwise the error code

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