Kaim::GeneratorBaseSystem Class Reference

#include <generatorbasesystem.h>

Class Description

The GeneratorBaseSystem class is a helper tool that enable the user to correctly initialize the BaseSystem for generating the NavData.

There are two ways to use GeneratorBaseSystem, 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.

Public Types
typedef BaseSystemConfig	Config
	Defines a type for the configuration object used to initialize the GeneratorBaseSystem. More...

Public Member Functions
	GeneratorBaseSystem ()
	Creates and sets up the new BaseSystem with a default configuration. More...
	GeneratorBaseSystem (BaseSystemConfig &config)
	Creates and sets up the BaseSystem according to the specified configuration. More...
	~GeneratorBaseSystem ()
	Calls static function GeneratorBaseSystem::Destroy() More...

Static Public Member Functions
static void	Init (BaseSystemConfig &config)
	Initialize. 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 GeneratorBaseSystem remains to be freed. More...
static void	Destroy ()
	Destroys the GeneratorBaseSystem. More...

Member Typedef Documentation

typedef BaseSystemConfig Kaim::GeneratorBaseSystem::Config

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

Constructor & Destructor Documentation

Kaim::GeneratorBaseSystem::GeneratorBaseSystem ( )

inline

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

Kaim::GeneratorBaseSystem::GeneratorBaseSystem ( BaseSystemConfig &  config )

inline

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

Kaim::GeneratorBaseSystem::~GeneratorBaseSystem ( )

inline

Calls static function GeneratorBaseSystem::Destroy()

Member Function Documentation

static void Kaim::GeneratorBaseSystem::Destroy ( )

inlinestatic

Destroys the GeneratorBaseSystem.

static bool Kaim::GeneratorBaseSystem::HasMemoryLeaks ( )

inlinestatic

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

Call this method only after you destroy the BaseSystem.

static void Kaim::GeneratorBaseSystem::Init ( BaseSystemConfig &  config )

inlinestatic

Initialize.

static bool Kaim::GeneratorBaseSystem::IsInitialized ( )

inlinestatic

Indicates whether or not the BaseSystem has been successfully initialized.

---

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

• gwnavgeneration/generator/generatorbasesystem.h