PLCnext API Documentation 25.0.2.69
Public Types | Public Member Functions | Protected Member Functions | List of all members
Arp::Plc::Commons::Meta::IMetaLibrary Class Referenceabstract

Interface for all libraries providing meta data More...

#include <IMetaLibrary.hpp>

Inheritance diagram for Arp::Plc::Commons::Meta::IMetaLibrary:
Inheritance graph

Public Types

using Ptr = std::shared_ptr< IMetaLibrary >
 std::shared_ptr to IMetaLibrary
 

Public Member Functions

virtual const char * GetNamespace (void)=0
 Gets the namespace of this library. More...
 
virtual ITypeInfoProviderGetTypeInfoProvider (bool useBackgroundDomain)=0
 Gets the ITypeInfoProvider of this library. More...
 
virtual IChangeNavigatorGetChangeNavigator (void)=0
 Gets the specialized IChangeNavigator of this component. More...
 

Protected Member Functions

 IMetaLibrary (void)=default
 Constructs an IMetaLibrary instance.
 
virtual ~IMetaLibrary (void)=default
 Destructs this instance and frees all resources.
 

Detailed Description

Interface for all libraries providing meta data

All libraries that wish to provide variables must implement this interface.

Member Function Documentation

◆ GetChangeNavigator()

virtual IChangeNavigator * Arp::Plc::Commons::Meta::IMetaLibrary::GetChangeNavigator ( void  )
pure virtual

Gets the specialized IChangeNavigator of this component.

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

Implemented in Arp::Plc::Commons::Meta::MetaLibraryBase.

◆ GetNamespace()

virtual const char * Arp::Plc::Commons::Meta::IMetaLibrary::GetNamespace ( void  )
pure virtual

Gets the namespace of this library.

Returns
The namespace of this library.

Implemented in Arp::Plc::Commons::Meta::MetaLibraryBase.

◆ GetTypeInfoProvider()

virtual ITypeInfoProvider & Arp::Plc::Commons::Meta::IMetaLibrary::GetTypeInfoProvider ( bool  useBackgroundDomain)
pure virtual

Gets the ITypeInfoProvider of this library.

Returns
The type info provider of this library.
Parameters
useBackgroundDomaintrue if the provider of the background domain should be returned, otherwise false.

Implemented in Arp::Plc::Commons::Meta::MetaLibraryBase.


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