|
1 | 1 | --- |
| 2 | +layout: docs |
| 3 | +permalink: /docs/usage2/ |
2 | 4 | title: How to use STEPcode in an application |
3 | 5 | --- |
4 | 6 |
|
5 | | -CMake Integration |
6 | | ------------------ |
| 7 | +## CMake Integration |
7 | 8 |
|
8 | | -- Use **SC\_IS\_SUBBUILD** and **SC\_BUILD\_SCHEMAS** |
9 | | -- **SC\_SDAI\_ADDITIONAL\_EXES\_SRCS** can be used to have SC build |
| 9 | +- Use **SC_IS_SUBBUILD** and **SC_BUILD_SCHEMAS** |
| 10 | +- **SC_SDAI_ADDITIONAL_EXES_SRCS** can be used to have SC build |
10 | 11 | single-file executables (similar to p21read) |
11 | 12 | - this will not work for applications with more than one source |
12 | 13 | code file or that need to link other libs. |
13 | 14 |
|
14 | | -#### See also: [STEPcode CMake variables](STEPcode_CMake_variables.html) |
| 15 | +#### See also: [CMake variables used by STEPcode](/docs/cmake_vars/) |
15 | 16 |
|
16 | | -C++ examples |
17 | | ------------- |
| 17 | +## C++ examples |
18 | 18 |
|
19 | | -- [Minimal Part 21 C++ |
20 | | - example](Minimal_Part_21_C++_example.html) |
21 | | -- doxygen documentation of [apps using |
22 | | - STEPcode](http://stepcode.org/stepcode-use-doxygen/) |
| 19 | +- [Minimal Part 21 C++ example](Minimal_Part_21_C++_example.html) |
| 20 | +- doxygen documentation of [apps using STEPcode](http://stepcode.org/stepcode-use-doxygen/) |
23 | 21 | - [sc/src/express/test](https://github.com/stepcode/stepcode/tree/master/src/express/test/) |
24 | | - - tests executables for the express parser |
| 22 | + - tests for the express parser |
25 | 23 | - [sc/test/cpp/](http://github.com/stepcode/stepcode/tree/master/test/cpp/) |
26 | | - - tests written in c++; these can be built when ENABLE\_TESTING is |
27 | | - set to ON, but are excluded from 'make all' |
| 24 | + - tests written in c++; these can be built when ENABLE_TESTING is set to ON, but are excluded from 'make all' |
28 | 25 | - [sc/src/test](http://github.com/stepcode/stepcode/tree/master/src/test) |
29 | | - - tests written by NIST; all are up-to-date, but |
30 | | - [p21read](https://github.com/stepcode/stepcode/blob/master/src/test/p21read/p21read.cc#L138) |
31 | | - is the most frequently used. See the README in sc/src/test for more. |
| 26 | + - tests written by NIST; all are up-to-date, but [p21read](https://github.com/stepcode/stepcode/blob/master/src/test/p21read/p21read.cc#L138) is the most frequently used. See the README in sc/src/test for more. |
32 | 27 | - [sc/src/clprobe-ui](http://github.com/stepcode/stepcode/tree/master/src/clprobe-ui) |
33 | | - - remnants of a UI known as dataProbe; requires the |
34 | | - [InterViews](http://www.ivtools.org/ivtools/interviews.html) |
35 | | - toolkit, which predates X windows. An attempt has been made to |
36 | | - resurrect it, but without success. |
37 | | -- TODO: Example using lazy loading code. For now, see |
38 | | - [lazy\_test.cc](http://github.com/stepcode/stepcode/blob/master/src/cllazyfile/lazy_test.cc) |
39 | | - in the repo. |
| 28 | + - remnants of a UI known as dataProbe; requires the [InterViews](http://www.ivtools.org/ivtools/interviews.html) toolkit, which predates X windows. An attempt has been made to resurrect it, but without success. |
| 29 | +- TODO: Example using lazy loading code. For now, see [lazy_test.cc](http://github.com/stepcode/stepcode/blob/master/src/cllazyfile/lazy_test.cc) in the repo. |
40 | 30 |
|
41 | | -C++ applications that are not in the GitHub repository |
42 | | ------------------------------------------------------- |
| 31 | +## C++ applications that are not in the GitHub repository |
43 | 32 |
|
44 | | -The BRL-CAD |
45 | | -[step-g](http://brlcad.svn.sourceforge.net/viewvc/brlcad/brlcad/trunk/src/conv/step/) |
46 | | -converter, documented |
47 | | -[here](http://stepcode.org/stepcode-use-doxygen/step-g_8cpp.html) (Note |
48 | | -- currently, the BRL-CAD version of STEPcode differs slightly from the |
49 | | -version on GitHub) |
| 33 | +The BRL-CAD [step-g](http://brlcad.svn.sourceforge.net/viewvc/brlcad/brlcad/trunk/src/conv/step/) converter, documented [here](http://stepcode.org/stepcode-use-doxygen/step-g_8cpp.html) (Note - currently, the BRL-CAD version of STEPcode differs slightly from the version on GitHub) |
50 | 34 |
|
51 | 35 | Laurent Bauer's [SCView](https://github.com/LaurentBauer/SCView/wiki) |
52 | 36 |
|
53 | | -Python |
54 | | ------- |
| 37 | +## Python |
55 | 38 |
|
56 | | -- [Python |
57 | | - Generator](http://github.com/stepcode/stepcode/wiki/python-generator) |
| 39 | +- [Python Generator](http://github.com/stepcode/stepcode/wiki/python-generator) |
58 | 40 |
|
59 | | -TODO |
60 | | ----- |
| 41 | +## TODO |
61 | 42 |
|
62 | | -- describe use of [lazy loading |
63 | | - code](http://github.com/stepcode/stepcode/blob/master/src/cllazyfile/lazyInstMgr.h) |
64 | | -- create a page with a small Part 21 file, with description of format |
65 | | - and links to relevant classes - SDAI\_Application\_instance, |
66 | | - STEPcomplex, generated code (?) |
67 | | -- run doxygen on parts of STEPcode (libexpress + exppp + fedex\_plus, |
68 | | - fedex\_python, cllazyfile, cleditor, clstepcore + cldai + clutils + |
69 | | - base ) **and automate doxygen with a script** |
| 43 | +- describe use of [lazy loading code](http://github.com/stepcode/stepcode/blob/master/src/cllazyfile/lazyInstMgr.h) |
| 44 | +- create a page with a small Part 21 file, with description of format and links to relevant classes - SDAI_Application_instance, STEPcomplex, generated code (?) |
| 45 | +- run doxygen on parts of STEPcode (libexpress + exppp + fedex_plus, fedex_python, cllazyfile, cleditor, clstepcore + cldai + clutils + base ) **and automate doxygen with a script** |
70 | 46 |
|
71 | | -See also |
72 | | --------- |
| 47 | +## See also |
73 | 48 |
|
74 | | -- [Building STEPcode](Building_STEPcode.html) |
75 | | -- [How to test with CTest](How_to_test_with_CTest.html) |
76 | | - |
77 | | -[Category:Code discussion](Category:Code_discussion.html) |
| 49 | +- [Building STEPcode](/docs/building/) |
| 50 | +- [Testing](/docs/testing) |
0 commit comments