Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

InterfaceRegistry Class Reference

Singleton class to store and access all ObjectInterfaces in the application. More...

#include <InterfaceRegistry.h>

List of all members.

Public Types

typedef std::vector< InterfaceProxy * > interface_list

Public Methods

InterfaceProxy * getInterface (const char *name)
 Get an object interface by object class name.

InterfaceProxy * getInterface (hasht key)
 Get an object interface by object class hash.

bool hasInterface (const char *name)
 Test if an object interface is registered.

bool hasInterface (hasht key)
 Test if an object interface is registered.

std::vector< std::string > getInterfaceNames () const
 Get a list of all object class names in the registry.

std::vector< InterfaceProxy * > getInterfaces () const
 Get a list of all interfaces in the registry.


Static Public Methods

InterfaceRegistry & getInterfaceRegistry ()
 Get the interface registry singleton.


Friends

class InterfaceProxy
class Singleton< InterfaceRegistry >

Detailed Description

Singleton class to store and access all ObjectInterfaces in the application.

ObjectInterfaces automatically register themselves with the global instance of this class at startup. Interfaces can be accessed by name to provide dynamic object creation and variable assignment. See Object Interfaces and Interface Proxies for details.

Author:
Mark Rose <mrose@stm.lbl.gov>

Member Typedef Documentation

typedef std::vector<InterfaceProxy *> InterfaceRegistry::interface_list
 

Member Function Documentation

InterfaceProxy * InterfaceRegistry::getInterface (  hasht    key ) 
 

Get an object interface by object class hash.

Returns:
0 if the interface is not found.

InterfaceProxy * InterfaceRegistry::getInterface (  const char *    name ) 
 

Get an object interface by object class name.

Returns:
0 if the interface is not found.

std::vector< std::string > InterfaceRegistry::getInterfaceNames (    ) 
 

Get a list of all object class names in the registry.

InterfaceRegistry& InterfaceRegistry::getInterfaceRegistry (    )  [inline, static]
 

Get the interface registry singleton.

std::vector< InterfaceProxy * > InterfaceRegistry::getInterfaces (    ) 
 

Get a list of all interfaces in the registry.

bool InterfaceRegistry::hasInterface (  hasht    key ) 
 

Test if an object interface is registered.

Parameters:
key  The object class hash.

bool InterfaceRegistry::hasInterface (  const char *    name ) 
 

Test if an object interface is registered.

Parameters:
name  The object class name.

Friends And Related Function Documentation

friend class InterfaceProxy [friend]
 

friend class Singleton< InterfaceRegistry > [friend]
 

The documentation for this class was generated from the following files:
SimData version pre-0.4.0. For more information on SimData, visit the SimData Homepage.

Generated on Tue Oct 14 12:06:41 2003, using Doxygen 1.2.18.

[SF.net]