PLCnext API Documentation 26.0.4.73
Public Member Functions | List of all members
Arp::Io::Commons::IoLibraryBase Class Reference

Base class for libraries of IO components More...

#include <IoLibraryBase.hpp>

Inheritance diagram for Arp::Io::Commons::IoLibraryBase:
Inheritance graph

Public Member Functions

 IoLibraryBase (const IoLibraryBase &arg)=delete
 
 IoLibraryBase (IoLibraryBase &&arg) noexcept=delete
 
IoLibraryBase & operator= (const IoLibraryBase &arg)=delete
 
IoLibraryBase & operator= (IoLibraryBase &&arg) noexcept=delete
 
 ~IoLibraryBase (void) override
 Default destructor.
 
 IoLibraryBase (const ArpVersion &libraryVersion)
 Constructs an IoLibraryBase instance. More...
 
Impl & GetImpl (void)
 For internal use only.
 
const Impl & GetImpl (void) const
 
- Public Member Functions inherited from Arp::Base::Acf::Commons::LibraryBase
 LibraryBase (const ArpVersion &libraryVersion=ArpVersion{})
 Constructs a LibraryBase instance. More...
 
 LibraryBase (const LibraryBase &arg)=delete
 
 LibraryBase (LibraryBase &&arg) noexcept
 The default move constructor. More...
 
LibraryBase & operator= (const LibraryBase &arg)=delete
 
LibraryBase & operator= (LibraryBase &&arg) noexcept
 The default move-assignment operator. More...
 
 ~LibraryBase (void) override
 The default destructor.
 
void Initialize (void) override
 Initializes this library. More...
 
void Dispose (void) override
 Disposes this library. More...
 
IComponentFactory & GetComponentFactory (void) override
 Gets the component factory of this library to create instances of its provided components. More...
 
const ArpVersion & GetBuildVersion (void) const override
 Gets the version of the firmware or SDK which was used to build the shared library. More...
 
const ArpVersion & GetLibraryVersion (void) const override
 Gets the version of the library provided by its author. More...
 
String GetLibraryInfoItem (LibraryInfoKind kind) const override
 Gets additional information about the library More...
 
template<class T >
void AddComponentType (void)
 Registers a type of a component of this library. More...
 
template<class T >
void RegisterComponentType (void)
 Registers a type of a component of this library. More...
 
template<class T >
void RegisterComponentType (const String &typeName)
 Registers a type of a component of this library. More...
 
Impl & GetImpl (void)
 For internal use only. More...
 
const Impl & GetImpl (void) const
 
- Public Member Functions inherited from Arp::Base::Acf::Commons::ILibrary
 ILibrary (void)=default
 The default constructor.
 
 ILibrary (ILibrary &&arg) noexcept=default
 The move constructor. More...
 
 ILibrary (const ILibrary &arg)=delete
 The copy constructor is deleted. More...
 
ILibrary & operator= (ILibrary &&arg) noexcept=default
 The move assignment operator. More...
 
ILibrary & operator= (const ILibrary &arg)=delete
 The copy assignment operator is deleted. More...
 
virtual ~ILibrary (void)=default
 The virtual default destructor.
 
virtual void Initialize (void)=0
 Initializes this library. More...
 
virtual void Dispose (void)=0
 Disposes this library. More...
 
virtual IComponentFactory & GetComponentFactory (void)=0
 Gets the component factory of this library to create instances of its provided components. More...
 
virtual const ArpVersion & GetBuildVersion (void) const =0
 Gets the version of the firmware or SDK which was used to build the shared library. More...
 
virtual const ArpVersion & GetLibraryVersion (void) const =0
 Gets the version of the library provided by its author. More...
 
virtual String GetLibraryInfoItem (LibraryInfoKind kind) const =0
 Gets additional information about the library More...
 

Additional Inherited Members

- Public Types inherited from Arp::Base::Acf::Commons::LibraryBase
using FactoryMethod = IComponentFactory::FactoryMethod
 The prototype of the component factory method.
 
using FactoryMethodCompat = IComponentFactory::FactoryMethodCompat
 The deprecated prototype of the component factory method.
 
- Public Types inherited from Arp::Base::Acf::Commons::ILibrary
using MainEntry = ILibrary &(*)(void)
 This is the prototype of the main entry point of any Arp library which shall be loaded dynamically by the Acf. More...
 
- Protected Member Functions inherited from Arp::Base::Acf::Commons::LibraryBase
void SetLibraryInfoItem (LibraryInfoKind kind, const String &value)
 Sets the value of a LibraryInfoItem More...
 
void SetSdkBuildInfo (const ArpVersion &buildVersion, const String &abiVersion, const String &targetIdentifier)
 Sets the information from the SDK with which this library was built More...
 

Detailed Description

Base class for libraries of IO components

Constructor & Destructor Documentation

◆ IoLibraryBase()

Arp::Io::Commons::IoLibraryBase::IoLibraryBase ( const ArpVersion &  libraryVersion)
explicit

Constructs an IoLibraryBase instance.

Parameters
libraryVersionVersion of this library
libraryNamespaceNamespace of the library.

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