# BioSimSpace.Types.Area¶

class BioSimSpace.Types.Area(*args)

An area type.

__init__(*args)

Constructor.

*args can be a value and unit, or a string representation of the area, e.g. “30 nm^2”.

Parameters
• value (float) – The value.

• unit (str) – The unit.

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

Examples

Create an object representing an area of 30 square nanometers then print the area in square Angstrom.

>>> import BioSimSpace as BSS
>>> area = BSS.Types.Area(30, "nm^2")
>>> print(area.angstroms2())


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

>>> import BioSimSpace as BSS
>>> area = BSS.Types.Area("30 nm^2")
>>> print(area.angstroms2())


The string matching is extremeley flexible, so all of the following would be valid arguments: “30 nm^2”, “30 square nanometers”, “30 nanometers squared”.

Methods

 __init__(*args) Constructor. Return the power in the ‘angle’ dimension. Return the area in square Angstrom. 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 area in square meters. Return the area in square nanometers. Return the area in square 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

angstroms2()

Return the area in square Angstrom.

Returns

area – The area in square Angstrom.

Return type

Area

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

meters2()

Return the area in square meters.

Returns

area – The area in square meters.

Return type

Area

nanometers2()

Return the area in square nanometers.

Returns

area – The area in square nanometers.

Return type

Area

picometers2()

Return the area in square picometers.

Returns

area – The area in square picometers.

Return type

Area

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