Kaim::BaseSystem Class Reference

#include <basesystem.h>

Class Description

The BaseSystem provides Autodesk 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
 Defines a type for the configuration object used to initialize the BaseSystem. More...
 

Public Member Functions

 BaseSystem ()
 Creates and sets up the new BaseSystem with a default configuration. More...
 
 BaseSystem (const Config &config)
 Creates and sets up the BaseSystem according to the specified configuration. More...
 
 ~BaseSystem ()
 Calls static function BaseSystem::Destroy() More...
 

Static Public Member Functions

static void Init (const Config &config)
 Sets up the BaseSystem according to the specified configuration. More...
 
static bool IsInitialized ()
 Indicates whether or not the BaseSystem has been successfully initialized. More...
 
static bool HasMemoryLeaks ()
 Indicates whether or not any memory allocated by the BaseSystem remains to be freed. More...
 
static void Destroy ()
 Destroys the BaseSystem. More...
 

Member Typedef Documentation

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 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
static bool Kaim::BaseSystem::IsInitialized ( )
inlinestatic

The documentation for this class was generated from the following files:
  • gwnavruntime/basesystem/basesystem.h
  • gwnavruntime/basesystem/basesystem.cpp