Kaim::BaseSystem Class Reference

#include <basesystem.h>

Class Description

The BaseSystem provides Gameware Navigation components with a set of objects used for memory allocation, logging, performance profiling, etc.

Only one BaseSystem can exist at any time. You can customize the default behavior of the BaseSystem by setting up an instance of the BaseSystemConfig class, and passing it in a call to Init(). See the BaseSystemConfig class for details.

To release any resources allocated internally by the BaseSystem, call Destroy().

There are two ways to use BaseSystem, either using static function Init() and Destroy() or by creating a BaseSystem instance.

When creating an instance, Init() is called in the constructor and Destroy() is called in the destructor.

Examples:

Public Types
typedef BaseSystemConfig	Config

Public Member Functions
	BaseSystem ()
	BaseSystem (const Config &config)
	~BaseSystem ()

Static Public Member Functions
static void	Destroy ()
static bool	HasMemoryLeaks ()
static void	Init (const Config &config)
static bool	IsInitialized ()

Member Typedef Documentation

typedef BaseSystemConfig Kaim::BaseSystem::Config

Defines a type for the configuration object used to initialize the BaseSystem.

Constructor & Destructor Documentation

Kaim::BaseSystem::BaseSystem ( )

inline

Creates and sets up the new BaseSystem with a default configuration.

Kaim::BaseSystem::BaseSystem ( const Config &  config )

inline

Creates and sets up the BaseSystem according to the specified configuration.

Kaim::BaseSystem::~BaseSystem ( )

inline

Calls static function BaseSystem::Destroy()

Member Function Documentation

static void Kaim::BaseSystem::Destroy ( )

static

Destroys the BaseSystem.

Examples:

static bool Kaim::BaseSystem::HasMemoryLeaks ( )

inlinestatic

Indicates whether or not any memory allocated by the BaseSystem remains to be freed.

Call this method only after you destroy the BaseSystem.

static void Kaim::BaseSystem::Init ( const Config &  config )

inlinestatic

Sets up the BaseSystem according to the specified configuration.

Examples:

static bool Kaim::BaseSystem::IsInitialized ( )

inlinestatic

Indicates whether or not the BaseSystem has been successfully initialized.

Examples:

---

The documentation for this class was generated from the following file:

• gwnavruntime/basesystem/basesystem.h