Copy ATF Sample and Run It - kaisu1986/ATF GitHub Wiki

Table of Contents ATF Folder Structure Copy Sample Copy Needed Files Build and Run Sample Topics in this section

You need several folders and a file in the wws_atf folder of the ATF distribution to build samples or an ATF application:

• Framework: folders of source files for each assembly in ATF.
• Samples: the samples, one folder for each sample containing all the sample's source and other files.
• ThirdParty: third party DLLs and other files ATF uses.
• wws_atf.component: a file needed to build an ATF application.
• DevTools\DomGen: a utility for generating schema stub classes.

It is simplest to maintain this folder structure for your application. You do not need all the files in each folder; what you need depends on your application's requirements.

Make a copy of the project folder for the sample you are going to be working from, SimpleDomEditor, in this case. There are several ways to do this.

One way is to simply copy the folder for the sample and leave the copy in the Samples folder. All the other folders and files are then available.

You can also replicate the folder structure of the ATF distribution for your new application project. Create a new folder for your project(s), say Projects; create Framework and ThirdParty folders in Projects; copy the wws_atf.component file into Projects, too. Create a folder in Projects for your projects, analogous to the Samples folder, say ATF Applications. Make a copy of the Samples/SimpleDomEditor folder, rename it "LandscapeGuide", and place it in ATF Applications. This is the approach taken here.

Determine what assemblies are used by the chosen sample project. For SimpleDomEditor, these are:

• Atf.Core
• Atf.Gui
• Atf.Gui.WinForms
• Atf.IronPython

You can determine the needed assemblies by opening the Samples' Solution file, Samples.vs2010.sln, and going to the Solution's Property Pages. In Common Properties > Project Dependencies, select the desired project. The Depends on panel has the assemblies checked that you need. There is one folder in Framework for each assembly; copy the assembly folders needed to your Framework folder.

You may change these assemblies later as needed, based on what code you add or remove.

Next, determine the third party files needed. For SimpleDomEditor, these are:

• Bespoke
• DockPanelSuite
• IronPython
• MEF
• SharpDX
• Wws.LiveConnect

The simplest way to find what's needed is to try building. Error messages indicate what's missing.

Copy the Samples.vs2010.sln file to your ATF Applications folder.

To verify that you have copied everything you need, open the .sln file and build SimpleDomEditor. If it fails to build, examine the error messages and make the appropriate fixes. For instance, you might need some third party software that you have not copied into the ThirdParty folder. Make the changes needed until you successfully build. Next, run SimpleDomEditor and verify it's working, making changes until it operates properly.