PLCnext API Documentation 23.3.0.32
IArStatisticService.hpp
1
2//
3// Copyright PHOENIX CONTACT Electronics GmbH
4//
6#pragma once
8#include <vector>
9#include "Arp/Io/ProfinetStack/Controller/Services/ArStatisticServiceProxyFactory.hpp"
10#include "Arp/Io/ProfinetStack/Controller/Services/ArStatisticValue.hpp"
11#include "Arp/System/Rsc/Services/IRscService.hpp"
12#include "Arp/System/Rsc/Services/RscString.hxx"
13
14// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IArStatisticService.cs
15
16namespace Arp { namespace Io { namespace ProfinetStack { namespace Controller { namespace Services
17{
18
19using namespace Arp;
20using namespace Arp::System::Rsc::Services;
21
27{
28public: // typedefs
29 using Ptr = std::shared_ptr<IArStatisticService>;
30
31public: // construction/destruction
33 IArStatisticService(void) = default;
34
35public: // static policy operation
36 static IRscServiceProxyFactory& GetProxyFactory(void);
37
38public: // abstract operations
45 virtual ArStatisticValue Read(const RscString<256>& stationName) = 0;
46
51 virtual std::vector<ArStatisticValue> ReadChanges() = 0;
52
58
62 virtual void Reset() = 0;
63};
64
66// inline methods of class IArStatisticService
67inline IRscServiceProxyFactory& IArStatisticService::GetProxyFactory()
68{
69 return ArStatisticServiceProxyFactory::GetInstance();
70}
71
72}}}}} // end of namespace Arp::Io::ProfinetStack::Controller::Services
Contains statistic values of one application relation
Definition: ArStatisticValue.hpp:25
This services provides statistic values for Profinet application relations (AR)
Definition: IArStatisticService.hpp:27
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.
Base interface for all Rsc service interface.
Definition: IRscService.hpp:19
std::uint32_t uint32
The Arp unsigned integer type of 4 byte size.
Definition: PrimitiveTypes.hpp:35
Namespace for classes and interfaces for the Remote Service Call implementation
Root namespace for the PLCnext API