Emergency 2017 Dokumentation  v3.0.1
qsf::logic::SequenceSystem Class Reference

Sequence system class. More...

#include <SequenceSystem.h>

Public Member Functions

 SequenceSystem ()
 Default constructor. More...
 
virtual ~SequenceSystem ()
 Destructor. More...
 
SequenceManagergetManager () const
 Return the main sequence manager instance. More...
 
virtual const char * getName () const override
 Get the name of the system. More...
 
virtual bool onStartup (bool serverMode) override
 Startup the sequence system. More...
 
virtual void onShutdown () override
 Shutdown the sequence system. More...
 
- Public Member Functions inherited from qsf::System
virtual ~System ()
 Destructor. More...
 

Additional Inherited Members

- Protected Member Functions inherited from qsf::System
 System ()
 Default constructor. More...
 

Detailed Description

Sequence system class.

Note
  • A sequence system holds a sequence manager
Todo:
  • TODO(co) As far as I can tell at the moment, there's no need for a sequence manager because the sequence system could also do this job

Definition at line 52 of file SequenceSystem.h.

Constructor & Destructor Documentation

qsf::logic::SequenceSystem::SequenceSystem ( )
inline

Default constructor.

Definition at line 22 of file SequenceSystem-inl.h.

qsf::logic::SequenceSystem::~SequenceSystem ( )
inlinevirtual

Destructor.

Definition at line 28 of file SequenceSystem-inl.h.

Member Function Documentation

SequenceManager & qsf::logic::SequenceSystem::getManager ( ) const
inline

Return the main sequence manager instance.

Returns
The main sequence manager instance, do not destroy the instance

Definition at line 34 of file SequenceSystem-inl.h.

const char * qsf::logic::SequenceSystem::getName ( ) const
inlineoverridevirtual

Get the name of the system.

Returns
Null terminated ASCII name of the system, never a null pointer, do not manipulate or destroy the returned name

Implements qsf::System.

Definition at line 45 of file SequenceSystem-inl.h.

virtual void qsf::logic::SequenceSystem::onShutdown ( )
overridevirtual

Shutdown the sequence system.

Note
  • This method is only called in case "onStartup()" returned successfully
Remarks
The implementation does the following tasks:
  • Destroy the main sequence manager instance

Implements qsf::System.

virtual bool qsf::logic::SequenceSystem::onStartup ( bool  serverMode)
overridevirtual

Startup the sequence system.

Returns
"true" if all went fine, else "false"
Remarks
The implementation does the following tasks:
  • Create the main sequence manager instance

Implements qsf::System.


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