Merge pull request #946 from compas-dev/assembly-suggestions

Assembly suggestions

Author: gonzalocasas

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Added `compas_rhino.DEFAULT_VERSION`.
 * Added `clean` option to `compas_rhino.install` to remove existing symlinks if they cannot be imported from the current environment.
+* Added basic implementation of `compas.datastructures.Assembly`.
 
 ### Changed
 

src/compas/datastructures/assembly/assembly.py

@@ -32,14 +32,24 @@ def JSONSCHEMANAME(self):
 
     def __init__(self, name=None, **kwargs):
         super(Assembly, self).__init__()
-        self.attributes = {}
+        self.attributes = {'name': name or 'Assembly'}
+        self.attributes.update(kwargs)
         self.graph = Graph()
-        self.parts = {}
+        self._parts = {}
 
     def __str__(self):
         tpl = "<Assembly with {} parts and {} connections>"
         return tpl.format(self.graph.number_of_nodes(), self.graph.number_of_edges())
 
+    @property
+    def name(self):
+        """str : The name of the assembly."""
+        return self.attributes.get('name') or self.__class__.__name__
+
+    @name.setter
+    def name(self, value):
+        self.attributes['name'] = value
+
     @property
     def data(self):
         """dict : A data dict representing the assembly data structure for serialization.
@@ -76,9 +86,11 @@ def add_part(self, part, key=None, **kwargs):
             The identifier of the part in the current assembly graph.
 
         """
+        if part.guid in self._parts:
+            raise AssemblyError('Part already added to the assembly')
         key = self.graph.add_node(key=key, part=part, **kwargs)
         part.key = key
-        self.parts[part.guid] = part
+        self._parts[part.guid] = part
         return key
 
     def add_connection(self, a, b, **kwargs):
@@ -120,9 +132,21 @@ def parts(self):
         for node in self.graph.nodes():
             yield self.graph.node_attribute(node, 'part')
 
-    def connections(self):
-        """The connections between the parts."""
-        return self.graph.edges()
+    def connections(self, data=False):
+        """Iterate over the connections between the parts.
+
+        Parameters
+        ----------
+        data : bool, optional
+            If ``True``, yield both the identifier and the attributes of each connection.
+
+        Yields
+        ------
+        tuple
+            The next connection identifier (u, v), if ``data`` is ``False``.
+            Otherwise, the next connector identifier and its attributes as a ((u, v), attr) tuple.
+        """
+        return self.graph.edges(data)
 
     def find(self, guid):
         """Find a part in the assembly by its GUID.
@@ -139,4 +163,4 @@ def find(self, guid):
             The identified part, if any.
 
         """
-        return self.parts.get(guid)
+        return self._parts.get(guid)

src/compas/datastructures/assembly/part.py

@@ -74,10 +74,11 @@ def DATASCHEMA(self):
     def JSONSCHEMANAME(self):
         return 'part'
 
-    def __init__(self, name, frame=None, shape=None, features=None, **kwargs):
+    def __init__(self, name=None, frame=None, shape=None, features=None, **kwargs):
         super(Part, self).__init__()
         self._frame = None
         self.attributes = {'name': name or 'Part'}
+        self.attributes.update(kwargs)
         self.key = None
         self.frame = frame
         self.shape = shape or Shape([], [])
@@ -88,6 +89,15 @@ def __str__(self):
         tpl = "<Part with shape {} and features {}>"
         return tpl.format(self.shape, self.features)
 
+    @property
+    def name(self):
+        """str : The name of the part."""
+        return self.attributes.get('name') or self.__class__.__name__
+
+    @name.setter
+    def name(self, value):
+        self.attributes['name'] = value
+
     @property
     def data(self):
         """dict : A data dict representing the part attributes, the assembly graph identifier, the local coordinate system,
@@ -124,7 +134,8 @@ def frame(self, frame):
 
     @property
     def geometry(self):
-        # this is a temp solution
+        # TODO: this is a temp solution
+        # TODO: add memoization or some other kind of caching
         A = Mesh.from_shape(self.shape)
         for shape, operation in self.features:
             A.quads_to_triangles()

tests/compas/datastructures/test_assembly.py

@@ -0,0 +1,43 @@
+from compas.datastructures import Assembly, assembly
+from compas.datastructures import Part
+
+
+def test_init():
+    assembly = Assembly(name='abc')
+    assert assembly.name == 'abc'
+
+    assembly = Assembly(attr1='value', attr2=3.14)
+    assert assembly.attributes['attr1'] == 'value'
+    assert assembly.attributes['attr2'] == 3.14
+
+
+def test_add_parts():
+    assembly = Assembly()
+
+    for _ in range(3):
+        assembly.add_part(Part())
+
+    assert len(list(assembly.parts())) == 3
+
+
+def test_add_connections():
+    assembly = Assembly()
+    parts = [Part() for i in range(3)]
+
+    for part in parts:
+        assembly.add_part(part)
+
+    assembly.add_connection(parts[0], parts[1])
+    assembly.add_connection(parts[1], parts[2])
+    assembly.add_connection(parts[2], parts[0])
+
+    assert list(assembly.connections()) == [(0, 1), (1, 2), (2, 0)]
+
+
+def test_find():
+    assembly = Assembly()
+    part = Part()
+    assert assembly.find(part.guid) is None
+
+    assembly.add_part(part)
+    assert assembly.find(part.guid) == part