PLCnext API Documentation  20.3.1.28622
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

typedef std::shared_ptr< IPlcInfoServicePtr
 
- Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscServicePtr
 

Public Member Functions

 IPlcInfoService (void)
 Constructs an IPlcInfoService instance. More...
 
virtual ~IPlcInfoService (void)
 Destructs this instance and frees all resouces. More...
 
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::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

Provides informations about the Plc (realtime) project.

Constructor & Destructor Documentation

◆ IPlcInfoService()

Arp::Plc::Domain::Services::IPlcInfoService::IPlcInfoService ( void  )
inline

Constructs an IPlcInfoService instance.

◆ ~IPlcInfoService()

Arp::Plc::Domain::Services::IPlcInfoService::~IPlcInfoService ( void  )
inlinevirtual

Destructs this instance and frees all resouces.

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: