PLCnext API Documentation  22.0.0.43
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Arp::Io::ProfinetStack::System::Services::IConfigurationService Class Referenceabstract

This service read and writes different configuration options to the profinet system. More...

#include <IConfigurationService.hpp>

Inheritance diagram for Arp::Io::ProfinetStack::System::Services::IConfigurationService:
Inheritance graph

Public Types

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

Public Member Functions

 IConfigurationService (void)=default
 Constructs an IConfigurationService instance. More...
 
virtual ConfigurationErrorCode Read (const RscString< 512 > &name, RscVariant< 512 > &value)=0
 Reads one configuration from the profinet system. More...
 
virtual ConfigurationErrorCode Write (const RscString< 512 > &name, RscVariant< 512 > value)=0
 Writes one configuration to the profinet system. More...
 
virtual RscString< 512 > GetControllerName ()=0
 Gets the instance name of the profinet controller. If no controller is registered returns an empty string. More...
 
virtual std::vector< RscString< 512 > > GetDeviceNames ()=0
 Gets the instance names of all registered profinet devices. 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 service read and writes different configuration options to the profinet system.

Constructor & Destructor Documentation

◆ IConfigurationService()

Arp::Io::ProfinetStack::System::Services::IConfigurationService::IConfigurationService ( void  )
default

Constructs an IConfigurationService instance.

Member Function Documentation

◆ GetControllerName()

virtual RscString<512> Arp::Io::ProfinetStack::System::Services::IConfigurationService::GetControllerName ( )
pure virtual

Gets the instance name of the profinet controller. If no controller is registered returns an empty string.

Returns
Instance name of the controller

◆ GetDeviceNames()

virtual std::vector<RscString<512> > Arp::Io::ProfinetStack::System::Services::IConfigurationService::GetDeviceNames ( )
pure virtual

Gets the instance names of all registered profinet devices.

Returns
Names of all registered profinet devices

◆ Read()

virtual ConfigurationErrorCode Arp::Io::ProfinetStack::System::Services::IConfigurationService::Read ( const RscString< 512 > &  name,
RscVariant< 512 > &  value 
)
pure virtual

Reads one configuration from the profinet system.

Parameters
nameName of the configuration option
valueContains the read value
Returns
If operation was successfull and result contains valid value returns None, else returns specific error code.

◆ Write()

virtual ConfigurationErrorCode Arp::Io::ProfinetStack::System::Services::IConfigurationService::Write ( const RscString< 512 > &  name,
RscVariant< 512 >  value 
)
pure virtual

Writes one configuration to the profinet system.

Parameters
nameName of the configuration option
valueContains the value of the configuration option to write
Returns
If operation was successfull and value has been written returns None, else returns specific error code.

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