Studierstube 4 Documentation Project

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

ComponentInfo Class Reference
[Kernel Classes]

#include <ComponentInfo.h>

List of all members.

Public Types

enum  AVAILABILITY { ON_LOAD = 0, ON_DEMAND = 1, ON_LOAD = 0, ON_DEMAND = 1 }
enum  AVAILABILITY { ON_LOAD = 0, ON_DEMAND = 1, ON_LOAD = 0, ON_DEMAND = 1 }

Public Member Functions

 ComponentInfo ()
 ~ComponentInfo ()
void readConfiguration (TiXmlElement *element)
stb::string getName ()
stb::string getLibName ()
hModule getLibHandle ()
void setHModule (hModule aLibHandle)
ComponentInfo::AVAILABILITY getAvailability ()
void setAvailability (AVAILABILITY avl)
 ComponentInfo ()
 ~ComponentInfo ()
void readConfiguration (TiXmlElement *element)
stb::string getName ()
stb::string getLibName ()
hModule getLibHandle ()
void setHModule (hModule aLibHandle)
ComponentInfo::AVAILABILITY getAvailability ()
void setAvailability (AVAILABILITY avl)

Protected Attributes

stb::string typeID
stb::string name
stb::string libName
hModule libHandle
AVAILABILITY availability
std::map< stb::string,
stb::string
parameter

Friends

class Component


Detailed Description

A ComponentInfo object is used to store all relevant information about a component. These are in particular:

Definition at line 59 of file _CPack_Packages/Linux-Source/TBZ2/studierstube-4.3/include/stb/kernel/ComponentInfo.h.


Member Enumeration Documentation

Enumerator:
ON_LOAD 
ON_DEMAND 
ON_LOAD 
ON_DEMAND 

Definition at line 76 of file include/stb/kernel/ComponentInfo.h.

Enumerator:
ON_LOAD 
ON_DEMAND 
ON_LOAD 
ON_DEMAND 

Definition at line 76 of file _CPack_Packages/Linux-Source/TBZ2/studierstube-4.3/include/stb/kernel/ComponentInfo.h.


Constructor & Destructor Documentation

BEGIN_NAMESPACE_STB ComponentInfo (  ) 

~ComponentInfo (  ) 

The destructor.

Definition at line 48 of file _CPack_Packages/Linux-Source/TBZ2/studierstube-4.3/src/kernel/ComponentInfo.cxx.

References libHandle, and os_FreeLibrary().

Here is the call graph for this function:

ComponentInfo (  ) 

The Constructor

~ComponentInfo (  ) 

The destructor.


Member Function Documentation

ComponentInfo::AVAILABILITY getAvailability (  ) 

hModule getLibHandle (  )  [inline]

Definition at line 106 of file include/stb/kernel/ComponentInfo.h.

hModule getLibHandle (  )  [inline]

stb::string getLibName (  )  [inline]

Return the components library name.

Definition at line 101 of file include/stb/kernel/ComponentInfo.h.

stb::string getLibName (  )  [inline]

Return the components library name.

Definition at line 101 of file _CPack_Packages/Linux-Source/TBZ2/studierstube-4.3/include/stb/kernel/ComponentInfo.h.

Referenced by ComponentRetriever::getComponent().

stb::string getName (  )  [inline]

Returns the components name

Definition at line 96 of file include/stb/kernel/ComponentInfo.h.

void readConfiguration ( TiXmlElement *  element  ) 

Reads an xml element to configure this ComponentInfo

  • the elements value is <Component></Component>, <Application></Application>, or <ApplicationThread> </ApplicationThread> and it defines the stb::string typeID which is later used to identify the current component's base type.
  • parameter lib - defines the libraries name
  • parameter name - defines the componets name
  • parameter availability [ondemand|onload]
  • Foreeach component specific parameter key="aKey" value="aValue"

void readConfiguration ( TiXmlElement *  element  ) 

Reads an xml element to configure this ComponentInfo

  • the elements value is <Component></Component>, <Application></Application>, or <ApplicationThread> </ApplicationThread> and it defines the stb::string typeID which is later used to identify the current component's base type.
  • parameter lib - defines the libraries name
  • parameter name - defines the componets name
  • parameter availability [ondemand|onload]
  • Foreeach component specific parameter key="aKey" value="aValue"

>

Definition at line 76 of file _CPack_Packages/Linux-Source/TBZ2/studierstube-4.3/src/kernel/ComponentInfo.cxx.

References availability, libName, logPrintE(), name, ON_DEMAND, ON_LOAD, parameter, stricasecmp(), string, and typeID.

Referenced by Config::parseXMLElement().

Here is the call graph for this function:

void setAvailability ( AVAILABILITY  avl  ) 

void setAvailability ( AVAILABILITY  avl  ) 

void setHModule ( hModule  aLibHandle  ) 

void setHModule ( hModule  aLibHandle  ) 

Definition at line 54 of file _CPack_Packages/Linux-Source/TBZ2/studierstube-4.3/src/kernel/ComponentInfo.cxx.

References libHandle, and os_FreeLibrary().

Referenced by ComponentRetriever::getComponent().

Here is the call graph for this function:


Friends And Related Function Documentation


Member Data Documentation


The documentation for this class was generated from the following files:
 This page was generated at Wed Oct 27 13:02:54 2010 for Studierstube 4 by Doxygen.
 If you have any comments, please send a message to schmalstieg#icg.tu-graz.ac.at.
www.studierstube.org