PLCnext API Documentation  21.6.0.46
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Arp::Io::ProfinetStack::Controller::Services::IArStatisticService Class Referenceabstract

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

#include <IArStatisticService.hpp>

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

Public Types

using Ptr = std::shared_ptr< IArStatisticService >
 
- Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscServicePtr
 

Public Member Functions

 IArStatisticService (void)=default
 Constructs an IArStatisticService instance. More...
 
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< ArStatisticValueReadChanges ()=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. More...
 
- Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
 IRscService (void)=default
 Constructs an IRscService instance. More...
 
virtual ~IRscService (void)=default
 Destructs this instance and frees all resouces. More...
 

Static Public Member Functions

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

Detailed Description

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

Constructor & Destructor Documentation

◆ IArStatisticService()

Arp::Io::ProfinetStack::Controller::Services::IArStatisticService::IArStatisticService ( void  )
default

Constructs an IArStatisticService instance.

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
stationNameName 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

◆ Reset()

virtual void Arp::Io::ProfinetStack::Controller::Services::IArStatisticService::Reset ( )
pure virtual

Resets missed frames global to 0. Also resets connection count and missed frames total of all configured profinet devices to 0.


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