bloc.boulder_plugins.calc_note_export_action

Bloc GUI plugin: export Excel Calculation Note from the web interface.

Attributes

logger
GuiActionContext

Classes

CalcNoteExportAction

Export Calculation Note using cached bundle or full re-solve.

Functions

register_calc_note_export_action()

Register the Calculation Note export button with Boulder's GUI action registry.

Module Contents

bloc.boulder_plugins.calc_note_export_action.logger

bloc.boulder_plugins.calc_note_export_action.GuiActionContext = None

class bloc.boulder_plugins.calc_note_export_action.CalcNoteExportAction

Bases: boulder.gui_actions.GuiActionPlugin

Export Calculation Note using cached bundle or full re-solve.

When a valid cache entry exists (context.has_cached_result), the action loads the pre-computed scenario bundle from disk and calls generate_calculation_note_stone_from_bundles() to produce the Excel without re-solving. On a cache miss it falls back to generate_calculation_note_stone() (full solve), and the new cache entry is populated at solve time by the CalcNoteCacheContributor.

property action_id: str

Unique identifier for this action.

property label: str

Button label shown in the Simulate panel.

property requires_simulation: bool

When True, the action is disabled until a simulation completes.

is_listed(context)

Return True when this action should appear in the Simulate panel.

is_available(context)

Return True when run() is allowed for context.

run(context)

Execute the action and return a downloadable file.

property description: str | None

Optional tooltip text shown next to the action’s button.

bloc.boulder_plugins.calc_note_export_action.register_calc_note_export_action()

Register the Calculation Note export button with Boulder’s GUI action registry.