BioSimSpace.Gateway.Pressure#
- class BioSimSpace.Gateway.Pressure(help=None, default=None, unit=None, minimum=None, maximum=None, allowed=None)[source]#
A pressure requirement.
Examples
Create a pressure requirement with a default of 1 atmosphere.
>>> import BioSimSpace as BSS >>> my_pressure = BSS.Gateway.Pressure(help="A pressure requirement", default=1, unit="atm")
The same, but explicitly passing a
Pressure
for the default.>>> import BioSimSpace as BSS >>> my_pressure = BSS.Gateway.Pressure(help="A pressure requirement", default=BSS.Units.Pressure.atm)
Create a pressure requirement with a default of 1 atomosphere and a maximum of 10 bar. Note that the unit is taken from the default value.
>>> import BioSimSpace as BSS >>> my_pressure = BSS.Gateway.Pressure(help="A pressure requirement", ... default=BSS.Units.Pressure.atm, ... maximum=10*BSS.Units.Pressure.bar)
- __init__(help=None, default=None, unit=None, minimum=None, maximum=None, allowed=None)[source]#
Constructor.
Methods
__init__
([help, default, unit, minimum, ...])Constructor.
Return the allowed values.
The command-line argument type.
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.
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
- 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.