Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

zeitgeist::Zeitgeist Class Reference

main class, which initializes the Zeitgeist framework, manages the core and the main core context. More...

#include <zeitgeist.h>

List of all members.

Public Member Functions

 Zeitgeist (std::string dotName)
 constructs the main core and starts the zeitgeist framework.
 Zeitgeist (std::string dotName, std::string relPathPrefix)
 constructs the main core as above but changes the relative path prefix used by the ScriptServer prior to running the zeitgeist init script.
 ~Zeitgeist ()
boost::shared_ptr< CoreContextCreateContext ()
 creates a new corecontext
boost::shared_ptr< Core > & GetCore ()
 returns a pointer to the main core

Private Member Functions

void ConstructCore ()
 allocates and sets up the main core
void RunInitScript (std::string dotName)
 runs the zeitgeist init script.

Private Attributes

boost::shared_ptr< CoremCore
 the main core


Detailed Description

main class, which initializes the Zeitgeist framework, manages the core and the main core context.

It is the basic interface to the client code.

Definition at line 36 of file zeitgeist.h.


Constructor & Destructor Documentation

zeitgeist::Zeitgeist::Zeitgeist std::string  dotName  ) 
 

constructs the main core and starts the zeitgeist framework.

dotName gives the name of the directory in the user's home directory, where the default init scripts are searched.

zeitgeist::Zeitgeist::Zeitgeist std::string  dotName,
std::string  relPathPrefix
 

constructs the main core as above but changes the relative path prefix used by the ScriptServer prior to running the zeitgeist init script.

Zeitgeist::~Zeitgeist  ) 
 

Definition at line 47 of file zeitgeist.cpp.

References mCore.


Member Function Documentation

void Zeitgeist::ConstructCore  )  [private]
 

allocates and sets up the main core

Definition at line 60 of file zeitgeist.cpp.

References mCore.

boost::shared_ptr< CoreContext > Zeitgeist::CreateContext  ) 
 

creates a new corecontext

Definition at line 86 of file zeitgeist.cpp.

References mCore.

boost::shared_ptr< Core > & Zeitgeist::GetCore  ) 
 

returns a pointer to the main core

Definition at line 91 of file zeitgeist.cpp.

References mCore.

Referenced by spark::Spark::GetCore(), spark::Spark::GetLog(), spark::Spark::Init(), kerosin::Kerosin::Kerosin(), main(), and oxygen::Oxygen::Oxygen().

void zeitgeist::Zeitgeist::RunInitScript std::string  dotName  )  [private]
 

runs the zeitgeist init script.

dotName is the name of the users local directory, where the init scripts are searched


Member Data Documentation

boost::shared_ptr<Core> zeitgeist::Zeitgeist::mCore [private]
 

the main core

Definition at line 76 of file zeitgeist.h.

Referenced by ConstructCore(), CreateContext(), GetCore(), and ~Zeitgeist().


The documentation for this class was generated from the following files:
Generated on Thu Apr 6 15:51:20 2006 for rcssserver3d by  doxygen 1.4.4