class
FrameKind
L224class FrameKind(StrEnum)No public docstring is provided in the current source.
← Python SDK / frames
PYTHONPUBLIC API
fastsim.api.frames
Current public Python API for fastsim.api.frames; signatures are extracted directly from the vNext AST.
Source src/fastsim/api/frames.pyPublic symbols 11
class
FrameDescriptor
L236class FrameDescriptor(object)One frame-node relationship without a backend-native transform handle.
| Field | Type | Default |
|---|---|---|
| frame_id | str | — |
| kind | FrameKind | — |
| parent_frame_id | str | None | — |
| owner_entity_id | str | None | None |
| owner_link_id | str | None | None |
| name | str | None | None |
class
FrameQuery
L290class FrameQuery(object)A bounded deterministic intersection filter for frame reads.
| Field | Type | Default |
|---|---|---|
| frame_ids | tuple[str, ...] | () |
| entity_ids | tuple[str, ...] | () |
| kinds | tuple[FrameKind, ...] | () |
class
FrameCatalogSnapshot
L326class FrameCatalogSnapshot(object)Immutable frame graph catalog for one locked plan and generation.
| Field | Type | Default |
|---|---|---|
| run_id | str | — |
| plan_digest | str | — |
| generation | int | — |
| catalog_revision | int | — |
| content_sha256 | str | — |
| frames | tuple[FrameDescriptor, ...] | — |
class
FrameTransform
L377class FrameTransform(object)Compact ``target_T_source`` transform used inside a frame delta.
| Field | Type | Default |
|---|---|---|
| target_frame | str | — |
| source_frame | str | — |
| target_T_source | Pose | — |
class
TransformStamped
L398class TransformStamped(object)A committed ``target_T_source`` lookup result. ``target_T_source`` maps coordinates expressed in ``source_frame`` into ``target_frame``. Translation is metres and rotation is a right-handed ``xyzw`` unit quaternion through :class:`~fastsim.api.scene.Pose`.
| Field | Type | Default |
|---|---|---|
| run_id | str | — |
| generation | int | — |
| sim_tick | int | — |
| sim_time_s | float | — |
| sequence | int | — |
| captured_monotonic_ns | int | — |
| world_revision | int | — |
| catalog_revision | int | — |
| catalog_content_sha256 | str | — |
| transform_revision | int | — |
| target_frame | str | — |
| source_frame | str | — |
| target_T_source | Pose | — |
class
FrameDelta
L461class FrameDelta(object)Bounded graph/transform update or terminal resynchronization marker.
| Field | Type | Default |
|---|---|---|
| run_id | str | — |
| generation | int | — |
| sim_tick | int | — |
| sim_time_s | float | — |
| sequence | int | — |
| captured_monotonic_ns | int | — |
| base_sequence | int | — |
| previous_world_revision | int | — |
| world_revision | int | — |
| previous_catalog_revision | int | — |
| catalog_revision | int | — |
| previous_catalog_content_sha256 | str | None | — |
| catalog_content_sha256 | str | None | — |
| previous_transform_revision | int | — |
| transform_revision | int | — |
| added_frames | tuple[FrameDescriptor, ...] | () |
| removed_frame_ids | tuple[str, ...] | () |
| transforms | tuple[FrameTransform, ...] | () |
| resync_required | bool | False |
class
FrameQueryErrorCode
L593class FrameQueryErrorCode(StrEnum)No public docstring is provided in the current source.
class
FrameQueryError
L604class FrameQueryError(RuntimeError)Typed bounded failure from ``fastsim.frame.query@3``.
class
FrameDeltaSubscription
L637class FrameDeltaSubscription(Protocol)No public docstring is provided in the current source.
dropped
FrameDeltaSubscription.dropped(self) -> int
No public docstring is provided in the current source.
closed
FrameDeltaSubscription.closed(self) -> bool
No public docstring is provided in the current source.
get_async
async FrameDeltaSubscription.get_async(self, timeout: float | None=None) -> FrameDelta
No public docstring is provided in the current source.
close
FrameDeltaSubscription.close(self) -> None
No public docstring is provided in the current source.
class
FrameQueryService
L650class FrameQueryService(Protocol)No public docstring is provided in the current source.
service_id
FrameQueryService.service_id(self) -> str
No public docstring is provided in the current source.
catalog
FrameQueryService.catalog(self, query: FrameQuery | None=None) -> FrameCatalogSnapshot
No public docstring is provided in the current source.
lookup
FrameQueryService.lookup(self, target_frame: str, source_frame: str, *, generation: int | None=None) -> TransformStamped
No public docstring is provided in the current source.
subscribe
FrameQueryService.subscribe(self, query: FrameQuery | None=None, capacity: int=16) -> FrameDeltaSubscription
No public docstring is provided in the current source.