PLCnext API Documentation 26.0.1.58
IVariableBrowseService.hpp
1
2//
3// Copyright Phoenix Contact GmbH & Co. KG
4//
6#pragma once
8#include "Arp/Base/Rsc/Commons/Rsc.hpp"
9#include "Arp/Base/Rsc/Commons/IRscService.hpp"
10#include "Arp/Base/Rsc/Commons/IRscReadEnumerator.hxx"
11#include "Arp/Base/Rsc/Commons/IRscWriteEnumerator.hxx"
12#include "Arp/Base/Core/delegate.hxx"
13#include "Arp/Base/Rsc/Commons/RscString.hxx"
14#include "Arp/Plc/Meta/Services/VariableBrowseHandle.hpp"
15#include "Arp/Plc/Meta/Services/VariableBrowseResult.hpp"
16#include "Arp/Plc/Meta/Services/VariableQueryResult.hpp"
17
18// DO NOT MODIFY THIS FILE, THIS FILE IS AUTOGENERATED BY IVariableBrowseService.cs
19
21{
22
23using namespace Arp::Base::Rsc::Commons;
24
33class ARP_EXPORT IVariableBrowseService : public IRscService
34{
35public: // usings
36 using Ptr = std::shared_ptr<IVariableBrowseService>;
40
41public: // construction/destruction
43 IVariableBrowseService(void) = default;
44
45public: // static policy operation
46 static IRscServiceProxyFactory& GetProxyFactory(void);
47
48public: // abstract operations
51 virtual void GetComponentNames(GetComponentNamesResultDelegate resultDelegate) = 0;
52
56 virtual void GetRoots(const RscString<512>& componentName, GetRootsResultDelegate resultDelegate) = 0;
57
61 virtual void GetChildren(const VariableBrowseHandle& browseHandle, GetChildrenResultDelegate resultDelegate) = 0;
62
66 virtual VariableQueryResult GetVariable(const RscString<512>& variableName) = 0;
67};
68
69} // end of namespace Arp::Plc::Meta::Services
Prototyping of delegate template.
Definition: delegate.hxx:14
Interface for reading a arrays or enumerations.
Definition: IRscReadEnumerator.hxx:19
This is the base interface of all Rsc services.
Definition: IRscService.hpp:22
std::shared_ptr< IRscService > Ptr
The shared_ptr type of IRscService.
Definition: IRscService.hpp:25
Interface for service proxy factories to create service proxies used by RSC clients.
Definition: IRscServiceProxyFactory.hpp:22
This service enables browsing and querying of meta data about variables.
Definition: IVariableBrowseService.hpp:34
virtual void GetRoots(const RscString< 512 > &componentName, GetRootsResultDelegate resultDelegate)=0
Returns an enumerator over the root nodes of the given component
virtual VariableQueryResult GetVariable(const RscString< 512 > &variableName)=0
Gets information about a specified variable
virtual void GetChildren(const VariableBrowseHandle &browseHandle, GetChildrenResultDelegate resultDelegate)=0
Gets an enumerator over the children of the referenced parent.
virtual void GetComponentNames(GetComponentNamesResultDelegate resultDelegate)=0
Returns an enumerator over component names that provide variables
IVariableBrowseService(void)=default
Constructs an IVariableBrowseService instance.
VariableBrowseHandle contains all information to efficiently identify a node in the variables tree
Definition: VariableBrowseHandle.hpp:26
Result for queries for a variable
Definition: VariableQueryResult.hpp:27
Namespace for services of the Meta component