Panda3D

Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
FactoryBase Class Reference

A Factory can be used to create an instance of a particular subclass of some general base class. More...

`#include "factoryBase.h"`

Inheritance diagram for FactoryBase:

## Public Types
typedef TypedObject * | BaseCreateFunc(const FactoryParams &params)

## Public Member Functions
| FactoryBase (const FactoryBase &copy)=delete
void | add_preferred (TypeHandle handle)
| Adds the indicated type to the end of the list of preferred types.
void | clear_preferred ()
| Empties the list of preferred types.
TypeHandle | find_registered_type (TypeHandle handle)
| Returns the TypeHandle given, if it is a registered type, or if it is not registered, searches for the nearest ancestor of the indicated type that is registered and returns it.
size_t | get_num_preferred () const
| Returns the number of types added to the preferred-type list.
size_t | get_num_types () const
| Returns the number of different types the Factory knows how to create.
TypeHandle | get_preferred (size_t n) const
| Returns the nth type added to the preferred-type list.
TypeHandle | get_type (size_t n) const
| Returns the nth type the Factory knows how to create.
TypedObject * | make_instance (const std::string &type_name, const FactoryParams &params)
| Attempts to create a new instance of some class of the indicated type, or some derivative if necessary.
TypedObject * | make_instance (TypeHandle handle, const FactoryParams &params)
| Attempts to create a new instance of some class of the indicated type, or some derivative if necessary.
TypedObject * | make_instance_more_general (const std::string &type_name, const FactoryParams &params)
| Attempts to create an instance of the type requested, or some base type of the type requested.
TypedObject * | make_instance_more_general (TypeHandle handle, const FactoryParams &params)
| Attempts to create an instance of the type requested, or some base type of the type requested.
FactoryBase & | operator= (const FactoryBase &copy)=delete
void | register_factory (TypeHandle handle, BaseCreateFunc *func, void *user_data=nullptr)
| Registers a new kind of thing the Factory will be able to create.
void | write_types (std::ostream &out, int indent_level=0) const
| Writes a list of all known types the Factory can create to the indicated output stream, one per line.

## Detailed Description

A Factory can be used to create an instance of a particular subclass of some general base class.

Each subclass registers itself with the Factory, supplying a function that will construct an instance of that subclass; the Factory can later choose a suitable subclass and return a newly-constructed pointer to an object of that type on the user's demand. This is used, for instance, to manage the set of GraphicsPipes available to the user.

FactoryBase is the main definition of the thin template class Factory.

Definition at line 36 of file factoryBase.h.

## Member Typedef Documentation

## ◆ BaseCreateFunc

typedef TypedObject * FactoryBase::BaseCreateFunc(const FactoryParams &params)

Definition at line 38 of file factoryBase.h.

## Member Function Documentation

## ◆ add_preferred()

void FactoryBase::add_preferred | ( | TypeHandle | handle | ) |

Adds the indicated type to the end of the list of preferred types.

On the next call to make_instance(), if the exact type requested cannot be created, the preferred types are first tried in the order specified.

Definition at line 173 of file factoryBase.cxx.

## ◆ clear_preferred()

void FactoryBase::clear_preferred | ( |  | ) |

Empties the list of preferred types.

Definition at line 163 of file factoryBase.cxx.

## ◆ find_registered_type()

TypeHandle FactoryBase::find_registered_type | ( | TypeHandle | handle | ) |

Returns the TypeHandle given, if it is a registered type, or if it is not registered, searches for the nearest ancestor of the indicated type that is registered and returns it.

If no ancestor of the indicated type is registered, returns TypeHandle::none().

Definition at line 89 of file factoryBase.cxx.

References find_registered_type(), TypeHandle::get_num_parent_classes, and TypeHandle::get_parent_class.

Referenced by find_registered_type().

## ◆ get_num_preferred()

size_t FactoryBase::get_num_preferred | ( |  | ) | const

Returns the number of types added to the preferred-type list.

Definition at line 182 of file factoryBase.cxx.

Referenced by get_preferred().

## ◆ get_num_types()

size_t FactoryBase::get_num_types | ( |  | ) | const

Returns the number of different types the Factory knows how to create.

Definition at line 134 of file factoryBase.cxx.

Referenced by get_type().

## ◆ get_preferred()

TypeHandle FactoryBase::get_preferred | ( | size_t | n | ) | const

Returns the nth type added to the preferred-type list.

Definition at line 190 of file factoryBase.cxx.

References get_num_preferred().

## ◆ get_type()

TypeHandle FactoryBase::get_type | ( | size_t | n | ) | const

Returns the nth type the Factory knows how to create.

This is not a terribly efficient function; it's included primarily for debugging output. Normally you wouldn't need to traverse the list of the Factory's types.

Definition at line 144 of file factoryBase.cxx.

References get_num_types().

## ◆ make_instance() [1/2]

TypedObject * FactoryBase::make_instance | ( | const std::string & | type_name,
|  | const FactoryParams & | params )
| inline

Attempts to create a new instance of some class of the indicated type, or some derivative if necessary.

If an instance of the exact type cannot be created, the specified priorities will specify which derived class will be preferred.

This flavor of make_instance() accepts a string name that indicates the desired type. It must be the name of some already-registered type.

Definition at line 23 of file factoryBase.I.

References TypeRegistry::find_type(), make_instance(), and TypeRegistry::ptr().

## ◆ make_instance() [2/2]

TypedObject * FactoryBase::make_instance | ( | TypeHandle | handle,
|  | const FactoryParams & | params )

Attempts to create a new instance of some class of the indicated type, or some derivative if necessary.

If an instance of the exact type cannot be created, the specified preferred will specify which derived class will be preferred.

Definition at line 24 of file factoryBase.cxx.

Referenced by Factory< Type >::make_instance(), and make_instance().

## ◆ make_instance_more_general() [1/2]

TypedObject * FactoryBase::make_instance_more_general | ( | const std::string & | type_name,
|  | const FactoryParams & | params )
| inline

Attempts to create an instance of the type requested, or some base type of the type requested.

Returns the new instance created, or NULL if the instance could not be created.

This flavor of make_instance_more_general() accepts a string name that indicates the desired type. It must be the name of some already-registered type.

Definition at line 41 of file factoryBase.I.

References TypeRegistry::find_type(), make_instance_more_general(), and TypeRegistry::ptr().

## ◆ make_instance_more_general() [2/2]

TypedObject * FactoryBase::make_instance_more_general | ( | TypeHandle | handle,
|  | const FactoryParams & | params )

Attempts to create an instance of the type requested, or some base type of the type requested.

Returns the new instance created, or NULL if the instance could not be created.

Definition at line 52 of file factoryBase.cxx.

References TypeHandle::get_num_parent_classes, TypeHandle::get_parent_class, and make_instance_more_general().

Referenced by Factory< Type >::make_instance_more_general(), make_instance_more_general(), and make_instance_more_general().

## ◆ register_factory()

void FactoryBase::register_factory | ( | TypeHandle | handle,
|  | BaseCreateFunc * | func,
|  | void * | user_data = nullptr )

Registers a new kind of thing the Factory will be able to create.

Parameters

  user_data | an optional pointer to be passed along to the function.

Definition at line 120 of file factoryBase.cxx.

Referenced by Factory< Type >::register_factory().

## ◆ write_types()

void FactoryBase::write_types | ( | std::ostream & | out,
|  | int | indent_level = 0 ) const

Writes a list of all known types the Factory can create to the indicated output stream, one per line.

Definition at line 200 of file factoryBase.cxx.

References indent().

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

- panda/src/putil/factoryBase.h
- panda/src/putil/factoryBase.cxx
- panda/src/putil/factoryBase.I