PLCnext API Documentation 26.6.0.38
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Arp::Plc::Meta::Services::IDataTraverserService Class Referenceabstract

Arp.Plc.Meta.Services.IDataTraverserService interface More...

#include <IDataTraverserService.hpp>

Inheritance diagram for Arp::Plc::Meta::Services::IDataTraverserService:
Inheritance graph

Public Types

using Ptr = std::shared_ptr< IDataTraverserService >
 
using FindInstancesByTypenameResultDelegate = delegate< void(IRscReadEnumerator< RscString< 512 > > &)>
 
- Public Types inherited from Arp::Base::Rsc::Commons::IRscService
using Ptr = std::shared_ptr< IRscService >
 The shared_ptr type of IRscService.
 

Public Member Functions

 IDataTraverserService (void)=default
 Constructs an IDataTraverserService instance.
 
virtual void FindInstancesByTypename (const std::vector< RscString< 512 > > &typeNames, FindInstancesByTypenameResultDelegate resultDelegate)=0
 Gets the full qualified name of instances of a type 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

Arp.Plc.Meta.Services.IDataTraverserService interface

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

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

Consider the following common rule when using RSC services that provide arrays or enumerators as return values or out arguments: It is always required to completely read all items from these resulting lists or enumerators.

Member Function Documentation

◆ FindInstancesByTypename()

virtual void Arp::Plc::Meta::Services::IDataTraverserService::FindInstancesByTypename ( const std::vector< RscString< 512 > > &  typeNames,
FindInstancesByTypenameResultDelegate  resultDelegate 
)
pure virtual

Gets the full qualified name of instances of a type

Parameters
typeNamesCollection of full qualified type names
Returns
An enumeration of full qualified instace names of the types

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