Stock

class compas_timber.planning.Stock

Bases: Data

A base class to represent a stock piece for nesting.

Parameters:

lengthfloat

Length of the stock piece.

widthfloat

Width of the stock piece.

heightfloat

Height of the stock piece.

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.

widthfloat

Width of the stock piece.

heightfloat

Height of the stock piece.

spacingfloat, optional

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

element_datadict[str, Frame]

Dictionary mapping element GUIDs to their assigned position frames.

Methods

add_element	Add an element to this stock assignment.
can_fit_element	Check if an element can fit in the remaining space.
is_compatible_with	Check if this stock can accommodate the element 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.