Arp::Io::ProfinetStack::Controller::Services::IArStatisticService Class Reference

This services provides statistic values for Profinet application relations (AR) More...

#include <IArStatisticService.hpp>

Inheritance diagram for Arp::Io::ProfinetStack::Controller::Services::IArStatisticService:

Public Types
using	Ptr = std::shared_ptr< IArStatisticService >
Public Types inherited from Arp::Base::Rsc::Commons::IRscService
using	Ptr = std::shared_ptr< IRscService >
	The shared_ptr type of IRscService.

Public Member Functions
	IArStatisticService (void)=default
	Constructs an IArStatisticService instance.
virtual ArStatisticValue	Read (const RscString< 256 > &stationName)=0
	Returns statistic values of one profinet device referenced by given station name. If the station name is unknown, the return value contains default values and an empty station name string. More...
virtual std::vector< ArStatisticValue >	ReadChanges ()=0
	Returns statistic values of all profinet devices with changed values since last call of ReadChanges or last Reset(). More...
virtual uint32	ReadMissedFramesGlobal ()=0
	Returns the sum of all missed frames over all configured profinet devices. More...
virtual void	Reset ()=0
	Resets missed frames global to 0. Also resets connection count and missed frames total of all configured profinet devices to 0.
Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
	IRscService (void)=default
	The default constructor.
	IRscService (const IRscService &arg)=delete
	The deleted copy constructor. More...
	IRscService (IRscService &&arg) noexcept=default
	The default move constructor. More...
IRscService &	operator= (const IRscService &arg)=delete
	The deleted assignment operator. More...
IRscService &	operator= (IRscService &&arg) noexcept=default
	The default move-assignment operator. More...
virtual	~IRscService (void)=default
	Destructs this instance and frees all resources.

Static Public Member Functions
static IRscServiceProxyFactory &	GetProxyFactory (void)
Static Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
static IRscServiceProxyFactory &	GetProxyFactory (void)
	Returns a reference to service proxy factory to create a proxy instance of this service. More...

Detailed Description

This services provides statistic values for Profinet application relations (AR)

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

Read()

virtual ArStatisticValue Arp::Io::ProfinetStack::Controller::Services::IArStatisticService::Read ( const RscString< 256 > &  stationName )

pure virtual

Returns statistic values of one profinet device referenced by given station name. If the station name is unknown, the return value contains default values and an empty station name string.

Parameters

stationName

Name of profinet device

Returns

Statistic values of one profinet device"/>

ReadChanges()

virtual std::vector< ArStatisticValue > Arp::Io::ProfinetStack::Controller::Services::IArStatisticService::ReadChanges ( )

pure virtual

Returns statistic values of all profinet devices with changed values since last call of ReadChanges or last Reset().

Returns

Array of statistic values

ReadMissedFramesGlobal()

virtual uint32 Arp::Io::ProfinetStack::Controller::Services::IArStatisticService::ReadMissedFramesGlobal ( )

pure virtual

Returns the sum of all missed frames over all configured profinet devices.

Returns

Sum of missed frames

---

The documentation for this class was generated from the following file:

• Arp/Io/ProfinetStack/Controller/Services/IArStatisticService.hpp