Arp::Plc::Commons::Meta::IMetaComponent Class Reference

Interface for all components providing meta data More...

#include <IMetaComponent.hpp>

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

Public Types
using	Ptr = std::shared_ptr< IMetaComponent >
	std::shared_ptr to IMetaComponent

Public Member Functions
virtual IDataInfoProvider &	GetDataInfoProvider (bool useBackgroundDomain)=0
	Gets the IDataInfoProvider of this component. More...
virtual IDataNavigator *	GetDataNavigator (void)=0
	Gets the specialized IDataNavigator of this component. More...

Protected Member Functions
	IMetaComponent (void)=default
	Constructs an IMetaComponent instance.
virtual	~IMetaComponent (void)=default
	Destructs this instance and frees all resources.

Detailed Description

Interface for all components providing meta data

All components that wish to provide variables must implement this interface. The IDataInfoProvider of the component makes informations of the component's root variables available.

Member Function Documentation

GetDataInfoProvider()

virtual IDataInfoProvider & Arp::Plc::Commons::Meta::IMetaComponent::GetDataInfoProvider ( bool  useBackgroundDomain )

pure virtual

Gets the IDataInfoProvider of this component.

Parameters

useBackgroundDomain

true if the provider of the background domain should be returned, otherwise false.

Returns

IDataInfoProvider of this component

Implemented in Arp::Plc::Commons::Esm::ProgramComponentBase, and Arp::Plc::Commons::Meta::MetaComponentBase.

GetDataNavigator()

virtual IDataNavigator * Arp::Plc::Commons::Meta::IMetaComponent::GetDataNavigator ( void  )

pure virtual

Gets the specialized IDataNavigator of this component.

Returns

The data navigator of this component or nullptr if it's not provided.

This function is obsolete

Implemented in Arp::Plc::Commons::Esm::ProgramComponentBase, and Arp::Plc::Commons::Meta::MetaComponentBase.

---

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

• Arp/Plc/Commons/Meta/IMetaComponent.hpp