Model Exporter Interpreter

From Eigenvector Research Documentation Wiki
Revision as of 14:02, 26 March 2011 by imported>Jeremy
Jump to navigation Jump to search

The Model_Exporter Interpreter implements several classes which can be used in Microsoft .NET environments to apply Model_Exporter models to new data. The following describes the classes implemented and their use. The classes include the ModelInterpreter, Workspace, and Matrix classes. The source code for these classes is supplied and can be used, compiled, and redistributed without restriction. Note that such redistribution permission does not permit the user to redistribute the Model_Exporter product itself - only the interpreter.

ModelInterpreter Class

The primary class in the Model_Exporter C# Interpreter is a ModelInterpreter object. The object's interface implements the ability to assign input data, specify a model to interpret and apply, and retrieve results from the application. Input data and results are all stored using the Matrix class described below.

Constructors

ModelInterpreter(String filename)

This form of the constructor method allows passing a filename of a Model_Exporter XML file which should be read and parsed for application.

ModelInterpreter(XmlDocument xdoc)

This form of the constructor method allows passing a XmlDocument object which contains the contents of a Model_Exporter XML file. This method may be preferred when the content of an exported model has been previously read and stored in another location like a database. In such cases, the alternative ways to create XmlDocuments (see the XmlDocument documentation) which can be used to pass the parsed XML contents directly to the ModelInterpreter class.

Methods

apply()

Applies the model to the inputdata. Throws an error if property inputdata has not already been assigned. After calling this method, the results of the model application are stored in the results property.


Properties

Read-Only Properties

inputDataSize

modeltype

information

results

Read/Write Properties

inputdata

Specifies the data to which the model should be applied. Type is matrix as defined using the Matrix class described below. This field is not modified by applying the model. Assigning a new value this field erases the results from a previous model application.


Workspace Class

Matrix Class