This services allows access to the diagnosis informationen of the subordinated devices. The diagnosis information of the related submodules are shadowed in a local data base. More...
#include <IDiagnosisQueryService.hpp>
Public Types | |
| using | Ptr = std::shared_ptr< IDiagnosisQueryService > |
 Public Types inherited from Arp::System::Rsc::Services::IRscService | |
| typedef std::shared_ptr< IRscService > | Ptr |
Public Member Functions | |
| IDiagnosisQueryService (void)=default | |
| Constructs an IDiagnosisQueryService instance. | |
| virtual std::vector< DiagnosisItem > | Query (const DiagnosisSource &source, FilterLevel filterLevel=FilterLevel::None, ChannelQualifier filterSeverity=ChannelQualifier::Normal)=0 |
| Gets all diagnoses filtered by !:filterLevel and !:filterSeverity; 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 services allows access to the diagnosis informationen of the subordinated devices. The diagnosis information of the related submodules are shadowed in a local data base.
This service is defined in library Arp.Io.ProfinetStack.
Realtime Usage: This API call does not have to be deterministic in runtime behaviour, so an asynchronous execution should be considered.
Member Function Documentation
◆ Query()
|
pure virtual |
Gets all diagnoses filtered by !:filterLevel and !:filterSeverity;
- Parameters
-
source Contains additional information for the filterLevel. The relevant values of Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource depends on the set Arp.Io.ProfinetStack.Controller.Services.FilterLevel filterLevel Filters the diagnoses by the level of the device (AR, module, submodule). If set to Arp.Io.ProfinetStack.Controller.Services.FilterLevel.None all ARs are searched. filterSeverity Filters the diagnoses by severity. The method returns only diagnoses with the set or higher severities
- Returns
- All diagnosis sources, that fullfills the filter criteria
<hint> If all diagnosis sources and diagnoses that are currently stored in the diagnosis database are required, the filterLevel needs to be set to Arp.Io.ProfinetStack.Controller.Services.FilterLevel.None and the filterSeverity needs to be set Arp.Io.ProfinetStack.Controller.Services.ChannelQualifier.Normal</hint>
The documentation for this class was generated from the following file:
- Arp/Io/ProfinetStack/Controller/Services/IDiagnosisQueryService.hpp
