Arp::Plc::Meta::Services::IVariableBrowseService Class Reference

This service enables browsing and querying of meta data about variables. More...

#include <IVariableBrowseService.hpp>

Inheritance diagram for Arp::Plc::Meta::Services::IVariableBrowseService:

Public Types
using	Ptr = std::shared_ptr< IVariableBrowseService >
using	GetChildrenResultDelegate = delegate< void(IRscReadEnumerator< VariableBrowseResult > &)>
using	GetComponentNamesResultDelegate = delegate< void(IRscReadEnumerator< RscString< 512 > > &)>
using	GetRootsResultDelegate = delegate< void(IRscReadEnumerator< VariableBrowseResult > &)>
Public Types inherited from Arp::Base::Rsc::Commons::IRscService
using	Ptr = std::shared_ptr< IRscService >
	The shared_ptr type of IRscService.

Public Member Functions
	IVariableBrowseService (void)=default
	Constructs an IVariableBrowseService instance.
virtual void	GetComponentNames (GetComponentNamesResultDelegate resultDelegate)=0
	Returns an enumerator over component names that provide variables More...
virtual void	GetRoots (const RscString< 512 > &componentName, GetRootsResultDelegate resultDelegate)=0
	Returns an enumerator over the root nodes of the given component More...
virtual void	GetChildren (const VariableBrowseHandle &browseHandle, GetChildrenResultDelegate resultDelegate)=0
	Gets an enumerator over the children of the referenced parent. More...
virtual VariableQueryResult	GetVariable (const RscString< 512 > &variableName)=0
	Gets information about a specified variable 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...
IRscService &	operator= (const IRscService &arg)=delete
	The deleted assignment operator. More...
IRscService &	operator= (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 IRscServiceProxyFactory &	GetProxyFactory (void)
Static Public Member Functions inherited from Arp::Base::Rsc::Commons::IRscService
static IRscServiceProxyFactory &	GetProxyFactory (void)
	Returns a reference to service proxy factory to create a proxy instance of this service. More...

Detailed Description

This service enables browsing and querying of meta data about variables.

This service always operates on the foreground domain. This services 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

GetChildren()

virtual void Arp::Plc::Meta::Services::IVariableBrowseService::GetChildren ( const VariableBrowseHandle &  browseHandle, GetChildrenResultDelegate  resultDelegate  )

pure virtual

Gets an enumerator over the children of the referenced parent.

Parameters

browseHandle

Reference to the parent node

Returns

Enumerator over the children of the referenced parent

GetComponentNames()

virtual void Arp::Plc::Meta::Services::IVariableBrowseService::GetComponentNames ( GetComponentNamesResultDelegate  resultDelegate )

pure virtual

Returns an enumerator over component names that provide variables

Returns

An enumeration of component names.

GetRoots()

virtual void Arp::Plc::Meta::Services::IVariableBrowseService::GetRoots ( const RscString< 512 > &  componentName, GetRootsResultDelegate  resultDelegate  )

pure virtual

Returns an enumerator over the root nodes of the given component

Parameters

componentName

Name of the component

Returns

Returns an enumerator over the root nodes of the given component. In case of an error an empty enumerator is returned.

GetVariable()

virtual VariableQueryResult Arp::Plc::Meta::Services::IVariableBrowseService::GetVariable ( const RscString< 512 > &  variableName )

pure virtual

Gets information about a specified variable

Parameters

variableName

Fully qualified name of the variable

Returns

Information about the variable

---

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

• Arp/Plc/Meta/Services/IVariableBrowseService.hpp