i6engine  1.0
i6e::core::SubSystemController Class Reference

This class is used as an abstraction layer. More...

#include <D:/Projekte/i6engine/libs/i6engine-core/include/i6engine/core/subsystem/SubSystemController.h>

Public Member Functions

 SubSystemController ()
 Default constructor. More...
 
bool getGlobalShutDown () const
 This method will get the flag which indicates if the subsystems have to be shut down. More...
 
void ShutDown ()
 This method will set the flag which will indicate that the subsystems have to be shut down. More...
 
void JoinAllSubsystems ()
 Waits for all controlled subsystem-threads to terminate. More...
 
void SubSystemInitialized ()
 This methods tells the SubSystemController that the synchronously started SubSystem has been completed its startup sequence. More...
 
void QueueSubSystemStart (ModuleController *objSubsystem, const uint32_t lngFrameTime)
 This method queues a user defined Subsystem to start. More...
 
void QueueSubSystemStart (ModuleController *objSubsystem, const std::set< Subsystem > &waitingFor)
 This method queues a user defined Subsystem to start. More...
 
size_t GetSubSystemAmount () const
 This method returns the amount of subsystems. More...
 
bool isShutdownComplete ()
 returns true, if all registered subsystems shut down or false, if not More...
 
void registerController (EngineCoreController *ecc)
 registers an EngineCoreController for the SubSystemController More...
 

Friends

class EngineCoreController
 

Detailed Description

This class is used as an abstraction layer.

All subsystem have to register at the SubSystemController. Each registered subsystem will be notified by the SubSystemController of any possible operation.

Definition at line 85 of file SubSystemController.h.

Constructor & Destructor Documentation

i6e::core::SubSystemController::SubSystemController ( )

Default constructor.

Member Function Documentation

bool i6e::core::SubSystemController::getGlobalShutDown ( ) const
inline

This method will get the flag which indicates if the subsystems have to be shut down.

Returns
Boolean Flag indicating if the subsystems have to be shut down.

Definition at line 99 of file SubSystemController.h.

size_t i6e::core::SubSystemController::GetSubSystemAmount ( ) const
inline

This method returns the amount of subsystems.

Returns
Count of subsystems.

Definition at line 136 of file SubSystemController.h.

bool i6e::core::SubSystemController::isShutdownComplete ( )

returns true, if all registered subsystems shut down or false, if not

void i6e::core::SubSystemController::JoinAllSubsystems ( )

Waits for all controlled subsystem-threads to terminate.

void i6e::core::SubSystemController::QueueSubSystemStart ( ModuleController objSubsystem,
const uint32_t  lngFrameTime 
)

This method queues a user defined Subsystem to start.

Parameters
objSubsystemSubsystem to be started.
lngFrameTimeFramerate of the subsystem.
void i6e::core::SubSystemController::QueueSubSystemStart ( ModuleController objSubsystem,
const std::set< Subsystem > &  waitingFor 
)

This method queues a user defined Subsystem to start.

Parameters
objSubsystemSubsystem to be started.
waitingForsubsystems, this subsystem is waiting for
void i6e::core::SubSystemController::registerController ( EngineCoreController ecc)
inline

registers an EngineCoreController for the SubSystemController

Definition at line 146 of file SubSystemController.h.

void i6e::core::SubSystemController::ShutDown ( )

This method will set the flag which will indicate that the subsystems have to be shut down.

void i6e::core::SubSystemController::SubSystemInitialized ( )
inline

This methods tells the SubSystemController that the synchronously started SubSystem has been completed its startup sequence.

Definition at line 114 of file SubSystemController.h.

Friends And Related Function Documentation

friend class EngineCoreController
friend

Definition at line 87 of file SubSystemController.h.


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