Arp::Plc::Commons::Meta::IMetaLibrary Class Reference

Interface for all libraries providing meta data More...

#include <IMetaLibrary.hpp>

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

Public Types
typedef std::shared_ptr< IMetaLibrary >	Ptr
	std::shared_ptr to IMetaLibrary More...

Public Member Functions
virtual const char *	GetNamespace (void)=0
	Gets the namespace of this library. More...
virtual ITypeInfoProvider &	GetTypeInfoProvider (bool useBackgroundDomain)=0
	Gets the ITypeInfoProvider of this library. More...
virtual IChangeNavigator *	GetChangeNavigator (void)=0
	Gets the specialized IChangeNavigator of this component. More...

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

Detailed Description

Interface for all libraries providing meta data

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

Member Typedef Documentation

Ptr

typedef std::shared_ptr<IMetaLibrary> Arp::Plc::Commons::Meta::IMetaLibrary::Ptr

std::shared_ptr to IMetaLibrary

Constructor & Destructor Documentation

IMetaLibrary()

Arp::Plc::Commons::Meta::IMetaLibrary::IMetaLibrary ( void  )

protecteddefault

Constructs an IMetaLibrary instance.

~IMetaLibrary()

virtual Arp::Plc::Commons::Meta::IMetaLibrary::~IMetaLibrary ( void  )

protectedvirtualdefault

Destructs this instance and frees all resources.

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

useBackgroundDomain

true 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:

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