OpenArbor Examples

Deos maintainers often produce examples that get delivered to the customer to demonstrate specific functionality provided by Deos components.
OpenArbor provides an import capability to allow users to include one or more of the deos examples in their workspace.

Importing Deos Examples

To import a Deos Example into a workspace, select File|Import...|Deos Examples.
The Import Deos Examples dialog is displayed containing a list of directories found at the "Examples Root:" location defined on DDC-I Preferences dialog. By default the location is $(DESK_DIR)\examples.
The "Examples Root:" preference directory location can be modified to point to a Deos maintainer's example development location to test importing from there.

Creating a project in OpenArbor

It is recommended OpenArbor be used to create the example project to be included in a dds, as opposed to a 'clone and own' strategy
In an empty workspace, use the File|New|DDC-I Executable Project dialog to create a project, selecting the type of project needed.
In order for OA (a.k.a Eclipse) to recognize a set of files in a folder as an OpenArbor project, the folder has to contain a .project and .options file.
Once your project is populated with the needed files to build the example, the OpenArbor project can be turned into a Deos Example Project.

Creating a Deos Example Project

An example project must contain:
1) example.project file which contains the content of the .project file used to create the example
2) files needed for the example to build
3) .options file

From outside OpenArbor, copying the content of the .project file to the example.project file, and remove any OpenArbor generated files (e.g. .settings folder, output folder, project-config.mk, Makefile, .cproject)
If the .options file contains a version higher than 28, modify the .options file to set the version 28 (e.g. <version>28</version>), this will cause OA to generate the needed .settings folder when the example is imported.
This applies to the Executable, Shared Object, and Metadata Projects. An example creator has two choices. (1) set the version to 28 or (2) set the version to 29+ and include the needed settings folder/file required by Eclipse in the example.

Creating a Deos Example Workspace

An example workspace is defined by the example.workspace file.
This file is empty, but notifies the import dialog to display the example projects in a group in the dialog

Deos Example directory structure

/desk/examples
     auto-tune
          auto-tune
              code
                  auto-tune.cpp
              xml
                  auto-tune.pd.xml              
              .options
              example.project
          auto-tune-library
              code
                  autoTuneLib.cpp
              include
                  autoTuneLib.h  
              xml
                  auto-tune-chan.fp.xml                    
              .options
              example.project
          example.workspace

Import Deos Examples Dialog

OpenArbor Automated Tests Using Deos Examples

The OpenArbor automated test suite imports all Deos Examples included in a DDS for testing OpenArbor as well as for integration testing purposes with Deos components.

TODO: Add info about specific example file dependencies (like kernel-model-calculator-user.c)