KSystem Class Reference

#include <KSystem.hh>

Description

Base interface for a Kinoko system.

Definition at line 8 of file KSystem.hh.

Inheritance diagram for KSystem:

Public Member Functions
virtual void	init ()=0
	Initializes the system.
virtual void	calc ()=0
	Executes a frame.
virtual bool	run ()=0
	Executes a run.
virtual void	parseOptions (int argc, char **argv)=0
	Parses non-generic command line options.

Static Protected Attributes
static KSystem *	s_instance = nullptr

Additional Inherited Members
Private Member Functions inherited from EGG::Disposer
Static Private Member Functions inherited from EGG::Disposer
static constexpr u16	getLinkOffset ()

Constructor & Destructor Documentation

~KSystem()

virtual KSystem::~KSystem ( )

inlinevirtual

Definition at line 12 of file KSystem.hh.

Member Function Documentation

calc()

virtual void KSystem::calc ( )

pure virtual

Executes a frame.

Implemented in KReplaySystem, and KTestSystem.

init()

virtual void KSystem::init ( )

pure virtual

Initializes the system.

Implemented in KReplaySystem, and KTestSystem.

parseOptions()

virtual void KSystem::parseOptions ( int argc, char ** argv )

pure virtual

Parses non-generic command line options.

It is recommended to not pass the executable, mode flag, and mode argument.

Parameters

argc	The number of arguments.
argv	The arguments.

Implemented in KReplaySystem, and KTestSystem.

run()

virtual bool KSystem::run ( )

pure virtual

Executes a run.

Returns

Whether the run was successful or not.

Implemented in KReplaySystem, and KTestSystem.

Member Data Documentation

s_instance

KSystem * KSystem::s_instance = nullptr

staticprotected

Definition at line 31 of file KSystem.hh.