BioSimSpace.Gateway.String

class BioSimSpace.Gateway.String(help=None, default=None, allowed=None)

A string requirement.

Examples

Create a string requirement with a default value.

>>> import BioSimSpace as BSS
>>> my_string = BSS.Gateway.String(help="A string requirement.", default="dog")

Create a string requirement with a list of allowed values and a default of “cat”.

>>> import BioSimSpace as BSS
>>> my_string = BSS.Gateway.String(help="A string requirement.", allowed=["cat", "dog", "fish"], default="cat")

__init__(help=None, default=None, allowed=None)

Constructor.

Parameters:

• help (str) – The help string.

• default (str) – The default value.

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

Methods

__init__([help, default, allowed])	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.

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.