/
dev_project.dox
98 lines (77 loc) · 4.35 KB
/
dev_project.dox
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/*
* Orca-Robotics Project: Components for robotics
* http://orca-robotics.sf.net/
* Copyright (c) 2004-2009 Alex Brooks, Alexei Makarenko, Tobias Kaupp
*
* This copy of Orca is licensed to you under the terms described in
* the LICENSE file included in this distribution.
*
*/
/*!
@page orca_doc_devproj Starting Your Own Orca Project
@note Reviewed for release 2.10.0.
A common situation is that you want to work on a component outsided of the Orca source tree. This can happen if you want to experiment without the need to keep the code clean and documented (a requirement for Orca SourceForge repository) or you want to work on a closed-source component. In this case you should download and install the main Orca distribution and then setup a parallel workspace for your own project.
@section orca_doc_devproj_create Creating a Satelite Project
To help you start quickly we provide a template project which uses CMake, mirrors
the setup of the Orca repository and is already set up to find Ice and the Orca
installation, etc. You can of course set up a project in any way you like, however you
might find this template useful. (We use the export command instead checkout, to avoid manually removing the .svn directories).
@verbatim
$ svn export https://orca-robotics.svn.sf.net/svnroot/orca-robotics/empty/trunk empty-export
@endverbatim
We'll walk through the steps of customizing the empty project into a project called 'tractor'.
- Rename the directory 'empty-export' to 'tractor'
- Edit the top level CMakeLists.txt file so it looks like this:
@verbatim
PROJECT( tractor )
SET( GBX_PROJECT_VERSION 0.0.1 CACHE STRING "Version of 'Empty' distribution" )
SET( PROJECT_INTERFACE_LIB TractorInterfaces )
@endverbatim
- Rename interface subdirectories named after the project main namespace:
@verbatim
$ mv src/interfaces/slice/empty src/interfaces/slice/tractor
$ mv src/interfaces/cpp/empty src/interfaces/cpp/tractor
$ mv src/interfaces/cpp/emptyifacestring src/interfaces/cpp/tractorifacestring
$ mv src/interfaces/cpp/emptyifaceinit src/interfaces/cpp/tractorifaceinit
@endverbatim
- Edit the corresponding CMakeLists.txt files (e.g. @c src/interfaces/slice/CMakeLists.txt), change the argument of SUBDIRS() command from 'empty' to 'tractor'.
- Rename the module name in the sample interface .ice file @c src/interfaces/slice/tractor/someinterface.ice so that the include line looks like this:
@verbatim
#ifndef TRACTOR_SOME_INTERFACE_ICE
#define TRACTOR_SOME_INTERFACE_ICE
#include <orca/orca.ice>
module tractor
{
@endverbatim
- Edit the source file of the sample component @c src/components/somecomponent/main.cpp so that the include line looks like this:
@verbatim
#include <tractor/someinterface.h>
...
tractor::SomeDataPtr someData = new tractor::SomeData;
...
tractor::SomeClassDataPtr someCData = new tractor::SomeClassData;
@endverbatim
- Edit the source file of the sample utility @c src/utils/someutil/main.cpp so that the include line looks like this:
@verbatim
#include <tractor/someinterface.h>
...
tractor::SomeDataPtr someData = new tractor::SomeData;
...
tractor::SomeClassDataPtr someCData = new tractor::SomeClassData;
@endverbatim
- If you're going to use revision control system (e.g. SVN, CVS), it's a good idea to commit your project to your own repository at this point. All the current files are "raw" files which need to be added to CVS. If you commit later and used an in-source build, raw and generated files will be mixed.
- Run cmake and compile.
This enough to get you started. Now you can start writing code: add your own components, libraries, and interfaces.
@section orca_doc_devproj_tips Tips for Maintaining a Satelite Project
@par Versions tags
If this is an internal project, then you probably don't bother realeasing distributions. It's still useful to have a history of working code. It's easy to add a tag when Orca version changes and you made sure that your project compiles with the new version.
In SVN you do it like this, assuming Orca version 2.12.0. URL is the URL to your repository, not Orca's.
You can get it easily by typing @c 'svn @c info' at the top level of the local copy.
@verbatim
$ svn copy [URL]/tractor/trunk [URL]/tractor/tags/orca-2.12.0 -m "Works with orca release 2.12.0"
@endverbatim
(Here's how we used to do the same thing in CVS.)
@verbatim
$ cvs tag -f orca-2.12.0
@endverbatim
*/