LoadableModuleFactory Class Reference

#include <LoadableModuleFactory.h>

List of all members.

Public Types
typedef void(*	CallbackFunctionType )(const char *)
	Typedef of callback function.
Public Member Functions
CallbackFunctionType	GetErrorMessageCallback ()
CallbackFunctionType	GetInformationMessageCallback ()
LoadableModuleDescription	GetModuleDescription (const std::string &) const
	Get a module description by name.
CallbackFunctionType	GetModuleDiscoveryMessageCallback ()
std::vector< std::string >	GetModuleNames () const
	Get the names of all the modules.
const std::string &	GetName () const
const std::string &	GetSearchPaths () const
	Get the module search paths.
CallbackFunctionType	GetWarningMessageCallback ()
	LoadableModuleFactory ()
virtual void	Scan ()
void	SetErrorMessageCallback (CallbackFunctionType)
	Set/Get a function to call to report back errors.
void	SetInformationMessageCallback (CallbackFunctionType)
	Set/Get a function to call to report back information.
void	SetModuleDiscoveryMessageCallback (CallbackFunctionType)
	Set/Get a function to call to report back a discovered module.
void	SetName (const std::string &name)
void	SetSearchPaths (const std::string &paths)
void	SetWarningMessageCallback (CallbackFunctionType)
	Set/Get a function to call to report back warnings.
virtual	~LoadableModuleFactory ()
Protected Member Functions
void	ErrorMessage (const char *)
void	InformationMessage (const char *)
void	ModuleDiscoveryMessage (const char *)
virtual long	ScanForSharedObjectModules ()
void	WarningMessage (const char *)
Protected Attributes
bool	CacheModified
LoadableModuleCache *	InternalCache
LoadableModuleFileMap *	InternalFileMap
LoadableModuleDescriptionMap *	InternalMap
Private Attributes
std::string	CachePath
CallbackFunctionType	ErrorMessageCallback
CallbackFunctionType	InformationMessageCallback
CallbackFunctionType	ModuleDiscoveryMessageCallback
std::string	Name
std::string	SearchPaths
CallbackFunctionType	WarningMessageCallback

---

Member Typedef Documentation

typedef void(* LoadableModuleFactory::CallbackFunctionType)(const char *)

Typedef of callback function.

---

Constructor & Destructor Documentation

LoadableModuleFactory::LoadableModuleFactory

(

)

References CacheModified, ErrorMessageCallback, InformationMessageCallback, InternalCache, InternalFileMap, InternalMap, ModuleDiscoveryMessageCallback, Name, and WarningMessageCallback.

LoadableModuleFactory::~LoadableModuleFactory

(

)

[virtual]

References InternalCache, InternalFileMap, and InternalMap.

---

Member Function Documentation

void LoadableModuleFactory::ErrorMessage

(

const char *

msg

)

[protected]

References ErrorMessageCallback.

LoadableModuleFactory::CallbackFunctionType LoadableModuleFactory::GetErrorMessageCallback

(

)

References ErrorMessageCallback.

LoadableModuleFactory::CallbackFunctionType LoadableModuleFactory::GetInformationMessageCallback

(

)

References InformationMessageCallback.

LoadableModuleDescription LoadableModuleFactory::GetModuleDescription

(

const std::string &

name

)

const

Get a module description by name.

Referenced by Slicer3_main().

LoadableModuleFactory::CallbackFunctionType LoadableModuleFactory::GetModuleDiscoveryMessageCallback

(

)

References ModuleDiscoveryMessageCallback.

std::vector< std::string > LoadableModuleFactory::GetModuleNames

(

)

const

Get the names of all the modules.

Referenced by main(), and Slicer3_main().

const std::string& LoadableModuleFactory::GetName

(

)

const [inline]

Get the name of the module factory. The name is used in error messages (to refer to the application using the module factory) and in encoding entry points.

const std::string& LoadableModuleFactory::GetSearchPaths

(

)

const [inline]

Get the module search paths.

LoadableModuleFactory::CallbackFunctionType LoadableModuleFactory::GetWarningMessageCallback

(

)

References WarningMessageCallback.

void LoadableModuleFactory::InformationMessage

(

const char *

msg

)

[protected]

References InformationMessageCallback.

void LoadableModuleFactory::ModuleDiscoveryMessage

(

const char *

msg

)

[protected]

References ModuleDiscoveryMessageCallback.

void LoadableModuleFactory::Scan

(

)

[virtual]

Scan for modules in the module search path. This will locate command line modules as well as shared object modules.

References LoadableModuleDescription::GetName(), and WarningMessage().

Referenced by main(), and Slicer3_main().

long LoadableModuleFactory::ScanForSharedObjectModules

(

)

[protected, virtual]

Scan for shared object modules (i.e. DLL) in the module search path. Modules can either have global symbols or entry points to describe the module and logos. Returns the number of modules found (that have not already been discovered by another method).

References error(), LoadableModuleDescription::GetLocation(), LoadableModuleDescription::GetName(), LoadableModuleDescription::GetShortName(), LoadableModuleDescription::GetTarget(), LoadableModuleDescription::GetTclInitName(), LoadableModuleDescription::GetType(), ii, InformationMessage(), LoadableModuleCacheEntry::Location, LoadableModuleCacheEntry::ModifiedTime, NameIsSharedLibrary(), LoadableModuleDescriptionParser::Parse(), LoadableModuleDescription::SetGUIPtr(), LoadableModuleDescription::SetLocation(), LoadableModuleDescription::SetLogicPtr(), LoadableModuleDescription::SetTarget(), LoadableModuleDescription::SetTclInitFunction(), LoadableModuleDescription::SetType(), splitString(), LoadableModuleCacheEntry::Type, WarningMessage(), and LoadableModuleCacheEntry::XMLDescription.

void LoadableModuleFactory::SetErrorMessageCallback

(

CallbackFunctionType

f

)

Set/Get a function to call to report back errors.

References ErrorMessageCallback.

Referenced by main(), and Slicer3_main().

void LoadableModuleFactory::SetInformationMessageCallback

(

CallbackFunctionType

f

)

Set/Get a function to call to report back information.

References InformationMessageCallback.

Referenced by main(), and Slicer3_main().

void LoadableModuleFactory::SetModuleDiscoveryMessageCallback

(

CallbackFunctionType

f

)

Set/Get a function to call to report back a discovered module.

References ModuleDiscoveryMessageCallback.

Referenced by main(), and Slicer3_main().

void LoadableModuleFactory::SetName

(

const std::string &

name

)

[inline]

Set the name of the module factory. The name is used in error messages (to refer to the application using the module factory) and in encoding entry points.

Referenced by Slicer3_main().

void LoadableModuleFactory::SetSearchPaths

(

const std::string &

paths

)

[inline]

Set the search paths for modules (both command line modules and shared object modules). A list of ':' or ';' separated paths.

Referenced by main(), and Slicer3_main().

void LoadableModuleFactory::SetWarningMessageCallback

(

CallbackFunctionType

f

)

Set/Get a function to call to report back warnings.

References WarningMessageCallback.

Referenced by main(), and Slicer3_main().

void LoadableModuleFactory::WarningMessage

(

const char *

msg

)

[protected]

References WarningMessageCallback.

---

Member Data Documentation

bool LoadableModuleFactory::CacheModified [protected]

Referenced by LoadableModuleFactory().

std::string LoadableModuleFactory::CachePath [private]

CallbackFunctionType LoadableModuleFactory::ErrorMessageCallback [private]

Referenced by ErrorMessage(), GetErrorMessageCallback(), LoadableModuleFactory(), and SetErrorMessageCallback().

CallbackFunctionType LoadableModuleFactory::InformationMessageCallback [private]

Referenced by GetInformationMessageCallback(), InformationMessage(), LoadableModuleFactory(), and SetInformationMessageCallback().

LoadableModuleCache* LoadableModuleFactory::InternalCache [protected]

Referenced by LoadableModuleFactory(), and ~LoadableModuleFactory().

LoadableModuleFileMap* LoadableModuleFactory::InternalFileMap [protected]

Referenced by LoadableModuleFactory(), and ~LoadableModuleFactory().

LoadableModuleDescriptionMap* LoadableModuleFactory::InternalMap [protected]

Referenced by LoadableModuleFactory(), and ~LoadableModuleFactory().

CallbackFunctionType LoadableModuleFactory::ModuleDiscoveryMessageCallback [private]

Referenced by GetModuleDiscoveryMessageCallback(), LoadableModuleFactory(), ModuleDiscoveryMessage(), and SetModuleDiscoveryMessageCallback().

std::string LoadableModuleFactory::Name [private]

Referenced by LoadableModuleFactory().

std::string LoadableModuleFactory::SearchPaths [private]

CallbackFunctionType LoadableModuleFactory::WarningMessageCallback [private]

Referenced by GetWarningMessageCallback(), LoadableModuleFactory(), SetWarningMessageCallback(), and WarningMessage().

---

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

• Libs/LoadableModule/LoadableModuleFactory.h
• Libs/LoadableModule/LoadableModuleFactory.cxx