Interface to provide information about component roots More...

#include <IDataInfoProvider.hpp>

Inheritance diagram for Arp::Plc::Commons::Meta::IDataInfoProvider:

Public Types
using	Ptr = std::shared_ptr< IDataInfoProvider >
	std::shared_ptr to IDataInfoProvider More...

Public Member Functions
virtual IEnumerator< const DataInfo & >::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...

Protected Member Functions
	IDataInfoProvider (void)=default
	Constructs an IDataInfoProvider instance. More...

virtual	~IDataInfoProvider (void)=default
	Destructs this instance and frees all resources. More...

Detailed Description

Interface to provide information about component roots

The component roots form the base to determine the addresses of variables published by the component.

Member Typedef Documentation

◆ Ptr

using Arp::Plc::Commons::Meta::IDataInfoProvider::Ptr = std::shared_ptr<IDataInfoProvider>

std::shared_ptr to IDataInfoProvider

Constructor & Destructor Documentation

◆ IDataInfoProvider()

Arp::Plc::Commons::Meta::IDataInfoProvider::IDataInfoProvider ( void )

protecteddefault

Constructs an IDataInfoProvider instance.

◆ ~IDataInfoProvider()

virtual Arp::Plc::Commons::Meta::IDataInfoProvider::~IDataInfoProvider ( void )

protectedvirtualdefault

Destructs this instance and frees all resources.

Member Function Documentation

◆ GetRoot()

virtual DataInfo Arp::Plc::Commons::Meta::IDataInfoProvider::GetRoot ( const String & name )

pure virtual

Returns the requested root variable of the component

Parameters

name	Name of the root variable

Returns: DataInfo object for the variable or an empty DataInfo if name is not found

Implemented in Arp::Plc::Commons::Meta::DataInfoProvider, and Arp::Plc::Commons::Meta::ChangeDataInfoProvider.

◆ GetRoots()

virtual IEnumerator<const DataInfo&>::Ptr Arp::Plc::Commons::Meta::IDataInfoProvider::GetRoots ( void )

pure virtual

Returns an IEnumerator to enumerate all root variables of the component