PLCnext API Documentation 25.0.2.69
IArStatisticService.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/Rsc/Commons/IRscService.hpp"
10#include <vector>
11#include "Arp/Base/Rsc/Commons/RscString.hxx"
12#include "Arp/Io/ProfinetStack/Controller/Services/ArStatisticValue.hpp"
13
14// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IArStatisticService.cs
15
17{
18
19using namespace Arp::Base::Rsc::Commons;
20
28class ARP_EXPORT IArStatisticService : public IRscService
29{
30public: // usings
31 using Ptr = std::shared_ptr<IArStatisticService>;
32
33public: // construction/destruction
35 IArStatisticService(void) = default;
36
37public: // static policy operation
38 static IRscServiceProxyFactory& GetProxyFactory(void);
39
40public: // abstract operations
47 virtual ArStatisticValue Read(const RscString<256>& stationName) = 0;
48
53 virtual std::vector<ArStatisticValue> ReadChanges() = 0;
54
60
64 virtual void Reset() = 0;
65};
66
67} // end of namespace Arp::Io::ProfinetStack::Controller::Services
This is the base interface of all Rsc services.
Definition: IRscService.hpp:22
std::shared_ptr< IRscService > Ptr
The shared_ptr type of IRscService.
Definition: IRscService.hpp:25
Interface for service proxy factories to create service proxies used by RSC clients.
Definition: IRscServiceProxyFactory.hpp:22
Contains statistic values of one application relation
Definition: ArStatisticValue.hpp:25
This services provides statistic values for Profinet application relations (AR)
Definition: IArStatisticService.hpp:29
virtual ArStatisticValue Read(const RscString< 256 > &stationName)=0
Returns statistic values of one profinet device referenced by given station name. If the station name...
virtual std::vector< ArStatisticValue > ReadChanges()=0
Returns statistic values of all profinet devices with changed values since last call of ReadChanges o...
virtual uint32 ReadMissedFramesGlobal()=0
Returns the sum of all missed frames over all configured profinet devices.
virtual void Reset()=0
Resets missed frames global to 0. Also resets connection count and missed frames total of all configu...
IArStatisticService(void)=default
Constructs an IArStatisticService instance.
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:33
Namespace for Profinet I/O controller services