PLCnext API Documentation 23.6.0.37
IDiagnosisQueryService.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
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
18namespace Arp { namespace Io { namespace ProfinetStack { namespace Controller { namespace Services
19{
20
21using namespace Arp;
22using namespace Arp::System::Rsc::Services;
23
33{
34public: // typedefs
35 using Ptr = std::shared_ptr<IDiagnosisQueryService>;
36
37public: // construction/destruction
39 IDiagnosisQueryService(void) = default;
40
41public: // static policy operation
42 static IRscServiceProxyFactory& GetProxyFactory(void);
43
44public: // abstract operations
60 virtual std::vector<DiagnosisItem> Query(const DiagnosisSource& source, FilterLevel filterLevel = FilterLevel::None, ChannelQualifier filterSeverity = ChannelQualifier::Normal) = 0;
61};
62
64// inline methods of class IDiagnosisQueryService
65inline IRscServiceProxyFactory& IDiagnosisQueryService::GetProxyFactory()
66{
67 return DiagnosisQueryServiceProxyFactory::GetInstance();
68}
69
70}}}}} // 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:33
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:20
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
Root namespace for the PLCnext API