Emergency 20 Dokumentation  4.1.0
Public Member Functions | List of all members
qsf::logic::SequenceSystem Class Reference

Sequence system class. More...

#include <SequenceSystem.h>

Inheritance diagram for qsf::logic::SequenceSystem:
Inheritance graph
[legend]
Collaboration diagram for qsf::logic::SequenceSystem:
Collaboration graph
[legend]

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

Constructor & Destructor Documentation

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

Default constructor.

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

Destructor.

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
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.

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: