BioSimSpace.Gateway.Volume

class BioSimSpace.Gateway.Volume(help=None, default=None, unit=None, minimum=None, maximum=None, allowed=None)

A volume requirement.

Examples

Create an area requirement with a default of 10 cubed Angstrom.

>>> import BioSimSpace as BSS
>>> my_volume = BSS.Gateway.Volume(help="A volume requirement", default=10, unit="angstrom3")

The same, but explicitly passing a Volume for the default.

>>> import BioSimSpace as BSS
>>> my_volume = BSS.Gateway.Volume(help="A volume requirement", default=10*BSS.Units.Volume.angstrom3)

Create a volume requirement with a default of 10 cubed Angstrom and a maximum of 50 square nanometers. Note that the unit is taken from the default value.

>>> import BioSimSpace as BSS
>>> my_volume = BSS.Gateway.Volume(help="A volume requirement",
...                                default=10*BSS.Units.Volume.angstrom3,
...                                maximum=50*BSS.Units.Volume.nanometer3)
__init__(help=None, default=None, unit=None, minimum=None, maximum=None, allowed=None)

Constructor.

Parameters
  • help (str) – The help string.

  • default (Volume) – The default value.

  • unit (str) – The unit.

  • minimum (Volume) – The minimum allowed value.

  • maximum (Volume) – The maximum allowed value.

  • allowed ([Volume]) – A list of allowed values.

Methods

__init__([help, default, unit, minimum, …])

Constructor.

getAllowedValues()

Return the allowed values.

getArgType()

The command-line argument type.

getDefault()

Return the default value.

getHelp()

Return the documentation string.

getMax()

Return the maximum allowed value.

getMin()

Return the minimum allowed value.

getUnit()

Return the unit.

getValue()

Return the value.

isMulti()

Whether the requirement has multiple values.

isOptional()

Whether the requirement is optional.

setValue(value[, name])

Validate and set the value.

getAllowedValues()

Return the allowed values.

Returns

allowed – The list of allowed values that the requirement can take.

Return type

list

getArgType()

The command-line argument type.

Returns

arg_type – The command-line argument type.

Return type

bool, int, float, str

getDefault()

Return the default value.

getHelp()

Return the documentation string.

Returns

help – The help string.

Return type

str

getMax()

Return the maximum allowed value.

getMin()

Return the minimum allowed value.

getUnit()

Return the unit.

Returns

unit – The unit associated with the requirement.

Return type

str

getValue()

Return the value.

Returns

value – The value of the requirement.

Return type

Volume

isMulti()

Whether the requirement has multiple values.

Returns

is_multi – Whether the requirement has multiple values.

Return type

bool

isOptional()

Whether the requirement is optional.

Returns

is_optional – Whether the requirement is optional.

Return type

bool

setValue(value, name=None)

Validate and set the value.

Parameters
  • value – The value of the input requirement.

  • name (str) – The name of the requirement.