PLCnext API Documentation  22.9.0.33
Public Member Functions | List of all members
Arp::System::Commons::Extensibility::SharedModuleLibraryLoader Class Reference

Public Member Functions

 SharedModuleLibraryLoader (const String &path)
 Constructs an SharedModuleLibraryLoader instance. More...
 
 SharedModuleLibraryLoader (const SharedModuleLibraryLoader &arg)=delete
 Copy constructor. More...
 
 SharedModuleLibraryLoader (SharedModuleLibraryLoader &&arg)=default
 Move constructor. More...
 
SharedModuleLibraryLoaderoperator= (const SharedModuleLibraryLoader &arg)=delete
 Copy-assignment operator. More...
 
SharedModuleLibraryLoaderoperator= (SharedModuleLibraryLoader &&arg)=default
 Move-assignment operator. More...
 
 ~SharedModuleLibraryLoader (void)
 Destructs this instance and frees all resources. More...
 
const StringGetFullPath () const
 Returns the full path to the library file More...
 
String GetFileName () const
 Returns the file name of the library (without directory) More...
 
bool Exists () const
 Returns true if the library file exists. More...
 
bool IsLoaded () const
 Returns true if the library is loaded More...
 
void Load ()
 Loads the library More...
 
void Unload ()
 Unload the library More...
 
SharedLibraryGetSharedLibrary () const
 Retuns the shared library More...
 

Constructor & Destructor Documentation

◆ SharedModuleLibraryLoader() [1/3]

Arp::System::Commons::Extensibility::SharedModuleLibraryLoader::SharedModuleLibraryLoader ( const String path)
explicit

Constructs an SharedModuleLibraryLoader instance.

◆ SharedModuleLibraryLoader() [2/3]

Arp::System::Commons::Extensibility::SharedModuleLibraryLoader::SharedModuleLibraryLoader ( const SharedModuleLibraryLoader arg)
delete

Copy constructor.

◆ SharedModuleLibraryLoader() [3/3]

Arp::System::Commons::Extensibility::SharedModuleLibraryLoader::SharedModuleLibraryLoader ( SharedModuleLibraryLoader &&  arg)
default

Move constructor.

◆ ~SharedModuleLibraryLoader()

Arp::System::Commons::Extensibility::SharedModuleLibraryLoader::~SharedModuleLibraryLoader ( void  )

Destructs this instance and frees all resources.

Member Function Documentation

◆ Exists()

bool Arp::System::Commons::Extensibility::SharedModuleLibraryLoader::Exists ( ) const

Returns true if the library file exists.

◆ GetFileName()

String Arp::System::Commons::Extensibility::SharedModuleLibraryLoader::GetFileName ( ) const

Returns the file name of the library (without directory)

◆ GetFullPath()

const String& Arp::System::Commons::Extensibility::SharedModuleLibraryLoader::GetFullPath ( ) const

Returns the full path to the library file

◆ GetSharedLibrary()

SharedLibrary& Arp::System::Commons::Extensibility::SharedModuleLibraryLoader::GetSharedLibrary ( ) const

Retuns the shared library

Throws an exception if the library is not loaded. Use IsLoaded to check that.

◆ IsLoaded()

bool Arp::System::Commons::Extensibility::SharedModuleLibraryLoader::IsLoaded ( ) const

Returns true if the library is loaded

◆ Load()

void Arp::System::Commons::Extensibility::SharedModuleLibraryLoader::Load ( )

Loads the library

◆ operator=() [1/2]

SharedModuleLibraryLoader& Arp::System::Commons::Extensibility::SharedModuleLibraryLoader::operator= ( const SharedModuleLibraryLoader arg)
delete

Copy-assignment operator.

◆ operator=() [2/2]

SharedModuleLibraryLoader& Arp::System::Commons::Extensibility::SharedModuleLibraryLoader::operator= ( SharedModuleLibraryLoader &&  arg)
default

Move-assignment operator.

◆ Unload()

void Arp::System::Commons::Extensibility::SharedModuleLibraryLoader::Unload ( )

Unload the library


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