System interface, base class of all systems. More...

#include <ISystem.hpp>

Inheritance diagram for ecstasy::ISystem:

[legend]

Collaboration diagram for ecstasy::ISystem:

[legend]

Public Member Functions
virtual	~ISystem ()=default
	Default destructor.

virtual void	run (Registry &registry)=0
	Run the system.

constexpr Timer &	getTimer () noexcept
	Get the system timer.

constexpr const Timer &	getTimer () const noexcept
	Get the system timer.

Private Attributes
Timer	_timer
	Timer to control the execution of the system.

Detailed Description

System interface, base class of all systems.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

Definition at line 28 of file ISystem.hpp.

Constructor & Destructor Documentation

◆ ~ISystem()

virtual ecstasy::ISystem::~ISystem ( )

virtualdefault

Default destructor.

Member Function Documentation

◆ getTimer() [1/2]

constexpr const Timer & ecstasy::ISystem::getTimer ( ) const

inlineconstexprnoexcept

Get the system timer.

Note: The timer is used to control the execution of the system. You can also use Phase scale timers.

Returns: const Timer& Reference to the system timer.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-11-22)

Definition at line 70 of file ISystem.hpp.

        {
            return _timer;
        }

◆ getTimer() [2/2]

constexpr Timer & ecstasy::ISystem::getTimer ( )

inlineconstexprnoexcept

Get the system timer.

Note: The timer is used to control the execution of the system. You can also use Phase scale timers.

Returns: Timer& Reference to the system timer.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2024-11-22)

Definition at line 54 of file ISystem.hpp.

        {
            return _timer;
        }

◆ run()

virtual void ecstasy::ISystem::run ( Registry & registry )

pure virtual

Run the system.

Parameters

[in] registry Reference to the registry running the system.

Author: Andréas Leroux (andre.nosp@m.as.l.nosp@m.eroux.nosp@m.@epi.nosp@m.tech..nosp@m.eu)

Since: 1.0.0 (2022-10-17)

Implemented in ecstasy::integration::sfml::PollEvents, and ecstasy::integration::user_action::PollActions< std::integer_sequence< Action::Id, Actions... > >.

Member Data Documentation

◆ _timer

Timer ecstasy::ISystem::_timer

private

Timer to control the execution of the system.

Definition at line 77 of file ISystem.hpp.

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

src/ecstasy/system/ISystem.hpp

Public Member Functions

Private Attributes