Financial Market Simulation Documentation

General For users For researchers For developers


Date:      22 December '2010
Version:           v1.4
 

Contents

 

 

Introduction

This section of documentation is intended for developers who want to conduct their own experiments on the virtual market. In order to do that, you must either compile the project in Borland Delphi or use the embedded Object Pascal scripting language.

 

 

The contents of the 'source' release

 

1) Demos

Contains demos (source and resources). Inside each demo there should be a separate "ReadMe.txt" file.

  • Project - main project, the FIMAS application.

  • Plugins - collection of standard plugins.

 

2) Documentation

  • FMSModel.mpb - a ModelMaker model for the core classes (obsolete).

  • FMSModel_mm9.mpb - a ModelMaker 9+ model for the core classes.

 

3) Packages

Contains packages that need to be installed for some demos to run:

  • FMS_RunTime.dpk - all FMS core and application-specific units are included in this package. FMS will compile without it, so install this package only if like everything 'packaged'.

 

4) Source

Collection of various classes and components. Path to all folders in this directory should be added into your Delphi's Library path. Most units have a comment inside them which describes their purpose. Also there are a lot of comments in the interface part of the code, so if there are any problems - check there.

  • Core - all main units.
     

  • ApplicationSpecific - Mostly units that were designed for a certain application (FMS demo), but do not know have any references to FMS, so can be used for something else too.
     

  • PascalScriptImport - import units for RemObjects Pascal Script.
     

  • ThirdParty - components that are not not part of this project. Most of them were not written by me.

 

How to install

  1. Add all folders and sub-folders of \Source\ directory to your library search path. Directory \Source\ThirdParty\ is a special case - these are separate projects and I  recommend you update them from their own CVS/SVN repositories.
     

  2. Install all packages in the \Source\ThirdParty\ folder according to their own instructions.
    For noobies: Add all included folders to the library path and install the package, if there is one.
     

  3. Take a look at \Source\Core\FMS.inc . Change the options if you want to. For all third-party components do the same.
     

  4. Compile and run the demos in the \Demos\ folder.

 

Here's where you can download third-party components manually:

 

 

 

Documentation

1. Class reference
Date:          November '2010
Language:   English
Description: A complete reference to all units, classes and methods. Al least it lists them all, because real documentation is currently available only to most important classes/
Available in 3 forms: online html version, archived html version, and CHM version.

 

2. Architecture guide
Date:          January '2008
Language:   English
Description: A short guide on how different classes are interconnected.
Online version or download in an archive

 

 

 

UML diagrams

Class diagrams (Documented, English)

 

 

Class diagrams (Documented, Russian)

 

Class diagrams (Undocumented, compact)

 

 

Dependency diagrams

All packages and Components