# BioSimSpace.Types.Angle¶

class BioSimSpace.Types.Angle(*args)

An angle type.

__init__(*args)

Constructor.

*args can be a value and unit, or a string representation of the angle, e.g. “3 radians”.

Parameters
• value (float) – The value.

• unit (str) – The unit.

• string (str) – A string representation of the angle.

Examples

Create an object representing an angle of 3.14 radians then print the length in degrees.

>>> import BioSimSpace as BSS
>>> length = BSS.Types.Angle(3.14, "R")
>>> print(length.degrees())


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

>>> import BioSimSpace as BSS
>>> length = BSS.Types.Angle("3.14 R")
>>> print(length.degrees())


The string matching is extremeley flexible, so all of the following would be valid arguments: “3.14 R”, “3.14 radians”, “314e-2 Radians”.

Methods

 __init__(*args) Constructor. Return the power in the ‘angle’ dimension. Return the power in the ‘charge’ dimension. Return the angle in degrees. Return the dimensions of this type. Return the power in the ‘length’ dimension. Return the power in the ‘mass’ dimension. Return the power in the ‘quantity’ dimension. Return the angle in radians. Return the power in the ‘temperature’ dimension. Return the power in the ‘time’ dimension. Return the unit. Return the value.
classmethod angle()

Return the power in the ‘angle’ dimension.

Returns

angle – The power in the ‘angle’ dimension.

Return type

int

classmethod charge()

Return the power in the ‘charge’ dimension.

Returns

charge – The power in the ‘charge’ dimension.

Return type

int

degrees()

Return the angle in degrees.

Returns

angle – The angle in degrees.

Return type

Angle

classmethod dimensions()

Return the dimensions of this type. This is a tuple containing the power in each dimension.

Returns(int, int, int, int, int, int)

The power in each dimension: ‘angle’, ‘charge’, ‘length’, ‘mass’, ‘quantity’, ‘temperature’, and ‘time’.

classmethod length()

Return the power in the ‘length’ dimension.

Returns

length – The power in the ‘length’ dimension.

Return type

int

classmethod mass()

Return the power in the ‘mass’ dimension.

Returns

mass – The power in the ‘mass’ dimension.

Return type

int

classmethod quantity()

Return the power in the ‘quantity’ dimension.

Returns

quantity – The power in the ‘quantity’ dimension.

Return type

int

radians()

Returns

angle – The angle in radians.

Return type

Angle

classmethod temperature()

Return the power in the ‘temperature’ dimension.

Returns

temperature – The power in the ‘temperature’ dimension.

Return type

int

classmethod time()

Return the power in the ‘time’ dimension.

Returns

time – The power the ‘time’ dimension.

Return type

int

unit()

Return the unit.

Returns

unit – The unit of the type.

Return type

str

value()

Return the value.

Returns

value – The value of the type.

Return type

float