sese::plugin::Module Class Reference

Plugin module object. More...

#include <Module.h>

Public Types
using	Ptr = std::unique_ptr<Module>
using	LibraryObject = sese::system::Library

Public Member Functions
const char *	getName () const noexcept
	Get the module name.
const char *	getVersion () const noexcept
	Get the module version.
const char *	getDescription () const noexcept
	Get the module description.
BaseClass::Ptr	createClass (const std::string &id) const noexcept
	Construct an object using the class factory of the module.
template<typename TYPE >
std::shared_ptr< TYPE >	createClassAs (const std::string &name)
	Construct an object using the class factory of the module and cast to a specified type.
const ClassFactory::RegisterInfoMapType &	getRegisterClassInfo () const noexcept
	Get the type information of registered classes in the module.

Static Public Member Functions
static Module::Ptr	open (const std::string &path) noexcept
	Attempt to load a module from a dynamic library.
static Result< Ptr, ErrorCode >	openEx (const std::string &path) noexcept
static Module::Ptr	openWithPath (const system::Path &path) noexcept
	Attempt to load a module from a dynamic library.

Private Member Functions
	Module ()=default

Private Attributes
LibraryObject::Ptr	object = nullptr
ModuleInfo *	info = nullptr
ClassFactory *	factory = nullptr

Detailed Description

Plugin module object.

Member Typedef Documentation

LibraryObject

using sese::plugin::Module::LibraryObject = sese::system::Library

Ptr

using sese::plugin::Module::Ptr = std::unique_ptr<Module>

Constructor & Destructor Documentation

Module()

sese::plugin::Module::Module ( )

privatedefault

Member Function Documentation

createClass()

sese::plugin::BaseClass::Ptr sese::plugin::Module::createClass ( const std::string & id ) const

noexcept

Construct an object using the class factory of the module.

Parameters

id	Object identifier

Return values

nullptr

Instantiation error

Referenced by createClassAs().

createClassAs()

template<typename TYPE >

std::shared_ptr< TYPE > sese::plugin::Module::createClassAs ( const std::string & name )

inline

Construct an object using the class factory of the module and cast to a specified type.

Template Parameters

TYPE	Specified type

Parameters

name	Object identifier

Return values

nullptr

Instantiation error or type error

References createClass().

getDescription()

const char * sese::plugin::Module::getDescription ( ) const

noexcept

Get the module description.

Returns

Module description

References sese::plugin::ModuleInfo::description.

getName()

const char * sese::plugin::Module::getName ( ) const

noexcept

Get the module name.

Returns

Module name

References info, and sese::plugin::ModuleInfo::moduleName.

getRegisterClassInfo()

const sese::plugin::ClassFactory::RegisterInfoMapType & sese::plugin::Module::getRegisterClassInfo ( ) const

noexcept

Get the type information of registered classes in the module.

Returns

Type information

getVersion()

const char * sese::plugin::Module::getVersion ( ) const

noexcept

Get the module version.

Returns

Module version

References sese::plugin::ModuleInfo::versionString.

open()

sese::plugin::Module::Ptr sese::plugin::Module::open ( const std::string & path )

staticnoexcept

Attempt to load a module from a dynamic library.

Parameters

path	Dynamic library path

Return values

nullptr

Loading error

References GET_CLASS_FACTORY_FUNC_NAME, GET_MODULE_INFO_FUNC_NAME, MAKE_UNIQUE_PRIVATE, and STR2.

openEx()

sese::Result< sese::plugin::Module::Ptr, sese::ErrorCode > sese::plugin::Module::openEx ( const std::string & path )

staticnoexcept

References sese::getErrorCode(), sese::getErrorString(), and open().

openWithPath()

sese::plugin::Module::Ptr sese::plugin::Module::openWithPath ( const system::Path & path )

staticnoexcept

Attempt to load a module from a dynamic library.

Parameters

path	Dynamic library path

Return values

nullptr

Loading error

References open().

Member Data Documentation

factory

ClassFactory* sese::plugin::Module::factory = nullptr

private

info

ModuleInfo* sese::plugin::Module::info = nullptr

private

Referenced by getName().

object

LibraryObject::Ptr sese::plugin::Module::object = nullptr

private

---

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

• sese/plugin/Module.h
• sese/plugin/Module.cpp