CTK 0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Public Types | Public Member Functions | Protected Types | Protected Attributes | List of all members
ctkFactoryLibraryItem< BaseClassType > Class Template Reference

#include <Libs/Core/ctkAbstractLibraryFactory.h>

Inheritance diagram for ctkFactoryLibraryItem< BaseClassType >:
Inheritance graph
[legend]
Collaboration diagram for ctkFactoryLibraryItem< BaseClassType >:
Collaboration graph
[legend]

Public Types

typedef void * SymbolAddressType
 

Public Member Functions

virtual bool load ()
 
bool resolve ()
 Resolve symbols. More...
 
void setLoadHints (QLibrary::LoadHints hints)
 Set lookup hints for symbol resolution. See QLibrary documentation. More...
 
void setSymbols (const QStringList &symbols)
 Set list of required symbols. More...
 
SymbolAddressType symbolAddress (const QString &symbol) const
 Get symbol address. More...
 
- Public Member Functions inherited from ctkAbstractFactoryFileBasedItem< BaseClassType >
QString path () const
 
void setPath (const QString &path)
 Get path associated with the object identified by key. More...
 
- Public Member Functions inherited from ctkAbstractFactoryItem< BaseClassType >
 ctkAbstractFactoryItem ()
 
BaseClassType * instance () const
 
BaseClassType * instantiate ()
 
QStringList instantiateErrorStrings () const
 
QStringList instantiateWarningStrings () const
 
bool isInstantiated () const
 
virtual bool load ()=0
 
QStringList loadErrorStrings () const
 
QStringList loadWarningStrings () const
 
void setVerbose (bool value)
 
virtual void uninstantiate ()
 
bool verbose () const
 
virtual ~ctkAbstractFactoryItem ()
 

Protected Types

typedef QHash< QString, SymbolAddressType >::const_iterator ConstIterator
 
typedef QHash< QString, SymbolAddressType >::iterator Iterator
 

Protected Attributes

QLibrary Library
 
QHash< QString, SymbolAddressTypeResolvedSymbols
 
QStringList Symbols
 
- Protected Attributes inherited from ctkAbstractFactoryItem< BaseClassType >
BaseClassType * Instance
 

Additional Inherited Members

- Protected Member Functions inherited from ctkAbstractFactoryItem< BaseClassType >
void appendInstantiateErrorString (const QString &msg)
 
void appendInstantiateWarningString (const QString &msg)
 
void appendLoadErrorString (const QString &msg)
 
void appendLoadWarningString (const QString &msg)
 
void clearInstantiateErrorStrings ()
 
void clearInstantiateWarningStrings ()
 
void clearLoadErrorStrings ()
 
void clearLoadWarningStrings ()
 
virtual BaseClassType * instanciator ()=0
 Must be reimplemented in subclasses to instanciate a BaseClassType*. More...
 

Detailed Description

template<typename BaseClassType>
class ctkFactoryLibraryItem< BaseClassType >

Definition at line 35 of file ctkAbstractLibraryFactory.h.

Member Typedef Documentation

◆ ConstIterator

template<typename BaseClassType >
typedef QHash<QString,SymbolAddressType>::const_iterator ctkFactoryLibraryItem< BaseClassType >::ConstIterator
protected

Definition at line 47 of file ctkAbstractLibraryFactory.h.

◆ Iterator

template<typename BaseClassType >
typedef QHash<QString,SymbolAddressType>::iterator ctkFactoryLibraryItem< BaseClassType >::Iterator
protected

Definition at line 48 of file ctkAbstractLibraryFactory.h.

◆ SymbolAddressType

template<typename BaseClassType >
typedef void* ctkFactoryLibraryItem< BaseClassType >::SymbolAddressType

Definition at line 41 of file ctkAbstractLibraryFactory.h.

Member Function Documentation

◆ load()

template<typename BaseClassType >
virtual bool ctkFactoryLibraryItem< BaseClassType >::load ( )
virtual

◆ resolve()

template<typename BaseClassType >
bool ctkFactoryLibraryItem< BaseClassType >::resolve ( )

Resolve symbols.

Note
The function will return False if it fails to resolve one of the required symbols set using setSymbols(const QStringList&)

◆ setLoadHints()

template<typename BaseClassType >
void ctkFactoryLibraryItem< BaseClassType >::setLoadHints ( QLibrary::LoadHints  hints)

Set lookup hints for symbol resolution. See QLibrary documentation.

◆ setSymbols()

template<typename BaseClassType >
void ctkFactoryLibraryItem< BaseClassType >::setSymbols ( const QStringList &  symbols)

Set list of required symbols.

◆ symbolAddress()

template<typename BaseClassType >
SymbolAddressType ctkFactoryLibraryItem< BaseClassType >::symbolAddress ( const QString &  symbol) const

Get symbol address.

Member Data Documentation

◆ Library

template<typename BaseClassType >
QLibrary ctkFactoryLibraryItem< BaseClassType >::Library
mutableprotected

Definition at line 73 of file ctkAbstractLibraryFactory.h.

◆ ResolvedSymbols

template<typename BaseClassType >
QHash<QString, SymbolAddressType> ctkFactoryLibraryItem< BaseClassType >::ResolvedSymbols
protected

Definition at line 74 of file ctkAbstractLibraryFactory.h.

◆ Symbols

template<typename BaseClassType >
QStringList ctkFactoryLibraryItem< BaseClassType >::Symbols
protected

Definition at line 75 of file ctkAbstractLibraryFactory.h.


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