JointCandidate

class compas_timber.connections.JointCandidate

Bases: Joint

A JointCandidate is an information-only joint, which does not add any features to the elements it connects.

It is used to create a first-pass joinery information which can be later used to perform analysis using BeamGroupAnalyzer.

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

Parameters:

element_aTimberElement

First element to be joined.

element_bTimberElement

Second element to be joined.

distancefloat | None

Distance between the elements.

Attributes:

element_aTimberElement

First element to be joined.

element_bTimberElement

Second element to be joined.

distancefloat | None

Distance between the elements.

Methods

add_features	This joint does not add any features.
restore_beams_from_keys	After de-serialization, restores references to elements 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.