PLCnext API Documentation  20.6.0.30321
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Arp::Plc::Commons::Meta::MetaComponentBase Class Referenceabstract
Inheritance diagram for Arp::Plc::Commons::Meta::MetaComponentBase:
Inheritance graph

Public Member Functions

 MetaComponentBase (const char *libraryNamespace)
 
void SetupSettings (void)
 Sets up the internal DataInfoProvider to enable providing meta data More...
 
 ARP_DEPRECATED ("Call MetaComponentBase::SetupSettings() in the component's SetupSettings() method instead.") void SetupConfig(void)
 
 ARP_DEPRECATED ("Call MetaComponentBase::Dispose() in the component's Dispose() method instead.") void ResetConfig(void)
 summary>Resets the internal DataInfoProvider More...
 
void Dispose (void)
 
IDataInfoProviderGetDataInfoProvider (bool isChanging) override
 
IDataNavigator * GetDataNavigator (void) override
 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. 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::Meta::IMetaComponent
typedef std::shared_ptr< IMetaComponentPtr
 

Member Function Documentation

◆ ARP_DEPRECATED()

Arp::Plc::Commons::Meta::MetaComponentBase::ARP_DEPRECATED ( "Call MetaComponentBase::Dispose() in the component's Dispose() method instead."  )

summary>Resets the internal DataInfoProvider

◆ 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.

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().

◆ SetupSettings()

void Arp::Plc::Commons::Meta::MetaComponentBase::SetupSettings ( void  )

Sets up the internal DataInfoProvider to enable providing meta data


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