CYB::Engine::Core Class Reference

An instance of this object is the entirety of the engine. More...

#include <CYBCore.hpp>

Inheritance diagram for CYB::Engine::Core:

Collaboration diagram for CYB::Engine::Core:

Public Member Functions
Context &	CurrentContext (void) noexcept
	Get the current Context. More...
void	SetCurrentContext (Context &ANewContext) noexcept
	Set the current Context. More...
void	DefaultContext (void) noexcept
	Set the current Context to FEngineContext. More...
unsigned long long	ThreadID (void) noexcept
	Possibly assign and return the current thread's serial ID for this execution. More...

Static Public Member Functions
static Core &	GetCore (void) noexcept
	Retrieve the Core singleton. More...
static void	Run (const unsigned int ANumArguments, const oschar_t *const *const AArguments) noexcept
	Runs the engine and self terminates. More...

Public Attributes
API::EngineInformation	FEngineInformation
	Information describing the engine.
Platform::Modules::Manager	FModuleManager
	Loads and contains required modules.
CYB::Engine::Helpers::CommandLine	FCommandLine
	The parsed command line handler.

Private Member Functions
	Core (const unsigned int ANumArguments, const oschar_t *const *const AArguments)
	Constructs the engine components. More...
	~Core ()
	Cleans up the engine and terminates the process.
bool	LaunchUnit (void) noexcept
	Run the main unit. More...

Private Attributes
Platform::System::Console	FConsole
	The console.
std::atomic_uint_fast64_t	FThreadCounter
	The number of threads created.
Logger	FLogger
	The engine's primary Logger.
Memory::Heap	FHeap
	The engine's primary Heap.
Context	FEngineContext
	The engine Context.

Static Private Attributes
static thread_local Context *	FCurrentContext
	The current Context in use.
static thread_local unsigned long long	FThreadID
	ID of the checking thread.

Additional Inherited Members
Protected Member Functions inherited from CYB::API::Singleton< Core >
	Singleton (const bool AInit) noexcept
	Optionally initialize the singleton with the current object. More...
	~Singleton ()
	Destroy a singleton and nullify it's pointer.
Static Protected Attributes inherited from CYB::API::Singleton< Core >
static Core *	FSingleton
	The singleton object.

Detailed Description

An instance of this object is the entirety of the engine.

Definition at line 11 of file CYBCore.hpp.

Constructor & Destructor Documentation

CYB::Engine::Core::Core ( const unsigned int  ANumArguments, const oschar_t *const *const  AArguments  )

private

Constructs the engine components.

Parameters

ANumArguments	The number of command line arguments
AArguments	The command line arguments

Thread Safety

This function should only be called once

Exceptions

CYB::Exception::Internal	Error code: CYB::Exception::Internal::MEMORY_RESERVATION_FAILURE. Thrown if a heap's memory could not be reserved
CYB::Exception::Internal	Error code: CYB::Exception::Internal::MEMORY_COMMITAL_FAILURE. Thrown if a heap's memory could not be committed

Definition at line 27 of file CYBCore.cpp.

                                                                                             :
    Singleton<Core>(true),
    FEngineInformation(Parameters::CreateEngineInformation()),
    FThreadCounter(0),
    FLogger(FConsole),
    FHeap(Parameters::ENGINE_HEAP_INITIAL_COMMIT_SIZE),
    FEngineContext(FHeap, FLogger, true),
    FCommandLine(ANumArguments, AArguments)
{
    FLogger.Log(API::String::Static(u8"Core created"), Logger::Level::DEV);
    static_cast<void>(ANumArguments);
    static_cast<void>(AArguments);
}

Here is the call graph for this function:

Member Function Documentation

CYB::Engine::Context & CYB::Engine::Core::CurrentContext ( void  )

noexcept

Get the current Context.

Returns

A reference to the current context

Thread Safety

This function requires no thread safety

Definition at line 57 of file CYBCore.cpp.

                                                             {
    return *FCurrentContext;
}

Here is the caller graph for this function:

void CYB::Engine::Core::DefaultContext ( void  )

noexcept

Set the current Context to FEngineContext.

Thread Safety

This function requires no thread safety

Definition at line 65 of file CYBCore.cpp.

                                                {
    FEngineContext.MakeCurrent();
}

Here is the caller graph for this function:

CYB::Engine::Core & CYB::Engine::Core::GetCore ( void  )

staticnoexcept

Retrieve the Core singleton.

Returns

A reference to the Core singleton

Thread Safety

This function requires no thread safety

Definition at line 45 of file CYBCore.cpp.

                                                   {
    return *FSingleton;
}

Here is the caller graph for this function:

bool CYB::Engine::Core::LaunchUnit ( void  )

privatenoexcept

Run the main unit.

Returns

true if the Unit should be launch again, false otherwise

Thread Safety

This function must be synchronized at the object level

void CYB::Engine::Core::Run ( const unsigned int  ANumArguments, const oschar_t *const *const  AArguments  )

staticnoexcept

Runs the engine and self terminates.

Parameters

ANumArguments	The number of command line arguments
AArguments	The command line arguments

Thread Safety

This function should only be called once

Definition at line 49 of file CYBCore.cpp.

                                                                                                          {
    try {
        Core CyberEngineMarkIII(ANumArguments, AArguments);
    }
    catch (...) {}
    Platform::System::Process::GetSelf().Terminate();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void CYB::Engine::Core::SetCurrentContext ( Context &  ANewContext )

noexcept

Set the current Context.

Parameters

ANewContext

The new context

Thread Safety

This function requires no thread safety

Definition at line 61 of file CYBCore.cpp.

                                                                   {
    FCurrentContext = &ANewContext;
}

Here is the caller graph for this function:

unsigned long long CYB::Engine::Core::ThreadID ( void  )

noexcept

Possibly assign and return the current thread's serial ID for this execution.

Returns

The current thread's serial ID for this execution

Thread Safety

This function requires no thread safety

Definition at line 73 of file CYBCore.cpp.

                                                        {
    if (FThreadID == 0)
        FThreadID = FThreadCounter.fetch_add(1, std::memory_order_relaxed) + 1;
    return FThreadID;
}

---

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

• Engine/Engine/Core/CYBCore.hpp
• Engine/Engine/Core/CYBCore.cpp

---

Generated by   1.8.6