#include <module.h>
Public Methods | |
Info (Module *module, const char *name=0, const char *type=0, const char *description=0, const Version *version=0, const Version *api=0) | |
Create a Info object. More... | |
virtual | ~Info () |
virtual Module * | module () const |
Gets the kore::Module this instance is associated to. More... | |
virtual const char * | name () const |
Gets the name of the module. More... | |
virtual const char * | type () const |
Gets the module type. More... | |
virtual const char * | description () const |
Gets the module description string. More... | |
virtual const Version * | version () const |
Gets the version of the module. More... | |
virtual const Version * | APIVersion () const |
Gets the API version requiered by this module. More... | |
Protected Methods | |
Info () | |
Default constructor, for creating an empty Info object. More... | |
void | setModule (Module *module=0) |
Convenience method for setting the Module this Info is associated to. More... | |
void | setName (const char *name=0) |
Convenience method for setting the Module name. More... | |
void | setType (const char *type=0) |
Convenience method for setting the Module type. More... | |
void | setDescription (const char *descr=0) |
Convenience method for setting the Module description. More... | |
void | setVersion (const Version *version=0) |
Conveninence method for setting the Module version. More... | |
void | setAPIVersion (const Version *api=0) |
Convenience method for setting the API version required by this Module. More... | |
void | setInfo (Module *module=0, const char *name=0, const char *type=0, const char *description=0, const Version *version=0, const Version *api=0) |
Convenience method for setting all the Module information "in one shot". More... | |
Private Attributes | |
Module * | _module |
const char * | _name |
const char * | _type |
const char * | _description |
const Version * | _version |
const Version * | _api |
helper class.
Definition at line 27 of file module.h.
|
Create a Info object.
Definition at line 16 of file module.cpp. References description(), module(), kore::Module::Module(), name(), setInfo(), type(), and version().
|
|
Definition at line 20 of file module.cpp.
00021 { 00022 } |
|
Default constructor, for creating an empty Info object.
Definition at line 12 of file module.cpp. References setInfo().
00013 { 00014 setInfo(); 00015 } |
|
Gets the API version requiered by this module.
Definition at line 44 of file module.cpp. References _api.
00045 { 00046 return _api; 00047 } |
|
Gets the module description string.
Definition at line 36 of file module.cpp. References _description. Referenced by Info(), setDescription(), and setInfo().
00037 { 00038 return _description; 00039 } |
|
Gets the kore::Module this instance is associated to.
Definition at line 24 of file module.cpp. References _module, and kore::Module::Module(). Referenced by Info(), setInfo(), and setModule().
00025 { 00026 return _module; 00027 } |
|
Gets the name of the module.
Definition at line 28 of file module.cpp. References _name. Referenced by Info(), setInfo(), and setName().
00029 { 00030 return _name; 00031 } |
|
Convenience method for setting the API version required by this Module.
Definition at line 72 of file module.cpp. References _api. Referenced by setInfo().
00073 { 00074 _api = api; 00075 } |
|
Convenience method for setting the Module description.
Definition at line 64 of file module.cpp. References _description, and description(). Referenced by setInfo().
00065 { 00066 _description = description; 00067 } |
|
Convenience method for setting all the Module information "in one shot".
Definition at line 76 of file module.cpp. References description(), module(), kore::Module::Module(), name(), setAPIVersion(), setDescription(), setModule(), setName(), setType(), setVersion(), type(), and version(). Referenced by Info().
00077 { 00078 setModule(module); 00079 setName(name); 00080 setType(type); 00081 setDescription(description); 00082 setVersion(version); 00083 setAPIVersion(version); 00084 } |
|
Convenience method for setting the Module this Info is associated to.
Definition at line 49 of file module.cpp. References _module, module(), and kore::Module::Module(). Referenced by setInfo().
|
|
Convenience method for setting the Module name.
Definition at line 53 of file module.cpp. Referenced by setInfo().
|
|
Convenience method for setting the Module type.
Definition at line 57 of file module.cpp. References _type, MODULE_TYPE, and type(). Referenced by setInfo().
00058 { 00059 if( type ) 00060 _type = type; 00061 else 00062 setType(MODULE_TYPE); 00063 } |
|
Conveninence method for setting the Module version.
Definition at line 68 of file module.cpp. References _version, and version(). Referenced by setInfo().
|
|
Gets the module type.
Definition at line 32 of file module.cpp. References _type. Referenced by Info(), setInfo(), and setType().
00033 { 00034 return _type; 00035 } |
|
Gets the version of the module.
Definition at line 40 of file module.cpp. References _version. Referenced by Info(), setInfo(), and setVersion().
00041 { 00042 return _version; 00043 } |
|
Definition at line 129 of file module.h. Referenced by APIVersion(), and setAPIVersion(). |
|
Definition at line 125 of file module.h. Referenced by description(), and setDescription(). |
|
|
|
|
|
|
|
Definition at line 127 of file module.h. Referenced by setVersion(), and version(). |