BioSimSpace.Gateway.File¶
-
class
BioSimSpace.Gateway.File(help=None, optional=False)¶ A file requirement.
Example
Create an optional file requirement.
>>> import BioSimSpace as BSS >>> my_file = BSS.Gateway.File(help="A file requirement.", optional=True)
-
__init__(help=None, optional=False)¶ Constructor.
- Parameters
help (str) – The help string.
optional (bool) – Whether the file is optional.
Methods
__init__([help, optional])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
-
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.
-