Assembly

class compas.datastructures.Assembly(name=None, **kwargs)[source]

Bases: Datastructure

A data structure for managing the connections between different parts of an assembly.

Parameters

name (str, optional) – The name of the assembly.

Attributes
  • attributes (dict[str, Any]) – General attributes of the data structure that will be included in the data dict and serialization.

  • graph (Graph) – The graph that is used under the hood to store the parts and their connections.

Examples

>>>

Methods

add_connection

Add a connection between two parts.

add_part

Add a part to the assembly.

connections

Iterate over the connections between the parts.

find

Find a part in the assembly by its GUID.

find_by_key

Find a part in the assembly by its key.

parts

The parts of the assembly.

Inherited Methods

ToString

Converts the instance to a string.

copy

Make an independent copy of the data object.

from_data

Construct an object of this type from the provided data.

from_json

Construct an object from serialized data contained in a JSON file.

from_jsonstring

Construct an object from serialized data contained in a JSON string.

sha256

Compute a hash of the data for comparison during version control using the sha256 algorithm.

to_data

Convert an object to its native data representation.

to_json

Serialize the data representation of an object to a JSON file.

to_jsonstring

Serialize the data representation of an object to a JSON string.

validate_data

Validate the object's data against its data schema.

validate_json

Validate the object's data against its json schema.