Skip to main content

PhysicalConnectionResponse

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

Signature

class PhysicalConnectionResponse(connection_id: 'str', force: 'Vec3', torque: 'Vec3', normal_force: 'float', shear_force: 'float', tensile_utilization: 'float', shear_utilization: 'float', torque_utilization: 'float', active: 'bool', failed: 'bool') -> None

Description

Wrench on component B, expressed in connector A's local frame.

Other public imports

  • from cadflow.physical import PhysicalConnectionResponse

Parameters

NameTypeRequiredDefaultSource description
connection_id'str'yes-Not explicitly described in the source docstring.
force'Vec3'yes-Not explicitly described in the source docstring.
torque'Vec3'yes-Not explicitly described in the source docstring.
normal_force'float'yes-Not explicitly described in the source docstring.
shear_force'float'yes-Not explicitly described in the source docstring.
tensile_utilization'float'yes-Not explicitly described in the source docstring.
shear_utilization'float'yes-Not explicitly described in the source docstring.
torque_utilization'float'yes-Not explicitly described in the source docstring.
active'bool'yes-Not explicitly described in the source docstring.
failed'bool'yes-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
force'Vec3'required
torque'Vec3'required
normal_force'float'required
shear_force'float'required
tensile_utilization'float'required
shear_utilization'float'required
torque_utilization'float'required
active'bool'required
failed'bool'required

Public members

MemberKindSignatureDescription
to_dictmethod(self) -> 'dict[str, Any]'See the member signature.

Behavior and constraints

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

Import check

from cadflow import PhysicalConnectionResponse

See also