omdl  v0.9.5
OpenSCAD Mechanical Design Library
docs_module.scad
Go to the documentation of this file.
1 //! Module: Black-box models of commodity components.
2 /***************************************************************************//**
3  \file
4  \author Roy Allen Sutton
5  \date 2024
6 
7  \copyright
8 
9  This file is part of [omdl] (https://github.com/royasutton/omdl),
10  an OpenSCAD mechanical design library.
11 
12  The \em omdl is free software; you can redistribute it and/or modify
13  it under the terms of the [GNU Lesser General Public License]
14  (http://www.gnu.org/licenses/lgpl.html) as published by the Free
15  Software Foundation; either version 2.1 of the License, or (at
16  your option) any later version.
17 
18  The \em omdl is distributed in the hope that it will be useful,
19  but WITHOUT ANY WARRANTY; without even the implied warranty of
20  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21  Lesser General Public License for more details.
22 
23  You should have received a copy of the GNU Lesser General Public
24  License along with the \em omdl; if not, write to the Free Software
25  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26  02110-1301, USA; or see <http://www.gnu.org/licenses/>.
27 
28  \details
29 
30  \amu_define group_name (Models)
31  \amu_define group_brief (Black-box models of commodity components.)
32 
33  \amu_include (include/amu/pgid_pparent_path_n.amu)
34 *******************************************************************************/
35 
36 //----------------------------------------------------------------------------//
37 // group.
38 //----------------------------------------------------------------------------//
39 
40 /***************************************************************************//**
41  \amu_include (include/amu/group.amu)
42 *******************************************************************************/
43 
44 //----------------------------------------------------------------------------//
45 
46 /***************************************************************************//**
47  \addtogroup \amu_eval(${group})
48 
49  \details
50 
51  This library considers a model to be any design element that is
52  fabricated elsewhere, such as commodity screws, linear rails,
53  motors, lights, circuit boards, etc. A model is typically either a
54  component that is a not a mechanical part or is an exterior
55  "black-box" descriptions of a mechanical part with internal detail
56  insufficient for manufacturing.
57 *******************************************************************************/
58 
59 //----------------------------------------------------------------------------//
60 // end of file
61 //----------------------------------------------------------------------------//