BioSimSpace.Types.Time

class BioSimSpace.Types.Time(*args)

A time type.

__init__(*args)

Constructor.

*args can be a magnitude and unit, or a string representation of the time, e.g. “0.2 fs”.

Parameters:
  • magnitude (float) – The magnitude.
  • unit (str) – The unit.
  • string (str) – A string representation of the time.

Examples

Create an object representing a time of 17.3 femtoseconds then print the time in nanoseconds.

>>> import BioSimSpace as BSS
>>> time = BSS.Types.Time(17.3, "fs")
>>> print(time.nanoseconds())

The same as above, except passing a string representation of the time to the constructor.

>>> import BioSimSpace as BSS
>>> time = BSS.Types.Time("17.3 fs")
>>> print(time.nanoseconds())

The string matching is extremeley flexible, so all of the following would be valid arguments: “17.3 fs”, “17.3 femtoseconds”, “1.73e1 fs”.

Methods

__init__(*args) Constructor.
days() Return the time in days.
femtoseconds() Return the time in femtoseconds.
hours() Return the time in hours.
magnitude() Return the magnitude.
milliseconds() Return the time in milliseconds.
minutes() Return the time in minutes.
nanoseconds() Return the time in nanoseconds.
picoseconds() Return the time in picoseconds.
seconds() Return the time in seconds.
unit() Return the unit.
days()

Return the time in days.

Returns:time – The time in days.
Return type:Time
femtoseconds()

Return the time in femtoseconds.

Returns:time – The time in femtoseconds.
Return type:Time
hours()

Return the time in hours.

Returns:time – The time in hours.
Return type:Time
magnitude()

Return the magnitude.

Returns:magnitude – The magnitude of the type.
Return type:float
milliseconds()

Return the time in milliseconds.

Returns:time – The time in milliseconds.
Return type:Time
minutes()

Return the time in minutes.

Returns:time – The time in minutes.
Return type:Time
nanoseconds()

Return the time in nanoseconds.

Returns:time – The time in nanoseconds.
Return type:Time
picoseconds()

Return the time in picoseconds.

Returns:time – The time in picoseconds.
Return type:Time
seconds()

Return the time in seconds.

Returns:time – The time in seconds.
Return type:Time
unit()

Return the unit.

Returns:unit – The unit of the type.
Return type:str