ALib C++ Framework
by
Library Version: 2511 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
alib::cli::CliCamp Class Reference

Description:

The module class for module ALib CLI.

This is a strict singleton class. The only instance is found with the namespace variable CLI.

Definition at line 18 of file clicamp.inl.

Inheritance diagram for alib::cli::CliCamp:
alib::camp::Camp alib::resources::ResourceHolder

Public Method Index:

 CliCamp ()
Public Method Index: inherited from alib::camp::Camp
void BootstrapSetConfig (const SharedConfiguration &pConfig)
void BootstrapSetPhase (BootstrapPhases phase)
void BootstrapSetResourcePool (const SPResourcePool &pResourcePool)
BootstrapPhases GetBootstrapState ()
SharedConfigurationGetConfig ()
bool IsBootstrapped ()
Public Method Index: inherited from alib::resources::ResourceHolder
 ResourceHolder (const NCString &resourceCategory=nullptr)
 ResourceHolder (SPResourcePool &pool, const NCString &resourceCategory)
void BootstrapResource (const NString &name, const String &data)
const StringGetResource (const NString &name)
ResourcePoolGetResourcePool ()
SPResourcePoolGetResourcePoolSP ()
bool HasPool ()
void Set (SPResourcePool &pool, const NCString &resourceCategory=nullptr)
const StringTryResource (const NString &name)

Protected Method Index:

virtual void Bootstrap () override
 Initializes this camp.
virtual void Shutdown (ShutdownPhases phase) override
Protected Method Index: inherited from alib::camp::Camp
 Camp (Camp &&)=delete
 Deleted move constructor.
 Camp (const Camp &)=delete
 Deleted copy constructor.
 Camp (const NCString &resourceCategory)
virtual ~Camp ()
 Virtual destructor to satisfy C++ abstract type rules.
void operator= (Camp &&)=delete
 Deleted move assignment.
void operator= (const Camp &)=delete
 Deleted copy assignment.

Additional Inherited Members

Public Type Index: inherited from alib::resources::ResourceHolder
using SPResourcePool = SharedPtr<resources::ResourcePool, MonoAllocator>
Public Field Index: inherited from alib::resources::ResourceHolder
NCString ResourceCategory
Protected Field Index: inherited from alib::camp::Camp
int bootstrapState = 0
SharedConfiguration config
Protected Field Index: inherited from alib::resources::ResourceHolder
SPResourcePool resourcePool
 Shared pointer to the resource pool.

Constructor(s) / Destructor Details:

◆ CliCamp()

alib::cli::CliCamp::CliCamp ( )

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

Definition at line 53 of file clicamp.cpp.

Method Details:

◆ Bootstrap()

void alib::cli::CliCamp::Bootstrap ( )
overrideprotectedvirtual

Initializes this camp.

Implements alib::camp::Camp.

Definition at line 62 of file clicamp.cpp.

◆ Shutdown()

virtual void alib::cli::CliCamp::Shutdown ( ShutdownPhases phase)
inlineoverrideprotectedvirtual

Terminates this camp. (Nothing to do.)

Parameters
phaseThe shutdown phase to perform.

Implements alib::camp::Camp.

Definition at line 32 of file clicamp.inl.


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