.. index:: pair: class; EE::System::Time
.. _doxid-class_e_e_1_1_system_1_1_time:

class EE::System::Time
======================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Represents a time value

:ref:`EE::System::Time <doxid-class_e_e_1_1_system_1_1_time>` encapsulates a time value in a flexible way. :ref:`More...<details-class_e_e_1_1_system_1_1_time>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <time.hpp>
	
	class Time {
	public:
		// fields
	
		static const Time :ref:`Zero<doxid-class_e_e_1_1_system_1_1_time_1a495c78cf2e56b7aefe460d82ebfdee2a>`;

		// methods
	
		static bool :target:`isValid<doxid-class_e_e_1_1_system_1_1_time_1a1d0590e1733c4006bdc2c5be9f82af24>`(const std::string& str);
		static Time :target:`fromString<doxid-class_e_e_1_1_system_1_1_time_1ace87faf1cb74e3857366d73270520b92>`(const std::string& str);
		constexpr double :ref:`asSeconds<doxid-class_e_e_1_1_system_1_1_time_1ad3723528c931d29a2838c5460cac42db>`() const;
		constexpr double :ref:`asMilliseconds<doxid-class_e_e_1_1_system_1_1_time_1abce2e9d349a4bdb5ef943d317b498cca>`() const;
		constexpr :ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` :ref:`asMicroseconds<doxid-class_e_e_1_1_system_1_1_time_1afec3910a5d2b0f490f1be265a96f9055>`() const;
		std::string :ref:`toString<doxid-class_e_e_1_1_system_1_1_time_1ab1ff79746c2b4ec043f452f047c077a9>`() const;
	};
.. _details-class_e_e_1_1_system_1_1_time:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Represents a time value

:ref:`EE::System::Time <doxid-class_e_e_1_1_system_1_1_time>` encapsulates a time value in a flexible way. It allows to define a time value either as a number of seconds, milliseconds or microseconds. It also works the other way round: you can read a time value as either a number of seconds, milliseconds or microseconds.

By using such a flexible interface, the API doesn't impose any fixed type or resolution for time values, and let the user choose its own favorite representation.

:ref:`Time <doxid-class_e_e_1_1_system_1_1_time>` values support the usual mathematical operations: you can add or subtract two times, multiply or divide a time by a number, compare two times, etc.

Since they represent a time span and not an absolute time value, times can also be negative.

Usage example:

.. ref-code-block:: cpp

	Time t1 = Seconds(0.1f);
	double milli = t1.asMilliseconds(); // 100
	
	Time t2 = Milliseconds(30);
	Int64 micro = t2.asMicroseconds(); // 30000
	
	Time t3 = Microseconds(-800000);
	double sec = t3.asSeconds(); // -0.8

.. ref-code-block:: cpp

	void update(Time elapsed) {
	   position += speed * elapsed;
	}
	
	update(Milliseconds(100));



.. rubric:: See also:

:ref:`EE::System::Clock <doxid-class_e_e_1_1_system_1_1_clock>`

Fields
------

.. index:: pair: variable; Zero
.. _doxid-class_e_e_1_1_system_1_1_time_1a495c78cf2e56b7aefe460d82ebfdee2a:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static const Time Zero

Predefined "zero" time value.

Methods
-------

.. index:: pair: function; asSeconds
.. _doxid-class_e_e_1_1_system_1_1_time_1ad3723528c931d29a2838c5460cac42db:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	constexpr double asSeconds() const

Return the time value as a number of seconds.



.. rubric:: Returns:

:ref:`Time <doxid-class_e_e_1_1_system_1_1_time>` in seconds



.. rubric:: See also:

AsMilliseconds, AsMicroseconds

.. index:: pair: function; asMilliseconds
.. _doxid-class_e_e_1_1_system_1_1_time_1abce2e9d349a4bdb5ef943d317b498cca:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	constexpr double asMilliseconds() const

Return the time value as a number of milliseconds.



.. rubric:: Returns:

:ref:`Time <doxid-class_e_e_1_1_system_1_1_time>` in milliseconds



.. rubric:: See also:

AsSeconds, AsMicroseconds

.. index:: pair: function; asMicroseconds
.. _doxid-class_e_e_1_1_system_1_1_time_1afec3910a5d2b0f490f1be265a96f9055:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	constexpr :ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` asMicroseconds() const

Return the time value as a number of microseconds.



.. rubric:: Returns:

:ref:`Time <doxid-class_e_e_1_1_system_1_1_time>` in microseconds



.. rubric:: See also:

:ref:`asSeconds <doxid-class_e_e_1_1_system_1_1_time_1ad3723528c931d29a2838c5460cac42db>`, :ref:`asMilliseconds <doxid-class_e_e_1_1_system_1_1_time_1abce2e9d349a4bdb5ef943d317b498cca>`

.. index:: pair: function; toString
.. _doxid-class_e_e_1_1_system_1_1_time_1ab1ff79746c2b4ec043f452f047c077a9:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	std::string toString() const

Converts the time into a human readable string.