malcolm.modules.ADCore.parts

class malcolm.modules.ADCore.parts.DetectorDriverPart(name: Anno(name='APartName', typ=<class 'str'>, description='The name of the Part within the Controller'), mri: Anno(name='AMri', typ=<class 'str'>, description='Malcolm resource id of child object'), soft_trigger_modes: Union[Anno(name='ASoftTriggerModes', typ=<class 'str'>, description='List of trigger modes that do not use hardware triggers'), Sequence[str]] = None, main_dataset_useful: Anno(name='AMainDatasetUseful', typ=<class 'bool'>, description='Is main detector dataset useful to publish in DatasetTable?') = True, runs_on_windows: Anno(name='APartRunsOnWindows', typ=<class 'bool'>, description='Is the IOC this part connects to running on Windows?') = False, required_version: Anno(name='AVersionRequirement', typ=<class 'str'>, description='Minimum required version for compatibility') = None)

Parameters:

• name (str) – The name of the Part within the Controller
• mri (str) – Malcolm resource id of child object
• soft_trigger_modes (str) – List of trigger modes that do not use hardware triggers
• main_dataset_useful (bool) – Is main detector dataset useful to publish in DatasetTable?
• runs_on_windows (bool) – Is the IOC this part connects to running on Windows?
• required_version (str) – Minimum required version for compatibility

setup(registrar: malcolm.core.part.PartRegistrar) → None

Use the given PartRegistrar to populate the hooks and fields. This function is called for all parts in a block when the block’s Controller is added to a Process

on_reset(context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks')) → None

Parameters:context (Context) – Context that should be used to perform operations on child blocks

on_report_status() → Union[Anno(name='AInfos', typ=<class 'malcolm.core.info.Info'>, description='Infos about current Part status to be passed to other parts'), Sequence[malcolm.core.info.Info], malcolm.core.info.Info, None]

Returns:Infos about current Part status to be passed to other parts Return type:Info

on_configure(context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), completed_steps: Anno(name='ACompletedSteps', typ=<class 'int'>, description='Number of steps already completed'), steps_to_do: Anno(name='AStepsToDo', typ=<class 'int'>, description='Number of steps we should configure for'), part_info: Anno(name='APartInfo', typ=(<class 'str'>, annotypes._array.Array[malcolm.core.info.Info]), description='The Infos returned from other Parts'), generator: Anno(name='AGenerator', typ=<MagicMock name='mock.CompoundGenerator' id='139916666047248'>, description='Generator instance providing specification for scan'), fileDir: Anno(name='AFileDir', typ=<class 'str'>, description='Directory to write data to'), **kwargs) → None

Parameters:

• context (Context) – Context that should be used to perform operations on child blocks
• completed_steps (int) – Number of steps already completed
• steps_to_do (int) – Number of steps we should configure for
• part_info – The Infos returned from other Parts
• generator – Generator instance providing specification for scan
• fileDir (str) – Directory to write data to

on_run(context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks')) → None

Parameters:context (Context) – Context that should be used to perform operations on child blocks

on_post_run_armed(steps_to_do: Anno(name='AStepsToDo', typ=<class 'int'>, description='Number of steps we should configure for')) → None

Parameters:steps_to_do (int) – Number of steps we should configure for

on_abort(context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks')) → None

Parameters:context (Context) – Context that should be used to perform operations on child blocks

class malcolm.modules.ADCore.parts.FilepathTranslatorPart(name: Anno(name='APartName', typ=<class 'str'>, description='The name of the Part within the Controller'), initial_windows_drive_letter: Anno(name='ADriveLetter', typ=<class 'str'>, description='Letter assigned to the windows drive mount'), initial_path_prefix: Anno(name='APathPrefix', typ=<class 'str'>, description='The first bit of the file path (i.e. /dls for /dls/i18/...)') = '/dls', initial_network_prefix: Anno(name='ANetworkPrefix', typ=<class 'str'>, description='The path prefix if it is a network mount (e.g. //dc)') = '')

Parameters:

• name (str) – The name of the Part within the Controller
• initial_windows_drive_letter (str) – Letter assigned to the windows drive mount
• initial_path_prefix (str) – The first bit of the file path (i.e. /dls for /dls/i18/…)
• initial_network_prefix (str) – The path prefix if it is a network mount (e.g. //dc)

setup(registrar: malcolm.core.part.PartRegistrar) → None

Use the given PartRegistrar to populate the hooks and fields. This function is called for all parts in a block when the block’s Controller is added to a Process

on_report_status() → Union[Anno(name='AInfos', typ=<class 'malcolm.core.info.Info'>, description='Infos about current Part status to be passed to other parts'), Sequence[malcolm.core.info.Info], malcolm.core.info.Info, None]

Returns:Infos about current Part status to be passed to other parts Return type:Info

class malcolm.modules.ADCore.parts.HDFWriterPart(name: Anno(name='APartName', typ=<class 'str'>, description='The name of the Part within the Controller'), mri: Anno(name='AMri', typ=<class 'str'>, description='Malcolm resource id of child object'), runs_on_windows: Anno(name='APartRunsOnWindows', typ=<class 'bool'>, description='Is the IOC this part connects to running on Windows?') = False, write_all_nd_attributes: Anno(name='AWriteAllNDAttributes', typ=<class 'bool'>, description='Toggle writing of all ND attributes to HDF file') = True)

Part for controlling an hdf_writer_block in a Device

Parameters:

• name (str) – The name of the Part within the Controller
• mri (str) – Malcolm resource id of child object
• runs_on_windows (bool) – Is the IOC this part connects to running on Windows?
• write_all_nd_attributes (bool) – Toggle writing of all ND attributes to HDF file

on_reset(context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks')) → None

Parameters:context (Context) – Context that should be used to perform operations on child blocks

setup(registrar: malcolm.core.part.PartRegistrar) → None

Use the given PartRegistrar to populate the hooks and fields. This function is called for all parts in a block when the block’s Controller is added to a Process

on_configure(context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), completed_steps: Anno(name='ACompletedSteps', typ=<class 'int'>, description='Number of steps already completed'), steps_to_do: Anno(name='AStepsToDo', typ=<class 'int'>, description='Number of steps we should configure for'), part_info: Anno(name='APartInfo', typ=(<class 'str'>, annotypes._array.Array[malcolm.core.info.Info]), description='The Infos returned from other Parts'), generator: Anno(name='AGenerator', typ=<MagicMock name='mock.CompoundGenerator' id='139916666047248'>, description='Generator instance providing specification for scan'), fileDir: Anno(name='AFileDir', typ=<class 'str'>, description='Directory to write data to'), formatName: Anno(name='AFormatName', typ=<class 'str'>, description='Argument for fileTemplate, normally filename without extension') = 'det', fileTemplate: Anno(name='AFileTemplate', typ=<class 'str'>, description='Printf style template to generate filename relative to fileDir.\nArguments are:\n 1) %s: the value of formatName') = '%s.h5') → Union[Anno(name='AInfos', typ=<class 'malcolm.core.info.Info'>, description='Infos about current Part status to be passed to other parts'), Sequence[malcolm.core.info.Info], malcolm.core.info.Info, None]

Parameters:

• context (Context) – Context that should be used to perform operations on child blocks
• completed_steps (int) – Number of steps already completed
• steps_to_do (int) – Number of steps we should configure for
• part_info – The Infos returned from other Parts
• generator – Generator instance providing specification for scan
• fileDir (str) – Directory to write data to
• formatName (str) – Argument for fileTemplate, normally filename without extension
• fileTemplate (str) – Printf style template to generate filename relative to fileDir. Arguments are: 1) %s: the value of formatName

Returns:

Infos about current Part status to be passed to other parts

Return type:

Info

on_seek(completed_steps: Anno(name='ACompletedSteps', typ=<class 'int'>, description='Number of steps already completed'), steps_to_do: Anno(name='AStepsToDo', typ=<class 'int'>, description='Number of steps we should configure for')) → None

Parameters:

• completed_steps (int) – Number of steps already completed
• steps_to_do (int) – Number of steps we should configure for

on_run(context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks')) → None

Parameters:context (Context) – Context that should be used to perform operations on child blocks

on_post_run_ready(context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks')) → None

Parameters:context (Context) – Context that should be used to perform operations on child blocks

on_abort(context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks')) → None

Parameters:context (Context) – Context that should be used to perform operations on child blocks

class malcolm.modules.ADCore.parts.PositionLabellerPart(name: Anno(name='APartName', typ=<class 'str'>, description='The name of the Part within the Controller'), mri: Anno(name='AMri', typ=<class 'str'>, description='Malcolm resource id of child object'), initial_visibility: Optional[Anno(name='AInitialVisibility', typ=<class 'bool'>, description='Whether the part is initially visible with no config loaded, None means only if child Source/Sink Ports connect to another Block')] = None, stateful: Anno(name='AStateful', typ=<class 'bool'>, description='If the child is a StatefulController then this should be True') = True)

Part for controlling a position_labeller_block in a scan

Parameters:

• name (str) – The name of the Part within the Controller
• mri (str) – Malcolm resource id of child object
• initial_visibility (bool) – Whether the part is initially visible with no config loaded, None means only if child Source/Sink Ports connect to another Block
• stateful (bool) – If the child is a StatefulController then this should be True

setup(registrar: malcolm.core.part.PartRegistrar) → None

Use the given PartRegistrar to populate the hooks and fields. This function is called for all parts in a block when the block’s Controller is added to a Process

on_reset(context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks')) → None

Parameters:context (Context) – Context that should be used to perform operations on child blocks

on_configure(context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), completed_steps: Anno(name='ACompletedSteps', typ=<class 'int'>, description='Number of steps already completed'), generator: Anno(name='AGenerator', typ=<MagicMock name='mock.CompoundGenerator' id='139916666047248'>, description='Generator instance providing specification for scan')) → None

Parameters:

• context (Context) – Context that should be used to perform operations on child blocks
• completed_steps (int) – Number of steps already completed
• generator – Generator instance providing specification for scan

on_run(context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks')) → None

Parameters:context (Context) – Context that should be used to perform operations on child blocks

on_abort(context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks')) → None

Parameters:context (Context) – Context that should be used to perform operations on child blocks

class malcolm.modules.ADCore.parts.StatsPluginPart(name: Anno(name='APartName', typ=<class 'str'>, description='The name of the Part within the Controller'), mri: Anno(name='AMri', typ=<class 'str'>, description='Malcolm resource id of child object'), statistic: Anno(name='AStatsName', typ=<enum 'StatisticsName'>, description='Which statistic to capture') = <StatisticsName.SUM: 'TOTAL'>, runs_on_windows: Anno(name='APartRunsOnWindows', typ=<class 'bool'>, description='Is the IOC this part connects to running on Windows?') = False)

Part for controlling a stats_plugin_block in a Device

Parameters:

• name (str) – The name of the Part within the Controller
• mri (str) – Malcolm resource id of child object
• statistic (StatisticsName) – Which statistic to capture
• runs_on_windows (bool) – Is the IOC this part connects to running on Windows?

setup(registrar: malcolm.core.part.PartRegistrar) → None

Use the given PartRegistrar to populate the hooks and fields. This function is called for all parts in a block when the block’s Controller is added to a Process

on_report_status() → Union[Anno(name='AInfos', typ=<class 'malcolm.core.info.Info'>, description='Infos about current Part status to be passed to other parts'), Sequence[malcolm.core.info.Info], malcolm.core.info.Info, None]

Returns:Infos about current Part status to be passed to other parts Return type:Info

on_configure(context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks'), part_info: Anno(name='APartInfo', typ=(<class 'str'>, annotypes._array.Array[malcolm.core.info.Info]), description='The Infos returned from other Parts'), fileDir: Anno(name='AFileDir', typ=<class 'str'>, description='Directory to write data to')) → None

Parameters:

• context (Context) – Context that should be used to perform operations on child blocks
• part_info – The Infos returned from other Parts
• fileDir (str) – Directory to write data to

on_reset(context: Anno(name='AContext', typ=<class 'malcolm.core.context.Context'>, description='Context that should be used to perform operations on child blocks')) → None

Parameters:context (Context) – Context that should be used to perform operations on child blocks