PLCnext API Documentation 25.0.2.69
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Arp::Plc::Domain::Services::IPlcInfoService Class Referenceabstract

Provides informations about the Plc (realtime) project. More...

#include <IPlcInfoService.hpp>

Inheritance diagram for Arp::Plc::Domain::Services::IPlcInfoService:
Inheritance graph

Public Types

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

Public Member Functions

 IPlcInfoService (void)=default
 Constructs an IPlcInfoService instance.
 
virtual RscVariant< 256 > GetInfo (PlcInfoId identifier)=0
 Gets the specified info from the Plc project. More...
 
virtual std::vector< RscVariant< 256 > > GetInfos (const std::vector< PlcInfoId > &identifiers)=0
 Gets the specified infos from the Plc project. More...
 
- 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...
 
IRscServiceoperator= (const IRscService &arg)=delete
 The deleted assignment operator. More...
 
IRscServiceoperator= (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 IRscServiceProxyFactoryGetProxyFactory (void)
 
- Static Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
static IRscServiceProxyFactoryGetProxyFactory (void)
 Returns a reference to service proxy factory to create a proxy instance of this service. More...
 

Detailed Description

Provides informations about the Plc (realtime) project.

This service is defined in library Arp.Plc.Domain.

Realtime Usage: This API call does not have to be deterministic in runtime behaviour, so an asynchronous execution should be considered.

Member Function Documentation

◆ GetInfo()

virtual RscVariant< 256 > Arp::Plc::Domain::Services::IPlcInfoService::GetInfo ( PlcInfoId  identifier)
pure virtual

Gets the specified info from the Plc project.

Parameters
identifierThe identifier of the info to read.
Returns
The requested info or null if the identifier is unknown.

◆ GetInfos()

virtual std::vector< RscVariant< 256 > > Arp::Plc::Domain::Services::IPlcInfoService::GetInfos ( const std::vector< PlcInfoId > &  identifiers)
pure virtual

Gets the specified infos from the Plc project.

Parameters
identifiersThe identifiers of the infos to read.
Returns
The requested infos as array. If an identifiers is unknown, the according array element is null.

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