Object Interface API Documentation

50.1 Object Interface API Documentation

The Object Interface's Application Programming Interface (API) is described via standard javadoc documentation, which provides documentation for all objects and methods supported by the Object Interface.

A few of the primary application and modeling objects are highlighted in the following table. These and other objects are documented in the API documentation.

Object	Description
TreeAgeProApplication	A reference to the TreeAge Pro application. This is the first object you must create to start using the Object Interface when not using Java.
Tree	Model created in TreeAge Pro.
Node	A specific node within a tree.
Variable	A variable within a tree. Use this object to read/update variable properties and root node definitions.
VariableDefinition	A variable definition at a specific node within a tree.
Tracker	A tracker within a tree. Use this object to read/update tracker properties.
TrackerModification	A tracker modification at a specific node within a tree.
Table	A table within a tree. Use this object to read/update table properties.
TableRow	A row of data within a table.
Distribution	A distribution within a tree. Use this object to read/update the distribution's type, parameters and properties.

The Object Interface Additional also includes objects that support analysis. Most analyses are run on the Tree object. However, several types of analyses require objects for handling inputs/parameters and outputs.

A few of the primary application and modeling objects are highlighted in the following table. These and other objects are documented in the javadoc API documentation.

Object	Description
Report	Output from any analysis. The type of analysis executed determines the format of the data within the object. Some Report objects can be used to create other Report objects to generate secondary analysis outputs (i.e., graphs from Monte Carlo simulation output). Analysis parameters are passed via a hashmap of named values prior to generating the report.
Graph	Graphical output from a Report object.
TextReport	Tabular text and numeric output from a Report object.

Object

Description

Report

Output from any analysis. The type of analysis executed determines the format of the data within the object. Some Report objects can be used to create other Report objects to generate secondary analysis outputs (i.e., graphs from Monte Carlo simulation output).

Analysis parameters are passed via a hashmap of named values prior to generating the report.

Graph

Graphical output from a Report object.

TextReport

Tabular text and numeric output from a Report object.