PLCnext API Documentation  22.9.0.33
Public Member Functions | List of all members
Arp::Plc::Commons::Meta::MetaLibraryBase Class Reference

Base class for libraries providing meta data More...

#include <MetaLibraryBase.hpp>

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

Public Member Functions

 MetaLibraryBase (AppDomain &appDomain, const Version &buildVersion, TypeDomain &typeDomain)
 Constructs an MetaLibraryBase instance. More...
 
 MetaLibraryBase (const MetaLibraryBase &arg)=default
 Copy constructor. More...
 
MetaLibraryBaseoperator= (const MetaLibraryBase &arg)=default
 Assignment operator. More...
 
 ~MetaLibraryBase (void) override=default
 Destructs this instance and frees all resources. More...
 
TypeDomainGetTypeDomain ()
 
const char * GetNamespace (void) override
 Gets the namespace of this library. More...
 
ITypeInfoProviderGetTypeInfoProvider (bool useBackgroundDomain) override
 Gets the ITypeInfoProvider of this library. More...
 
IChangeNavigatorGetChangeNavigator (void) override
 Gets the specialized IChangeNavigator of this component. More...
 
- Public Member Functions inherited from Arp::System::Acf::LibraryBase
 LibraryBase (AppDomain &appDomain, const Version &buildVersion)
 Constructs an isntance of class LibraryBase. More...
 
virtual ~LibraryBase (void)=default
 The default destructor. More...
 
IComponentFactoryGetComponentFactory (void) override
 Gets the component factory of this library to create instances of its provided components. More...
 
const VersionGetBuildVersion (void) const override
 Gets the SDK version of the SDK used to build the shared library. More...
 
- Public Member Functions inherited from Arp::System::Acf::ILibrary
 ILibrary (void)=default
 The default constructor. More...
 
virtual ~ILibrary (void)=default
 The default destructor. More...
 

Additional Inherited Members

- Public Types inherited from Arp::System::Acf::ILibrary
typedef ILibraryPtr
 The pointer type of this interface. More...
 
typedef ILibrary &(* MainEntry) (AppDomain &appDomain)
 This is the prototype of the main entry point of any library which shall be loaded dynamically by the Acf. More...
 
- Public Types inherited from Arp::Plc::Commons::Meta::IMetaLibrary
using Ptr = std::shared_ptr< IMetaLibrary >
 std::shared_ptr to IMetaLibrary More...
 
- Protected Types inherited from Arp::System::Acf::ILibrary
typedef void(* Main) (AppDomain &appDomain)
 This is the prototype of the (static) entry point or auxiliary operation of any library class. More...
 
- Protected Member Functions inherited from Arp::Plc::Commons::Meta::IMetaLibrary
 IMetaLibrary (void)=default
 Constructs an IMetaLibrary instance. More...
 
virtual ~IMetaLibrary (void)=default
 Destructs this instance and frees all resources. More...
 
- Protected Attributes inherited from Arp::System::Acf::LibraryBase
ComponentFactory componentFactory
 This field is used to register library specific component factory methods.
 

Detailed Description

Base class for libraries providing meta data

Constructor & Destructor Documentation

◆ MetaLibraryBase() [1/2]

Arp::Plc::Commons::Meta::MetaLibraryBase::MetaLibraryBase ( AppDomain appDomain,
const Version buildVersion,
TypeDomain typeDomain 
)
inline

Constructs an MetaLibraryBase instance.

Parameters
appDomainReference to the current AppDomain
buildVersionVersion of this library
typeDomainRefrence to this library's TypeDomain

◆ MetaLibraryBase() [2/2]

Arp::Plc::Commons::Meta::MetaLibraryBase::MetaLibraryBase ( const MetaLibraryBase arg)
default

Copy constructor.

◆ ~MetaLibraryBase()

Arp::Plc::Commons::Meta::MetaLibraryBase::~MetaLibraryBase ( void  )
overridedefault

Destructs this instance and frees all resources.

Member Function Documentation

◆ GetChangeNavigator()

IChangeNavigator * Arp::Plc::Commons::Meta::MetaLibraryBase::GetChangeNavigator ( void  )
inlineoverridevirtual

Gets the specialized IChangeNavigator of this component.

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

Implements Arp::Plc::Commons::Meta::IMetaLibrary.

◆ GetNamespace()

const char * Arp::Plc::Commons::Meta::MetaLibraryBase::GetNamespace ( void  )
inlineoverridevirtual

Gets the namespace of this library.

Returns
The namespace of this library.

Implements Arp::Plc::Commons::Meta::IMetaLibrary.

◆ GetTypeInfoProvider()

ITypeInfoProvider & Arp::Plc::Commons::Meta::MetaLibraryBase::GetTypeInfoProvider ( bool  useBackgroundDomain)
inlineoverridevirtual

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.

Implements Arp::Plc::Commons::Meta::IMetaLibrary.

◆ operator=()

MetaLibraryBase& Arp::Plc::Commons::Meta::MetaLibraryBase::operator= ( const MetaLibraryBase arg)
default

Assignment operator.


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