Arp::Plc::Commons::Meta::MetaComponentBase Class Reference

Base class for components providing meta data More...

#include <MetaComponentBase.hpp>

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

Public Member Functions
	MetaComponentBase (const char *libraryNamespace)
	Constructs an MetaComponentBase instance More...
	~MetaComponentBase () override=default
	Destructs this object
void	SetupSettings (void)
	Sets up the internal DataInfoProvider to enable providing meta data
	ARP_DEPRECATED ("Call MetaComponentBase::SetupSettings() in the component's SetupSettings() method instead.") void SetupConfig(void)
	Deprecated! SetupConfig More...
	ARP_DEPRECATED ("Call MetaComponentBase::Dispose() in the component's Dispose() method instead.") void ResetConfig(void)
	ResetConfig More...
void	Dispose (void)
	Resets the internal DataInfoProvider
IDataInfoProvider &	GetDataInfoProvider (bool useBackgroundDomain) override
	Gets the IDataInfoProvider of this component. More...
IDataNavigator *	GetDataNavigator (void) override
	Gets the specialized IDataNavigator of this component. More...
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
virtual void	RegisterComponentPorts (void)=0
	Registers the ports of this component with its DataInfoProvider More...
Protected Member Functions inherited from Arp::Plc::Commons::Meta::IMetaComponent
	IMetaComponent (void)=default
	Constructs an IMetaComponent instance.
virtual	~IMetaComponent (void)=default
	Destructs this instance and frees all resources.

Protected Attributes
DataInfoProvider	dataInfoProvider

Additional Inherited Members
Public Types inherited from Arp::Plc::Commons::Meta::IMetaComponent
using	Ptr = std::shared_ptr< IMetaComponent >
	std::shared_ptr to IMetaComponent

Detailed Description

Base class for components providing meta data

Derive from this class as well as from ComponentBase. Call SetupSettings in ComponentBase::SetupSettings() and call Dispose in ComponentBase::Dispose(). These calls are neccessary to setup and dispose the included DataInfoProvider

Constructor & Destructor Documentation

MetaComponentBase()

Arp::Plc::Commons::Meta::MetaComponentBase::MetaComponentBase

(

const char *

libraryNamespace

)

Constructs an MetaComponentBase instance

Parameters

libraryNamespace

Namensraum der Bibliothek

Member Function Documentation

ARP_DEPRECATED() [1/2]

Arp::Plc::Commons::Meta::MetaComponentBase::ARP_DEPRECATED

(

"Call MetaComponentBase::Dispose() in the component's Dispose() method instead."

)

ResetConfig

Deprecated:

Use Dispose.

ARP_DEPRECATED() [2/2]

Arp::Plc::Commons::Meta::MetaComponentBase::ARP_DEPRECATED

(

"Call MetaComponentBase::SetupSettings() in the component's SetupSettings() method instead."

)

Deprecated! SetupConfig

Deprecated:

Use SetupSettings.

GetDataInfoProvider()

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

overridevirtual

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

Implements Arp::Plc::Commons::Meta::IMetaComponent.

GetDataNavigator()

IDataNavigator * Arp::Plc::Commons::Meta::MetaComponentBase::GetDataNavigator ( void  )

overridevirtual

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

Implements Arp::Plc::Commons::Meta::IMetaComponent.

RegisterComponentPorts()

virtual void Arp::Plc::Commons::Meta::MetaComponentBase::RegisterComponentPorts ( void  )

protectedpure virtual

Registers the ports of this component with its DataInfoProvider

Implement this method to make the ports of this component available as variables using DataInfoProvider::AddRoot().

---

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

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