BeamStock

class compas_timber.planning.BeamStock

Bases: Stock

A class to represent a stock piece for nesting beams.

Similar to a Beam but represents raw material stock that can have beams assigned to it.

Parameters:

lengthfloat

Length of the stock piece.

cross_sectiontuple of float

Cross-section dimensions (width, height).

spacingfloat, optional

Spacing tolerance for cutting operations (kerf width, etc.).

element_datadict[str, Frame], optional

Dictionary mapping element GUIDs to their assigned position frames.

Attributes:

lengthfloat

Length of the stock piece.

cross_sectiontuple of float

Cross-section dimensions sorted in ascending order for consistent comparison.

spacingfloat, optional

Spacing tolerance for cutting operations (kerf width, etc.).

element_datadict[str, Frame], optional

Dictionary mapping element GUIDs to their assigned position frames.

Methods

add_element	Add a beam to this stock assignment.
can_fit_element	Check if a beam can fit in the remaining space.
is_compatible_with	Check if this stock can accommodate the beam type and dimensions.

Inherited Methods

ToString	Converts the instance to a string.
copy	Make an independent copy of the data object.
from_json	Construct an object of this type from a JSON file.
from_jsonstring	Construct an object of this type from a JSON string.
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.