malcolm.modules.builtin.parameters¶

malcolm.modules.builtin.parameters.string(name: Anno(name='AName', typ=<class 'str'>, description='Specify that this class will take a parameter name'), description: Anno(name='ADescription', typ=<class 'str'>, description='Description of this parameter'), default: Anno(name='AStringDefault', typ=<class 'str'>, description='Default value for parameter. If not specified, parameter is required') = None) -> Anno(name='AAnno', typ=<class 'annotypes._anno.Anno'>, description='The Anno representing the parameter')[source]¶

Add a string parameter to be passed when instantiating this YAML file

Parameters:	name (str) – Specify that this class will take a parameter name description (str) – Description of this parameter default (str) – Default value for parameter. If not specified, parameter is required
Returns:	The Anno representing the parameter
Return type:	Anno

malcolm.modules.builtin.parameters.float64(name: Anno(name='AName', typ=<class 'str'>, description='Specify that this class will take a parameter name'), description: Anno(name='ADescription', typ=<class 'str'>, description='Description of this parameter'), default: Anno(name='AFloat64Default', typ=<class 'float'>, description='Default value for parameter. If not specified, parameter is required') = None) -> Anno(name='AAnno', typ=<class 'annotypes._anno.Anno'>, description='The Anno representing the parameter')[source]¶

Add a float64 parameter to be passed when instantiating this YAML file

Parameters:	name (str) – Specify that this class will take a parameter name description (str) – Description of this parameter default (float) – Default value for parameter. If not specified, parameter is required
Returns:	The Anno representing the parameter
Return type:	Anno

malcolm.modules.builtin.parameters.int32(name: Anno(name='AName', typ=<class 'str'>, description='Specify that this class will take a parameter name'), description: Anno(name='ADescription', typ=<class 'str'>, description='Description of this parameter'), default: Anno(name='AInt32Default', typ=<class 'int'>, description='Default value for parameter. If not specified, parameter is required') = None) -> Anno(name='AAnno', typ=<class 'annotypes._anno.Anno'>, description='The Anno representing the parameter')[source]¶

Add an int32 parameter to be passed when instantiating this YAML file

Parameters:	name (str) – Specify that this class will take a parameter name description (str) – Description of this parameter default (int) – Default value for parameter. If not specified, parameter is required
Returns:	The Anno representing the parameter
Return type:	Anno