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

Use this service to manage PROFINET Application Relationships (AR) More...

#include <IArManagementService.hpp>

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

Public Types

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

Public Member Functions

 IArManagementService (void)=default
 Constructs an IArManagementService instance. More...
 
virtual uint32 GetArState (const RscString< 512 > &stationName, uint32 &arState)=0
 
virtual uint32 StartAr (const RscString< 512 > &stationName, uint32 &arState)=0
 
virtual uint32 StopAr (const RscString< 512 > &stationName, uint32 &arState)=0
 
- 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

Use this service to manage PROFINET Application Relationships (AR)

Constructor & Destructor Documentation

◆ IArManagementService()

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

Constructs an IArManagementService instance.

Member Function Documentation

◆ GetArState()

virtual uint32 Arp::Io::ProfinetStack::Controller::Services::IArManagementService::GetArState ( const RscString< 512 > &  stationName,
uint32 arState 
)
pure virtual

Parameters
stationNameStation name of the device
arStateCurrent state of the AR
Returns
Status of service

◆ StartAr()

virtual uint32 Arp::Io::ProfinetStack::Controller::Services::IArManagementService::StartAr ( const RscString< 512 > &  stationName,
uint32 arState 
)
pure virtual

Parameters
stationNameStation name of the device
arStateState of the AR

ToDo

Returns

◆ StopAr()

virtual uint32 Arp::Io::ProfinetStack::Controller::Services::IArManagementService::StopAr ( const RscString< 512 > &  stationName,
uint32 arState 
)
pure virtual

Parameters
stationNameStation name of the device
arStateState of the AR

ToDo

Returns
Status of service

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