Class Description

The module class.

This is a strict singleton class. The only instance is found with namespace variable aworx::lib::CONFIG.

Definition at line 52 of file config.hpp.

Public Methods
	Config ()

Public Methods inherited from Module
	Module (const Module &)=delete

	Module (int version, int revision, const NCString &resourceCategory, uint64_t compilationFlags=0)

	Module (Module &&)=delete

virtual	~Module ()

ALIB_API bool	Bootstrap (BootstrapPhases targetPhase=BootstrapPhases::Final, int argc=0, const char argvN=nullptr, const wchar_t argvW=nullptr)

template<typename TChar >
bool	Bootstrap (int argc, TChar **argv, BootstrapPhases targetPhase=BootstrapPhases::Final)

void	BootstrapResource (const NString &name, const String &data)

void	BootstrapSetConfig (config::Configuration *pConfig)

void	BootstrapSetResourcePool (resources::ResourcePool *pool)

config::Configuration &	GetConfig ()

const String &	GetResource (const NString &name)

ResourcePool &	GetResourcePool ()

bool	IsBootstrapped ()

void	operator= (const Module &)=delete

void	operator= (Module &&)=delete

ALIB_API void	Shutdown (ShutdownPhases targetPhase=ShutdownPhases::Destruct)

const String &	TryResource (const NString &name)

ALIB_API bool	VerifyCompilationFlags (uint64_t compilationFlags)

Protected Methods
virtual void	bootstrap (BootstrapPhases phase, int argc, const char argv, const wchar_t wargv) override

virtual void	shutdown (ShutdownPhases phase) override

Additional Inherited Members
Public Types inherited from Module
enum	BootstrapPhases { PrepareResources = 1, PrepareConfig = 2, Final = 3 }

enum	ShutdownPhases { Announce = 1, Destruct = 2 }

Public Fields inherited from Module
std::vector< std::pair< const nchar *, uint64_t > >	CompilationFlagMeanings

const uint64_t	CompilationFlags

NCString	ResourceCategory

const int	Revision

const int	Version

Protected Static Fields inherited from Module
static bool	microModulesInitialized = false

Protected Fields inherited from Module
int	bootstrapState = 0

config::Configuration *	config = nullptr

bool	isConfigOwner = false

bool	isResourceOwner = false

resources::ResourcePool *	resourcePool = nullptr

Constructor & Destructor Documentation

Config ( )

Constructor.
While this is public, it must not be invoked as this is a strict singleton type. (See notes in 3.2.1 Singletons).

Definition at line 46 of file config.cpp.

overrideprotectedvirtual

Initializes this module.

Parameters

phase	The initialization phase to perform.
argc	The number of command line arguments. Defaults to `0`.
argv	List of command line arguments if given as single byte character strings.
wargv	List of command line arguments if given as multi-byte character strings.

Implements Module.

Definition at line 54 of file config.cpp.

Here is the call graph for this function:

virtual void shutdown ( ShutdownPhases phase )

inlineoverrideprotectedvirtual

Terminates this module. (Nothing to do.)

Parameters

phase The shutdown phase to perform.

Implements Module.

Definition at line 78 of file config.hpp.

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