PLCnext API Documentation 25.0.2.69
Classes | Public Member Functions | List of all members
Arp::Plc::Commons::Meta::ChangeDataInfoProvider Class Reference

Decorator for DataInfoProvider to set IsBackgroundDomain = true More...

#include <ChangeDataInfoProvider.hpp>

Inheritance diagram for Arp::Plc::Commons::Meta::ChangeDataInfoProvider:
Inheritance graph

Public Member Functions

 ChangeDataInfoProvider (DataInfoProvider &foregroundProvider)
 Constructs an ChangeDataInfoProvider instance.
 
 ChangeDataInfoProvider (const ChangeDataInfoProvider &arg)=delete
 Copy constructor.
 
 ChangeDataInfoProvider (ChangeDataInfoProvider &&arg)=default
 Move constructor
 
ChangeDataInfoProvideroperator= (const ChangeDataInfoProvider &arg)=delete
 Copy assignment operator.
 
ChangeDataInfoProvideroperator= (ChangeDataInfoProvider &&arg)=default
 Move assignment operator
 
 ~ChangeDataInfoProvider (void) override=default
 Destructs this instance and frees all resources.
 
IEnumerator< constDataInfo & >::Ptr GetRoots (void) override
 Returns an IEnumerator to enumerate all root variables of the component More...
 
DataInfo GetRoot (const String &name) override
 Returns the requested root variable of the component More...
 
virtual IEnumerator< constDataInfo & >::Ptr GetRoots (void)=0
 Returns an IEnumerator to enumerate all root variables of the component More...
 
virtual DataInfo GetRoot (const String &name)=0
 Returns the requested root variable of the component More...
 

Additional Inherited Members

- Public Types inherited from Arp::Plc::Commons::Meta::IDataInfoProvider
using Ptr = std::shared_ptr< IDataInfoProvider >
 std::shared_ptr to IDataInfoProvider
 
- Protected Member Functions inherited from Arp::Plc::Commons::Meta::IDataInfoProvider
 IDataInfoProvider (void)=default
 Constructs an IDataInfoProvider instance.
 
virtual ~IDataInfoProvider (void)=default
 Destructs this instance and frees all resources.
 

Detailed Description

Decorator for DataInfoProvider to set IsBackgroundDomain = true

This class is used internally to set the property IsBackgroundDomain to true on all returned objects.

Member Function Documentation

◆ GetRoot()

DataInfo Arp::Plc::Commons::Meta::ChangeDataInfoProvider::GetRoot ( const String name)
overridevirtual

Returns the requested root variable of the component

Parameters
nameName of the root variable
Returns
DataInfo object for the variable or an empty DataInfo if name is not found

Implements Arp::Plc::Commons::Meta::IDataInfoProvider.

◆ GetRoots()

IEnumerator< constDataInfo & >::Ptr Arp::Plc::Commons::Meta::ChangeDataInfoProvider::GetRoots ( void  )
overridevirtual

Returns an IEnumerator to enumerate all root variables of the component

Implements Arp::Plc::Commons::Meta::IDataInfoProvider.


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