Assembly: Implement Bill Of Materials (#14198)

* Assembly: Implementation of BOM

* Assembly: BOM: make it possible for BOM to be made without an assembly.

src/Mod/Assembly/App/AppAssembly.cpp

@@ -28,6 +28,8 @@
 #include <Base/PyObjectBase.h>
 
 #include "AssemblyObject.h"
+#include "BomObject.h"
+#include "BomGroup.h"
 #include "JointGroup.h"
 #include "ViewGroup.h"
 
@@ -43,6 +45,7 @@ PyMOD_INIT_FUNC(AssemblyApp)
     // load dependent module
     try {
         Base::Interpreter().runString("import Part");
+        Base::Interpreter().runString("import Spreadsheet");
     }
     catch (const Base::Exception& e) {
         PyErr_SetString(PyExc_ImportError, e.what());
@@ -58,6 +61,9 @@ PyMOD_INIT_FUNC(AssemblyApp)
     // This function is responsible for adding inherited slots from a type's base class.
 
     Assembly::AssemblyObject ::init();
+    Assembly::BomObject ::init();
+
+    Assembly::BomGroup ::init();
     Assembly::JointGroup ::init();
     Assembly::ViewGroup ::init();
 

src/Mod/Assembly/App/BomGroup.cpp

@@ -0,0 +1,55 @@
+// SPDX-License-Identifier: LGPL-2.1-or-later
+/****************************************************************************
+ *                                                                          *
+ *   Copyright (c) 2023 Ondsel <development@ondsel.com>                     *
+ *                                                                          *
+ *   This file is part of FreeCAD.                                          *
+ *                                                                          *
+ *   FreeCAD is free software: you can redistribute it and/or modify it     *
+ *   under the terms of the GNU Lesser General Public License as            *
+ *   published by the Free Software Foundation, either version 2.1 of the   *
+ *   License, or (at your option) any later version.                        *
+ *                                                                          *
+ *   FreeCAD is distributed in the hope that it will be useful, but         *
+ *   WITHOUT ANY WARRANTY; without even the implied warranty of             *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU       *
+ *   Lesser General Public License for more details.                        *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with FreeCAD. If not, see                                *
+ *   <https://www.gnu.org/licenses/>.                                       *
+ *                                                                          *
+ ***************************************************************************/
+
+#include "PreCompiled.h"
+#ifndef _PreComp_
+#endif
+
+#include <App/Application.h>
+#include <App/Document.h>
+#include <App/FeaturePythonPyImp.h>
+#include <App/PropertyPythonObject.h>
+#include <Base/Console.h>
+#include <Base/Tools.h>
+
+#include "BomGroup.h"
+#include "BomGroupPy.h"
+
+using namespace Assembly;
+
+
+PROPERTY_SOURCE(Assembly::BomGroup, App::DocumentObjectGroup)
+
+BomGroup::BomGroup()
+{}
+
+BomGroup::~BomGroup() = default;
+
+PyObject* BomGroup::getPyObject()
+{
+    if (PythonObject.is(Py::_None())) {
+        // ref counter is set to 1
+        PythonObject = Py::Object(new BomGroupPy(this), true);
+    }
+    return Py::new_reference_to(PythonObject);
+}

src/Mod/Assembly/App/BomGroup.h

@@ -0,0 +1,58 @@
+// SPDX-License-Identifier: LGPL-2.1-or-later
+/****************************************************************************
+ *                                                                          *
+ *   Copyright (c) 2023 Ondsel <development@ondsel.com>                     *
+ *                                                                          *
+ *   This file is part of FreeCAD.                                          *
+ *                                                                          *
+ *   FreeCAD is free software: you can redistribute it and/or modify it     *
+ *   under the terms of the GNU Lesser General Public License as            *
+ *   published by the Free Software Foundation, either version 2.1 of the   *
+ *   License, or (at your option) any later version.                        *
+ *                                                                          *
+ *   FreeCAD is distributed in the hope that it will be useful, but         *
+ *   WITHOUT ANY WARRANTY; without even the implied warranty of             *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU       *
+ *   Lesser General Public License for more details.                        *
+ *                                                                          *
+ *   You should have received a copy of the GNU Lesser General Public       *
+ *   License along with FreeCAD. If not, see                                *
+ *   <https://www.gnu.org/licenses/>.                                       *
+ *                                                                          *
+ ***************************************************************************/
+
+
+#ifndef ASSEMBLY_BomGroup_H
+#define ASSEMBLY_BomGroup_H
+
+#include <Mod/Assembly/AssemblyGlobal.h>
+
+#include <App/DocumentObjectGroup.h>
+#include <App/PropertyLinks.h>
+
+
+namespace Assembly
+{
+
+class AssemblyExport BomGroup: public App::DocumentObjectGroup
+{
+    PROPERTY_HEADER_WITH_OVERRIDE(Assembly::BomGroup);
+
+public:
+    BomGroup();
+    ~BomGroup() override;
+
+    PyObject* getPyObject() override;
+
+    /// returns the type name of the ViewProvider
+    const char* getViewProviderName() const override
+    {
+        return "AssemblyGui::ViewProviderBomGroup";
+    }
+};
+
+
+}  // namespace Assembly
+
+
+#endif  // ASSEMBLY_BomGroup_H

src/Mod/Assembly/App/BomGroupPy.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<GenerateModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="generateMetaModel_Module.xsd">
+  <PythonExport
+      Father="DocumentObjectGroupPy"
+      Name="BomGroupPy"
+      Twin="BomGroup"
+      TwinPointer="BomGroup"
+      Include="Mod/Assembly/App/BomGroup.h"
+      Namespace="Assembly"
+      FatherInclude="App/DocumentObjectGroupPy.h"
+      FatherNamespace="App">
+    <Documentation>
+      <Author Licence="LGPL" Name="Ondsel" EMail="development@ondsel.com" />
+      <UserDocu>This class is a group subclass for boms.</UserDocu>
+    </Documentation>
+
+    <CustomAttributes />
+  </PythonExport>
+</GenerateModel>

src/Mod/Assembly/App/BomGroupPyImp.cpp

@@ -0,0 +1,46 @@
+/***************************************************************************
+ *   Copyright (c) 2014 Jürgen Riegel <juergen.riegel@web.de>              *
+ *                                                                         *
+ *   This file is part of the FreeCAD CAx development system.              *
+ *                                                                         *
+ *   This library is free software; you can redistribute it and/or         *
+ *   modify it under the terms of the GNU Library General Public           *
+ *   License as published by the Free Software Foundation; either          *
+ *   version 2 of the License, or (at your option) any later version.      *
+ *                                                                         *
+ *   This library  is distributed in the hope that it will be useful,      *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU Library General Public License for more details.                  *
+ *                                                                         *
+ *   You should have received a copy of the GNU Library General Public     *
+ *   License along with this library; see the file COPYING.LIB. If not,    *
+ *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
+ *   Suite 330, Boston, MA  02111-1307, USA                                *
+ *                                                                         *
+ ***************************************************************************/
+
+
+#include "PreCompiled.h"
+
+// inclusion of the generated files (generated out of BomGroup.xml)
+#include "BomGroupPy.h"
+#include "BomGroupPy.cpp"
+
+using namespace Assembly;
+
+// returns a string which represents the object e.g. when printed in python
+std::string BomGroupPy::representation() const
+{
+    return {"<Bom Group>"};
+}
+
+PyObject* BomGroupPy::getCustomAttributes(const char* /*attr*/) const
+{
+    return nullptr;
+}
+
+int BomGroupPy::setCustomAttributes(const char* /*attr*/, PyObject* /*obj*/)
+{
+    return 0;
+}