PLCnext API Documentation  22.9.0.33
IDiagnosisQueryService.hpp
1 //
3 // Copyright PHOENIX CONTACT Electronics GmbH
4 //
6 #pragma once
7 #include "Arp/System/Core/Arp.h"
8 #include <vector>
9 #include "Arp/Io/ProfinetStack/Controller/Services/ChannelQualifier.hpp"
10 #include "Arp/Io/ProfinetStack/Controller/Services/DiagnosisItem.hpp"
11 #include "Arp/Io/ProfinetStack/Controller/Services/DiagnosisQueryServiceProxyFactory.hpp"
12 #include "Arp/Io/ProfinetStack/Controller/Services/DiagnosisSource.hpp"
13 #include "Arp/Io/ProfinetStack/Controller/Services/FilterLevel.hpp"
14 #include "Arp/System/Rsc/Services/IRscService.hpp"
15 
16 // DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IDiagnosisQueryService.cs
17 
18 namespace Arp { namespace Io { namespace ProfinetStack { namespace Controller { namespace Services
19 {
20 
21 using namespace Arp;
22 using namespace Arp::System::Rsc::Services;
23 
30 {
31 public: // typedefs
32  using Ptr = std::shared_ptr<IDiagnosisQueryService>;
33 
34 public: // construction/destruction
36  IDiagnosisQueryService(void) = default;
37 
38 public: // static policy operation
39  static IRscServiceProxyFactory& GetProxyFactory(void);
40 
41 public: // abstract operations
57  virtual std::vector<DiagnosisItem> Query(const DiagnosisSource& source, FilterLevel filterLevel = FilterLevel::None, ChannelQualifier filterSeverity = ChannelQualifier::Normal) = 0;
58 };
59 
61 // inline methods of class IDiagnosisQueryService
62 inline IRscServiceProxyFactory& IDiagnosisQueryService::GetProxyFactory()
63 {
64  return DiagnosisQueryServiceProxyFactory::GetInstance();
65 }
66 
67 }}}}} // end of namespace Arp::Io::ProfinetStack::Controller::Services
Contains the information where a diagnosis is located on the device according to "Guideline for PROFI...
Definition: DiagnosisSource.hpp:25
This services allows access to the diagnosis informationen of the subordinated devices....
Definition: IDiagnosisQueryService.hpp:30
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;
Base interface for all Rsc service interface.
Definition: IRscService.hpp:19
ChannelQualifier
Describes diagnosis severity.
Definition: ChannelQualifier.hpp:19
@ Normal
Normal severity, used if diagnosis is not QualifiedChannelDiagnosis
FilterLevel
Used to determine which values of Arp.Io.ProfinetStack.Controller.Services.DiagnosisSource are used t...
Definition: FilterLevel.hpp:19
@ None
All stored diagnoses sources will be returned.
Namespace for classes and interfaces for the Remote Service Call implementation
Definition: IRscReadEnumerator.hxx:10
Root namespace for the PLCnext API