IntellePret Documentation

The Object Model
Program         ====> The root object
     |____ Functions       ====> Collection of functions in the program
       |____ Function     ====> A single function
         |____ Variables   ====> Collection of variables of a function
            |___ Variable  ====> A single variable
           

 

Object: Program
Property - Type String - Read/Write:
Text

Assigns the IntellePret program to be evaluated to the "Program" object.
Property - Type String - Read/Write:
FileName

Assigns the FileName to be used to load the IntellePret program from or save the IntellePret program to.
It is recommend to identify IntellePret files with an extension of Itr.
Property - Type Functions - Read-Only:
Functions

Returns an interface pointer to the object Functions (the collection of Functions).
Method
Prepare()

Prepares the IntellePret program into an intermediate form suitable for execution.
Method
Execute()

Executes the IntellePret program. If the IntellePret program has not been "Prepared", prepares the expression before executing it.
Returns the result of execution.
Method
ExecuteDirect(ExpressionProgram)

Combines the property "Text" assignment and the methods Prepare() and Execute() into a single method call.
Returns the result of execution.
Method
FileLoad

Reads in the IntellePret program from the file specified in property "FileName".
Method
FileSave(FileName)

Saves the IntellePret program to the file specified in property "FileName".
Method
Authenticate(Key, Code)

Authenticates the component Key / Code pair. This method is used to protect IntellePret from unauthorized usage. The Authenticate Key / Code pair is supplied to you when you purchase IntellePret. For ease of use, you can register IntellePret on your computer using this Key / Code pair and the IntellePretRegister program.
If you include and distribute IntellePret as part of your software product you are prohibited from registering IntellePret on the distributed computer. This would allow IntellePret to be used on the other computer by any other program.
Instead, to allow IntellePret to be used, only from your program you need to invoke this method (only once for the lifetime of your program) passing the Key / Code pair. Not invoking this method call will cause IntellePret to display its about box at random intervals.

 

Object: Functions

Standard read-only collection object, allows iterating a collection of objects.
Property - Type Long - Read-Only:
Count

The number of functions in the collection
Method
Item(FunctionIdentifier)

Returns the interface to the Function indexed into the collection. The Function could be indexed using the collection index or the function name.
Functions also implements the standard enum__variant interface. This interface is used by Visual Basic and scripting languages.

 

Object: Function
Property - Type String - Read-Only:
Name

Identifies the name of the Function. This value uniquely identifies a Function in the Functions collection.
Property - Type Variables - Read-Only:
Variables

Returns an interface pointer to Variables (the collection of Variables).
Method
Execute()

Executes the Function. Returns the result returned by that Function..

 

Object: Variables

Standard read-only collection object, allows iterating a collection of objects.
Property - Type Long - Read-Only:
Count

The number of Variables in the collection
Method
Item(VariableIdentifier)

Returns the interface to the Variable indexed into the collection. The Variable could be indexed using the collection index or the Variable name.
Variables also implements the standard enum__variant interface. This interface is used by Visual Basic and scripting languages.

 

Object: Variable
Property - Type String - Read-Only:
Name

Identifies the name of the Variable. This value uniquely identifies a Variable in the Variable collection.
Property - Type Variant - Read/Write:
Value

Returns the value of the Variable. The value of a Variable may be changed as in the case when modifying global Variables or parameters to a Function.
Property - Type ipVarScope - Read-Only:
Scope

The scope of the variable expressed as an enumeration (internal, global, parameter or local).
Enumeration Value Description
ipVarScopeInternal 1 The variable is an internally generated variable
ipVarScopeGlobal 2 The variable exists in global scope
ipVarScopeParameter 3 The variable is a parameter passed to a function
ipVarScopeLocal 4 The variable is local to a function
Property - Type ipVarDataType - Read-Only:
DataType

The data type of the variable expressed as an enumeration (bool, int, double, string).
Enumeration Value Description
ipVarDataTypeBool 1 The data type is an IntellePret bool
ipVarDataTypeInt 2 The data type is an IntellePret int
ipVarDataTypeDouble 3 The data type is an IntellePret double
ipVarDataTypeString 4 The data type is an IntellePret string

Home: www.intellessence.com. Copyright © 1998 - 2000 Intellessence Inc. All rights reserved.