TrendTool EVRIGUI Object

From Eigenvector Research Documentation Wiki
Revision as of 14:21, 19 February 2010 by imported>Jeremy (Created page with '__TOC__ These are the methods defined for the TrendTool interface when accessed through an EVRIGUI object. The following methods are called by referring to …')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

These are the methods defined for the TrendTool interface when accessed through an EVRIGUI object. The following methods are called by referring to the given EVRIGUI object, followed by the method to be accessed. For example, given an EVRIGUI object in the workspace called "obj", the following call sets the data currently being analyzed in the interface to the contents of the variable data:

  obj.setData(data)

And this call would return the current results of applying the current markers to the current data:

  results = obj.getResults;

The specific methods available are described in the sections below.


Methods

The following methods are available for TrendTool objects.

.clearMarkers Clears all currently set markers.
.drop(item) Automatically loads item (data or markers model) into TrendTool.
.getData Retrieve currently loaded data being analyzed in TrendTool.
.getMarkers Retrieve model of currently defined markers. This model can be reloaded using .setMarkers or applied to new data using standard model application approaches.
.getResults Retrieve DataSet object containing trend results obtained by applying the current markers model to the currently loaded data. If one or the other is not loaded, an empty DataSet object is returned.
.setData(data) Load the given data object into TrendTool. Any existing data is overwritten.
.setMarkers(model) Load the given markers model into TrendTool. Any existing markers are overwritten.


Generic GUI Methods

These methods provide simple access to simple GUI actions such as controlling the visibility of the GUI and closing or creating the GUI

.close Forces the GUI to close
.create Used to create a new Workspace Browser - NOTE: This method is called automatically by the main EVRIGUI object and should not be called directly by the user (an error will always be thrown in that situation)