viewer.schema.payloads.StudyPayload

viewer.schema.payloads.StudyPayload()

One study declared in the scene program.

kind names what a program may contain; :class:~cadjoint.enums.StudyKind names what the viewer can create and edit through the patch endpoints. The two are equal today — a :class:cadjoint.flow.FlowStudy is displayed and written like the other two, though it discretises a fixed lattice rather than a mesh, so it carries a resolution and no mesh.

They are kept as separate vocabularies because they have differed and may again: flow was in this one and not the enum for as long as the patch layer could not write a FlowStudy, and widening the enum ahead of that would have made add_study advertise a kind it could not produce. A kind here and not in the enum reports editable: false.