PLCore::Module Class Reference

Description and interface for modules. More...

#include <Module.h>

List of all members.

Public Member Functions
uint32	GetModuleID () const
	Get module ID.
bool	IsPlugin () const
	Check if module is loaded as a plugin.
DynLib *	GetDynLib () const
	Get dynamic library that contains the plugin.
String	GetFilename () const
	Get absolute filename of dynamic library or executable that contains the plugin.
String	GetName () const
	Get module name.
String	GetVendor () const
	Get module vendor.
String	GetLicense () const
	Get module license.
String	GetDescription () const
	Get module description.
const List< const Class * > &	GetClasses () const
	Get classes of module.

---

Detailed Description

Description and interface for modules.

Remarks:

A module is a unit like for example an executable or a shared library that contains RTTI content. There can only be one RTTI module per executable or a shared library. A module can either be a plugin or not. The term plugin means in this case that a module is not explicitly linked to the executable or to a used shared library and therefore not loaded automatically by the operation system on startup.

---

Member Function Documentation

uint32 PLCore::Module::GetModuleID

(

)

const [inline]

Get module ID.

Returns:

Module ID

bool PLCore::Module::IsPlugin

(

)

const [inline]

Check if module is loaded as a plugin.

Returns:

'true' if module is a plugin, else 'false'

DynLib * PLCore::Module::GetDynLib

(

)

const [inline]

Get dynamic library that contains the plugin.

Returns:

Pointer to dynamic library (can be a null pointer, if the module is not a plugin, do NOT destroy the returned instance!)

Remarks:

This function will only return a dynamic library, if the module is a plugin

String PLCore::Module::GetFilename

(

)

const [inline]

Get absolute filename of dynamic library or executable that contains the plugin.

Returns:

Absolute filename of dynamic library or executable that contains the plugin (native path style, can be empty in case it was impossible to determine the filename)

String PLCore::Module::GetName

(

)

const [inline]

Get module name.

Returns:

Name

String PLCore::Module::GetVendor

(

)

const [inline]

Get module vendor.

Returns:

Vendor name

String PLCore::Module::GetLicense

(

)

const [inline]

Get module license.

Returns:

License

String PLCore::Module::GetDescription

(

)

const [inline]

Get module description.

Returns:

Description

const List< const Class * > & PLCore::Module::GetClasses

(

)

const [inline]

Get classes of module.

Returns:

List of classes

Remarks:

This method always returns all classes of a module. If you want to search for classes with more specific search criteria, have a look at ClassManager::GetClasses().

---

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

• Module.h
• Module.inl