Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

kore::Module::Info Class Reference

class kore::Module::Info - provides usefull information on a module. More...

#include <module.h>

List of all members.

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

Detailed Description

class kore::Module::Info - provides usefull information on a module.

helper class.

Definition at line 27 of file module.h.

Constructor & Destructor Documentation

Module::Info::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.

Parameters:
module  - the Module object this Info is associated to
name  - the name of this module
type  - the type (class/API) of this module
description  - short description of the module
version  - the version of this module
api  - kore API version required by this module

Definition at line 16 of file module.cpp.

References description(), module(), kore::Module::Module(), name(), setInfo(), type(), and version(). 

00017 {
00018     setInfo(module, name, type, description, version, api);
00019 }

Module::Info::~Info (    )  [virtual]
 

Definition at line 20 of file module.cpp. 

00021 {
00022 }

Module::Info::Info (    )  [protected]
 

Default constructor, for creating an empty Info object.

Definition at line 12 of file module.cpp.

References setInfo(). 

00013 {
00014     setInfo();
00015 }

Member Function Documentation

const Version * Module::Info::APIVersion (    )  const [virtual]
 

Gets the API version requiered by this module.

Returns:
- API version

Definition at line 44 of file module.cpp.

References _api. 

00045 {
00046     return _api;
00047 }

const char * Module::Info::description (    )  const [virtual]
 

Gets the module description string.

Returns:
- module description.

Definition at line 36 of file module.cpp.

References _description.

Referenced by Info(), setDescription(), and setInfo(). 

00037 {
00038     return _description;
00039 }

Module * Module::Info::module (    )  const [virtual]
 

Gets the kore::Module this instance is associated to.

Returns:
- the module.

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 }

const char * Module::Info::name (    )  const [virtual]
 

Gets the name of the module.

Returns:
- module name

Definition at line 28 of file module.cpp.

References _name.

Referenced by Info(), setInfo(), and setName(). 

00029 {
00030     return _name;
00031 }

void Module::Info::setAPIVersion (  const Version *    api = 0 )  [protected]
 

Convenience method for setting the API version required by this Module.

Parameters:
api  - API version.

Definition at line 72 of file module.cpp.

References _api.

Referenced by setInfo(). 

00073 {
00074     _api = api;
00075 }

void Module::Info::setDescription (  const char *    description = 0 )  [protected]
 

Convenience method for setting the Module description.

Parameters:
descr  - module description

Definition at line 64 of file module.cpp.

References _description, and description().

Referenced by setInfo(). 

00065 {
00066     _description = description;
00067 }

void Module::Info::setInfo (  Module *    module = 0,
const char *    name = 0,
const char *    type = 0,
const char *    description = 0,
const Version *    version = 0,
const Version *    api = 0
)  [protected]
 

Convenience method for setting all the Module information "in one shot".

Parameters:
module  - the Module object this Info is associated to
name  - the name of this module
type  - the type (class/API) of this module
description  - short description of the module
version  - the version of this module
api  - kore API version required by this module

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 }

void Module::Info::setModule (  Module *    module = 0 )  [protected]
 

Convenience method for setting the Module this Info is associated to.

Parameters:
module  - the module.

Definition at line 49 of file module.cpp.

References _module, module(), and kore::Module::Module().

Referenced by setInfo(). 

00050 {
00051     _module = module;
00052 }

void Module::Info::setName (  const char *    name = 0 )  [protected]
 

Convenience method for setting the Module name.

Parameters:
name  - module name.

Definition at line 53 of file module.cpp.

References _name, and name().

Referenced by setInfo(). 

00054 {
00055     _name = name;
00056 }

void Module::Info::setType (  const char *    type = 0 )  [protected]
 

Convenience method for setting the Module type.

Parameters:
type  - 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 }

void Module::Info::setVersion (  const Version *    version = 0 )  [protected]
 

Conveninence method for setting the Module version.

Parameters:
version  - module version.

Definition at line 68 of file module.cpp.

References _version, and version().

Referenced by setInfo(). 

00069 {
00070     _version = version;
00071 }

const char * Module::Info::type (    )  const [virtual]
 

Gets the module type.

Returns:
- module type.

Definition at line 32 of file module.cpp.

References _type.

Referenced by Info(), setInfo(), and setType(). 

00033 {
00034     return _type;
00035 }

const Version * Module::Info::version (    )  const [virtual]
 

Gets the version of the module.

Returns:
- module version.

Definition at line 40 of file module.cpp.

References _version.

Referenced by Info(), setInfo(), and setVersion(). 

00041 {
00042     return _version;
00043 }

Member Data Documentation

const Version* kore::Module::Info::_api [private]
 

Definition at line 129 of file module.h.

Referenced by APIVersion(), and setAPIVersion().

const char* kore::Module::Info::_description [private]
 

Definition at line 125 of file module.h.

Referenced by description(), and setDescription().

Module* kore::Module::Info::_module [private]
 

Definition at line 119 of file module.h.

Referenced by module(), and setModule().

const char* kore::Module::Info::_name [private]
 

Definition at line 121 of file module.h.

Referenced by name(), and setName().

const char* kore::Module::Info::_type [private]
 

Definition at line 123 of file module.h.

Referenced by setType(), and type().

const Version* kore::Module::Info::_version [private]
 

Definition at line 127 of file module.h.

Referenced by setVersion(), and version().

The documentation for this class was generated from the following files:
Generated on Sat Feb 16 08:40:50 2002 for Korelib by doxygen1.2.12 written by Dimitri van Heesch, © 1997-2001