Skip to main content

PhysicalConnectionState

Kind: Class
Domain: Physical connections
Canonical import: from cadflow import PhysicalConnectionState

Signature

class PhysicalConnectionState(connection_id: 'str', relative_translation: 'Vec3' = (0.0, 0.0, 0.0), relative_rotation: 'Vec3' = (0.0, 0.0, 0.0), relative_linear_velocity: 'Vec3' = (0.0, 0.0, 0.0), relative_angular_velocity: 'Vec3' = (0.0, 0.0, 0.0)) -> None

Description

Relative B-to-A connector state expressed in connector A's local frame.

Other public imports

  • from cadflow.physical import PhysicalConnectionState

Parameters

NameTypeRequiredDefaultSource description
connection_id'str'yes-Not explicitly described in the source docstring.
relative_translation'Vec3'no(0.0, 0.0, 0.0)Not explicitly described in the source docstring.
relative_rotation'Vec3'no(0.0, 0.0, 0.0)Not explicitly described in the source docstring.
relative_linear_velocity'Vec3'no(0.0, 0.0, 0.0)Not explicitly described in the source docstring.
relative_angular_velocity'Vec3'no(0.0, 0.0, 0.0)Not explicitly described in the source docstring.

Returns

Type: None

The source docstring does not declare additional return semantics.

Errors

The source docstring does not declare a narrower exception contract. Invalid types, values, ownership, paths, or backend state may still raise the corresponding public error.

Data fields

NameTypeDefault
connection_id'str'required
relative_translation'Vec3'(0.0, 0.0, 0.0)
relative_rotation'Vec3'(0.0, 0.0, 0.0)
relative_linear_velocity'Vec3'(0.0, 0.0, 0.0)
relative_angular_velocity'Vec3'(0.0, 0.0, 0.0)

Behavior and constraints

  • Instances are immutable dataclass values; update workflows return a replacement value.

Import check

from cadflow import PhysicalConnectionState

See also