# BioSimSpace.Types.Length¶

class BioSimSpace.Types.Length(*args)

A length type.

__init__(*args)

Constructor.

*args can be a value and unit, or a string representation of the length, e.g. “12 Angstrom”.

Parameters
• value (float) – The value.

• unit (str) – The unit.

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

Examples

Create an object representing a length of 148.6 Angstrom then print the length in nanometers.

>>> import BioSimSpace as BSS
>>> length = BSS.Types.Length(148.6, "A")
>>> print(length.nanometers())


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

>>> import BioSimSpace as BSS
>>> length = BSS.Types.Length("148.6 A")
>>> print(length.nanometers())


The string matching is extremeley flexible, so all of the following would be valid arguments: “148.6 A”, “148.6 angstrom”, “1.48e2 Angstrom”.

Methods

 __init__(*args) Constructor. Return the power in the ‘angle’ dimension. Return the length in angstroms. Return the length in centimeters. Return the power in the ‘charge’ dimension. Return the dimensions of this type. Return the power in the ‘length’ dimension. Return the power in the ‘mass’ dimension. Return the length in meters. Return the length in millimeters. Return the length in nanometers. Return the length in picometers. Return the power in the ‘quantity’ dimension. 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

angstroms()

Return the length in angstroms.

Returns

length – The length in angstrom.

Return type

Length

centimeters()

Return the length in centimeters.

Returns

length – The length in centimeters.

Return type

Length

classmethod charge()

Return the power in the ‘charge’ dimension.

Returns

charge – The power in the ‘charge’ dimension.

Return type

int

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

meters()

Return the length in meters.

Returns

length – The length in meters.

Return type

Length

millimeters()

Return the length in millimeters.

Returns

length – The length in millimeters.

Return type

Length

nanometers()

Return the length in nanometers.

Returns

length – The length in nanometers.

Return type

Length

picometers()

Return the length in picometers.

Returns

length – The length in picometers.

Return type

Length

classmethod quantity()

Return the power in the ‘quantity’ dimension.

Returns

quantity – The power in the ‘quantity’ dimension.

Return type

int

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