DesignImpl

ODTBX Design & Implementation

Information on the architecture, design, and implementation should be collected here.

This is intended for developers and advanced users.

Design

Things like code design and algorithm design should go here.

Parallel Computing

ODTBX can now use the Parallel Computing Toolbox with the estimators in order to run multiple simultaneous Monte Carlo runs in pralle. Some modifications to JAT were required to make this happen. Check out the [ParallelComputing] page for details.

Measurement data, dynamics function, and estimator design

The attached ODTBDevGuide.pdf contains information useful to anyone looking to add functions to OD Toolbox. It is intended for developers. It describes how to develop new measurement data and dynamics functions for use with existing OD Toolbox functionality. It also describes how to develop new OD Toolbox estimators that will be compliant with existing OD Toolbox estimator interfaces and methodologies.

Measurement Object Model (MOM)

Kenneth M. Getzandanner created and presented a Measurement Object Model (MOM) concept on August 5th, 2009 during the ODTBX regular tagup. This is an object oriented model for simulating measurements betwen objects in a complex network. The presentation slides are the attached file, MOM_ODTBX.pptx, below.

More information is found on the [OdtbxMom] page.

Implementation

Things like:

• interface calling conventions,
• function naming,
• paths and classpaths, and
• specific details to the MATLAB-Java and MATLAB-MICE interfaces

should go here. Other conventions that would be useful to future developers should find their way here too.

ODTBX Directory Dependencies

As the code is maintained developers should always check to ensure that the dependencies between the various MATLAB scripts are organized properly. Please follow these guidelines when implementing MATLAB functions in ODTBX:

1) JAT_Adaptors should only depend on JAT code and other JAT_Adaptors, but not ODTBX_Source code.
2) ODTBX_Source should never depend on files in Examples or in Regression_Validation.
3) Examples and Regression_Validation should each only reference ODTBX_Source or JAT_Adaptors, and never each other.
4) Functions or data in private directories under ODTBX_Source should only be directly called from ODTBX_Source code in the directory above the private directory.

a) End-users should never have a need to access the contents of these private directories.
b) Likewise, code in Examples or Regression_Validation should never directly access the contents of these private directories.

Following these guidelines should help keep the codebase manageable.

---

Navigation

[ForDevelopers] - Go back to the main development page

WikiStart - Go back to OD Toolbox Home