XNotchJoint

class compas_timber.connections.XNotchJoint

Bases: Joint

Represents an X-Notch type joint which joins the two beams somewhere along their length with a notch applied on the main_beam. This joint type is typically used to connect two beams whose centerlines are offseted from each other, resulting in one resting on top of the other through a notch.

This joint type is compatible with beams in X topology.

Please use XNotchJoint.create() to properly create an instance of this class and associate it with a model.

Parameters:

main_beamBeam

The first beam to be joined. This beam will have a notch applied to it.

cross_beamBeam

The second beam to be joined. No features are applied to this beam.

Attributes:

main_beamBeam

The first beam to be joined. This beam will have a notch applied to it.

cross_beamBeam

The second beam to be joined. No features are applied to this beam.

Methods

add_features	Adds the required extension and trimming features to both beams.
restore_beams_from_keys	After de-serialization, restores references to the main and cross beams saved in the model.

Inherited Methods

ToString	Converts the instance to a string.
add_extensions	Adds the extensions defined by this joint to affected beam(s).
check_elements_compatibility	Checks if the cluster of beams complies with the requirements for the Joint.
copy	Make an independent copy of the data object.
create	Creates an instance of this joint and creates the new connection in model.
element_count_complies	Checks if the number of elements complies with the joint's requirements.
from_json	Construct an object of this type from a JSON file.
from_jsonstring	Construct an object of this type from a JSON string.
promote_cluster	Creates an instance of this joint from a cluster of elements.
promote_joint_candidate	Creates an instance of this joint from a joint candidate.
sha256	Compute a hash of the data for comparison during version control using the sha256 algorithm.
to_json	Convert an object to its native data representation and save it to a JSON file.
to_jsonstring	Convert an object to its native data representation and save it to a JSON string.
validate_data	Validate the data against the object's data schema.