Arp::Plc::Commons::Esm::ProgramComponentBase Class Reference

Inheritance diagram for Arp::Plc::Commons::Esm::ProgramComponentBase:

Public Member Functions
	ProgramComponentBase (const char *libraryNamespace, ProgramProviderBase &programProvider)
	Constructs an ProgramComponentBase instance. More...
	~ProgramComponentBase (void)=default
	Destructs this instance and frees all resources. More...
void	Initialize (void)
void	SetupConfig (void)
void	ResetConfig (void)
IProgramProvider &	GetProgramProvider (bool useBackgroundDomain) override
	Returns the program provider of this component. More...
IDataInfoProvider &	GetDataInfoProvider (bool useBackgroundDomain) override
	Gets the IDataInfoProvider of this component. More...
IDataNavigator *	GetDataNavigator (void) override
	Gets the specialized IDataNavigator of this component. More...

Protected Member Functions
virtual void	RegisterComponentPorts (void)
Protected Member Functions inherited from Arp::Plc::Commons::Esm::IProgramComponent
	IProgramComponent (void)=default
	Constructs an IProgramComponent instance. More...
virtual	~IProgramComponent (void)=default
	Destructs this instance and frees all resouces. More...
Protected Member Functions inherited from Arp::Plc::Commons::Meta::IMetaComponent
	IMetaComponent (void)=default
	Constructs an IMetaComponent instance. More...
virtual	~IMetaComponent (void)=default
	Destructs this instance and frees all resources. More...

Protected Attributes
DataInfoProvider	dataInfoProvider

Additional Inherited Members
Public Types inherited from Arp::Plc::Commons::Esm::IProgramComponent
typedef std::shared_ptr< IProgramComponent >	Ptr
	Shared pointer type of IProgramComponent. More...
Public Types inherited from Arp::Plc::Commons::Meta::IMetaComponent
using	Ptr = std::shared_ptr< IMetaComponent >
	std::shared_ptr to IMetaComponent More...

Constructor & Destructor Documentation

ProgramComponentBase()

Arp::Plc::Commons::Esm::ProgramComponentBase::ProgramComponentBase	(	const char *	libraryNamespace,
		ProgramProviderBase &	programProvider
	)

Constructs an ProgramComponentBase instance.

~ProgramComponentBase()

Arp::Plc::Commons::Esm::ProgramComponentBase::~ProgramComponentBase ( void  )

default

Destructs this instance and frees all resources.

Member Function Documentation

GetDataInfoProvider()

IDataInfoProvider & Arp::Plc::Commons::Esm::ProgramComponentBase::GetDataInfoProvider ( bool  useBackgroundDomain )

inlineoverridevirtual

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::Esm::ProgramComponentBase::GetDataNavigator ( void  )

inlineoverridevirtual

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.

GetProgramProvider()

IProgramProvider & Arp::Plc::Commons::Esm::ProgramComponentBase::GetProgramProvider ( bool  useBackgroundDomain )

inlineoverridevirtual

Returns the program provider of this component.

Returns

The program provider of this component.

Implements Arp::Plc::Commons::Esm::IProgramComponent.

---

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

• Arp/Plc/Commons/Esm/ProgramComponentBase.hpp