Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

vuUtilityFactory Class Reference

The factory class for creating vuUtilityWindow implementations. More...

#include <vuUtilityFactory.h>

List of all members.

Static Public Member Functions

vuUtilityWindowcreate (const char *name)
 Creates vuUtilityWindow implementations by name.
bool isAvailable (const char *name)
 Returns true if the named utility is available from the factory.
wxStringList listAvailable (const char *FileType)
 Lists the available vuUtilityWindow implementations that the factory can create.


Detailed Description

The factory class for creating vuUtilityWindow implementations.

The vuUtilityFactory class is responsible for creating/instantiating all the vuUtilityWindow implementations. It creates them by name using the create() method, then returns the implementation as a vuUtilityWindow class. It can also list all the vuUtilityWindow implementations that it can create. The class is a singleton, so all the methods are static and the class doesn't have to be instantiated.

Definition at line 16 of file vuUtilityFactory.h.


Member Function Documentation

vuUtilityWindow * vuUtilityFactory::create const char *  name  )  [static]
 

Creates vuUtilityWindow implementations by name.

The caller assumes control of the pointer and is responsible for deleting it. The method returns Null (0) if there are no vuUtilityWindow implementations of the given name.

Parameters:
name The name of the vuUtilityWindow implementation.
Returns:
A pointer to an instance of the new vuUtilityWindow implementation.

Definition at line 72 of file vuUtilityFactory.cpp.

Referenced by vuMainWindow::addUtility().

bool vuUtilityFactory::isAvailable const char *  name  )  [static]
 

Returns true if the named utility is available from the factory.

Parameters:
name The name of the vuUtilityWindow implementation.
Returns:
True if the utility can be created by the factory. False otherwise.

Definition at line 154 of file vuUtilityFactory.cpp.

wxStringList vuUtilityFactory::listAvailable const char *  FileType  )  [static]
 

Lists the available vuUtilityWindow implementations that the factory can create.

Allows the caller to check the functionality of the factory at runtime. This would be useful for creating a list of all possible vuUtilityWindow implementations available.

Returns:
A list of the available vuUtilityWindow implementations names.

Definition at line 235 of file vuUtilityFactory.cpp.

Referenced by vuMainWindow::createUtilityMenu(), and vuMainWindow::OnAddUtility().


The documentation for this class was generated from the following files:
Generated on Wed Dec 15 21:22:08 2004 for vuVolume by  doxygen 1.3.9.1