module Class Reference

Module class. More...

#include <module.h>

Inheritance diagram for module:

Public Member Functions
	module ()
	Default constructor for module.
virtual	~module ()
	Default destructor for module.
virtual std::string	get_module_name () const
	Get the module name. More...
Public Member Functions inherited from credit
	credit ()=default
	Default constructor.
	credit (std::string name, std::string argument_name)
	Constructor for credit. More...
virtual void	set_name (std::string name, std::string argument_name="")
	Set name (and perhaps, argument name together) More...
virtual std::string	get_name () const
	Get the name.
virtual void	set_argument_name (std::string argument_name)
	Set an argument name. More...
virtual std::string	get_argument_name () const
	Get an argument name. More...
virtual double	get_version () const
	Get version. More...
virtual std::string	get_author () const
	Get author's name. More...
virtual std::tuple< int, int, int >	get_date () const
	Get currently set date. More...
virtual std::string	get_email_address () const
	Get email address. More...
Public Member Functions inherited from messageable
virtual bool	send_message (std::string message, void *ptr=nullptr)
	Send a message. More...
virtual bool	const_send_message (std::string message, void *ptr=nullptr) const
	Send a message. More...

Static Public Member Functions
static std::string	module_libpath (std::string module_name)
	Get the path to the dynamic library. e.g., "mylib" -> "symlink-public/lib/libshiokaze_mylib.dylib". More...
static module *	alloc_module (configuration &config, std::string arg_name, std::string default_module_name, std::string description)
	Automatically reads the parameter "arg_name" to fetch the name for the library, and allocate the library. More...
static module *	alloc_module (std::string path)
	Reads the dynamic library of a class module, allocate, and return the pointer to it. More...
static unsigned	close_all_handles ()
	Close all the handles that are still unloaded. More...
template<class T >
static std::unique_ptr< T >	unique_alloc_module (configuration &config, std::string arg_name, std::string default_module_name, std::string description)
	Allocate the module and cast to the a specified class T. More...
static unsigned	count_open_modules ()
	Count all the open modules. More...

Additional Inherited Members
Protected Attributes inherited from credit
std::string	m_name
	Name of credit.
std::string	m_argument_name
	Argument name.

Detailed Description

Module class.

Member Function Documentation

alloc_module() [1/2]

static module* module::alloc_module ( configuration &  config, std::string  arg_name, std::string  default_module_name, std::string  description  )

static

Automatically reads the parameter "arg_name" to fetch the name for the library, and allocate the library.

Parameters

[in]	config	Configutation setting.
[in]	arg_name	Argument corresponding argument key for the library.
[in]	default_module_name	Default module name in the case that module associated with arg_name key is not found.
	[om]	description Description of parameter arg_name.

Returns

Pointer to the loaded dynamic library.

alloc_module() [2/2]

static module* module::alloc_module ( std::string  path )

static

Reads the dynamic library of a class module, allocate, and return the pointer to it.

Parameters

[in]

path

Path to the dynamic library

Returns

Pointer to the loaded dynamic library.

close_all_handles()

static unsigned module::close_all_handles ( )

static

Close all the handles that are still unloaded.

Returns

Number of closed handles by this call.

count_open_modules()

static unsigned module::count_open_modules ( )

static

Count all the open modules.

Returns

Number of load modules.

get_module_name()

virtual std::string module::get_module_name ( ) const

inlinevirtual

Get the module name.

Returns

module name

module_libpath()

static std::string module::module_libpath ( std::string  module_name )

static

Get the path to the dynamic library. e.g., "mylib" -> "symlink-public/lib/libshiokaze_mylib.dylib".

Parameters

[in]

module_name

Name of module.

unique_alloc_module()

template<class T >

static std::unique_ptr<T> module::unique_alloc_module ( configuration &  config, std::string  arg_name, std::string  default_module_name, std::string  description  )

inlinestatic

Allocate the module and cast to the a specified class T.

Parameters

[in]	config	Configutation setting.
[in]	arg_name	Argument corresponding argument key for the library.
[in]	default_module_name	Default module name in the case that module associated with arg_name key is not found.
	[om]	description Description of parameter arg_name.

Returns

Pointer to the loaded dynamic library.

---

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

• include/shiokaze/core/module.h