|
PLearn 0.1
|
Description of a single type within the TypeMap. More...
#include <TypeFactory.h>

Public Member Functions | |
| TypeMapEntry (const string &the_type_name, const string &the_parent_class="", NEW_OBJECT the_constructor=0, GETOPTIONLIST_METHOD the_getoptionlist_method=0, GET_REMOTE_METHODS the_get_remote_methods=0, ISA_METHOD the_isa_method=0, const string &the_one_line_descr="", const string &the_multi_line_help="", const PPath &the_declaring_file=PPath("")) | |
Public Attributes | |
| string | type_name |
Name of the "type" (derived from PLearn::Object) | |
| string | parent_class |
| Name of the base class. | |
| NEW_OBJECT | constructor |
| Function pointer which, when called, instantiates a new object with the default constructor. | |
| GETOPTIONLIST_METHOD | getoptionlist_method |
| Function pointer which, when called, returns a pointer to the list of options supported by the class. | |
| GET_REMOTE_METHODS | get_remote_methods |
| Function pointer which, when called, returns a list of remote methods supported by the class. | |
| ISA_METHOD | isa_method |
| Function pointer which, when called with a pointer to an object, tests whether the object is dynamic-castable to the type (class). | |
| string | one_line_descr |
| Short one-line documentation string. | |
| string | multi_line_help |
| Detailed documentation for users. | |
| PPath | declaring_file |
| Filename where this type (class) is declared (i.e. to include) | |
Description of a single type within the TypeMap.
Definition at line 66 of file TypeFactory.h.
| PLearn::TypeMapEntry::TypeMapEntry | ( | const string & | the_type_name, |
| const string & | the_parent_class = "", |
||
| NEW_OBJECT | the_constructor = 0, |
||
| GETOPTIONLIST_METHOD | the_getoptionlist_method = 0, |
||
| GET_REMOTE_METHODS | the_get_remote_methods = 0, |
||
| ISA_METHOD | the_isa_method = 0, |
||
| const string & | the_one_line_descr = "", |
||
| const string & | the_multi_line_help = "", |
||
| const PPath & | the_declaring_file = PPath("") |
||
| ) | [inline] |
Definition at line 102 of file TypeFactory.h.
: type_name(the_type_name), parent_class(the_parent_class), constructor(the_constructor), getoptionlist_method(the_getoptionlist_method), get_remote_methods(the_get_remote_methods), isa_method(the_isa_method), one_line_descr(the_one_line_descr), multi_line_help(the_multi_line_help), declaring_file(the_declaring_file) { }
Function pointer which, when called, instantiates a new object with the default constructor.
This can be null, in which case the class is considered abstract.
Definition at line 78 of file TypeFactory.h.
Referenced by PLearn::HelpSystem::getOptionDefaultVal(), PLearn::HelpSystem::getOptionDefiningClass(), PLearn::HTMLHelpCommand::helpOnClass(), PLearn::HelpSystem::helpOnClassHTML(), PLearn::TypeFactory::isAbstract(), PLearn::HelpSystem::listDerivedClasses(), and PLearn::TypeFactory::newObject().
Filename where this type (class) is declared (i.e. to include)
Definition at line 100 of file TypeFactory.h.
Referenced by PLearn::HelpSystem::helpOnClassHTML().
Function pointer which, when called, returns a list of remote methods supported by the class.
Definition at line 86 of file TypeFactory.h.
Referenced by PLearn::HelpSystem::helpOnMethod(), and PLearn::HelpSystem::helpOnMethodHTML().
Function pointer which, when called, returns a pointer to the list of options supported by the class.
Definition at line 82 of file TypeFactory.h.
Referenced by PLearn::HelpSystem::getOptionByName(), PLearn::HelpSystem::listClassOptionsWithLevels(), and PLearn::Plide::precisOnClass().
Function pointer which, when called with a pointer to an object, tests whether the object is dynamic-castable to the type (class).
Definition at line 91 of file TypeFactory.h.
Referenced by PLearn::HelpSystem::listDerivedClasses(), and PLearn::ObjectGraphIterator::ObjectGraphIterator().
Detailed documentation for users.
Definition at line 97 of file TypeFactory.h.
Referenced by PLearn::HelpSystem::helpOnClassHTML().
Short one-line documentation string.
Definition at line 94 of file TypeFactory.h.
Referenced by PLearn::HelpSystem::helpClasses(), PLearn::HelpSystem::helpClassesHTML(), PLearn::HelpSystem::helpDerivedClasses(), PLearn::HTMLHelpCommand::helpOnClass(), PLearn::HelpSystem::helpOnClassHTML(), PLearn::Plide::precisOnClass(), and PLearn::HelpSystem::precisOnClass().
Name of the base class.
Definition at line 73 of file TypeFactory.h.
Referenced by PLearn::HelpSystem::helpClasses(), PLearn::HelpSystem::helpClassesHTML(), and PLearn::HelpSystem::listClassParents().
Name of the "type" (derived from PLearn::Object)
Definition at line 70 of file TypeFactory.h.
Referenced by PLearn::TypeFactory::registerType().
1.7.4