vibesketcher.server.porosity¶
REST routes for probe-defined porosity plans and the reference estimate (#206).
plan validates a plan and returns the planning record with its refusals;
estimate runs the bounded reference geometric estimate; psd-csv,
psd-figure and handoff write the source-linked CSV, the PSD figure and
the Viewer handoff record. These read; none changes a document.
store runs the estimate and attaches it to its structure as one edit
checked against the document revision; undo removes the last stored
estimate while the structure is unchanged. stored/{structure} lists the
stored estimates marked stale or current, and table/{structure} writes the
publication table (CSV, SVG or TeX) of a current stored estimate.
Refusals are 422 with errors and stable codes; a revision conflict or a
stale estimate is 409, a structure without stored estimates 404.
Functions
|
Classes
|
|
|
|
|
|
|
|
|
- class vibesketcher.server.porosity.PlanRequest(*, plan)[source]¶
Bases:
BaseModel- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class vibesketcher.server.porosity.FigureRequest(*, plan, options=<factory>, format='svg', dpi=300)[source]¶
Bases:
BaseModel- Parameters:
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- format: Literal['svg', 'pdf', 'png']¶
- class vibesketcher.server.porosity.HandoffRequest(*, plan, files=<factory>)[source]¶
Bases:
BaseModel- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class vibesketcher.server.porosity.StoreRequest(*, actor='agent', client='rest', revision, plan, estimate_id=None)[source]¶
Bases:
RevisionRequest- Parameters:
- model_config = {'extra': 'forbid'}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].