MathXplorer/WW™ - MathViews ActiveX Control for Wonderware FS2000 -- Reference Info

MathXplorer/WW -- Reference Info

Properties

• BOOL DebugInfo: Instruct MathViews to compile and execute in a debug mode. In debug mode MathViews fires events to inform the user interface (UI container) about the current file and line number. A debugger UI can suspend execution to inspect the stack variables.
• BOOL OkToAbort: Instruct MathViews to enable Abort() while executing a lengthy computation.
• BOOL MultiThreaded: Instruct MathViews run computation in a separate thread.

Methods

• long Abort(): Abort the execution of the currently running script.
• void AboutBox(): Displays the About dialog box
• long Evaluate(BSTR Expression): Start execution of the specified expression (on error, returns non zero value)
  • Expression: expression to execute. Must be a valid MathViews expression
• long EvaluateEx(BSTR Expression, BSTR FileName, long LineNumber): Start execution of the specified expression (on error, returns non zero value). MathXplorer/WW fires events to inform the container about the currently executing filename and line number.
  • Expression: expression to execute. Must be a valid MathViews expression
  • FileName: expression file name (leave blank if none)
  • LineNumber: expression line number (set to zero if none)
• long GetVarRows(BSTR VarName): Get the number of rows of a MathXplorer array variable.
  • VarName: MathXplorer/WW varname
• long GetVarCols(BSTR VarName): Get the number of columns of a MathXplorer array variable.
  • VarName: MathXplorer/WW varname
• double GetVarElement(BSTR VarName, long rowIndex, long colIndex): Get an element of a MathXplorer array variable.
  • VarName: MathXplorer/WW varname
  • rowIndex: row index
  • colIndex: col index
• BSTR GetVarString(BSTR VarName, long rowIndex): Get a string row of a MathXplorer array variable.
  • VarName: MathXplorer/WW varname
  • rowIndex: row index
• double GetVarScalar(BSTR VarName): Get the first (usually the only) element of a MathXplorer array/scalar variable.
  • VarName: MathXplorer/WW varname
  • rowIndex: row index
• long SetLongReturnValue(BSTR VarName, long Value): Set return values for MathXplorer/WW callbacks.
  • VarName: MathXplorer/WW VarName
  • Value: New value
• long SetStringReturnValue(BSTR VarName, BSTR Value): Set return values for MathXplorer/WW callbacks.
  • VarName: MathXplorer/WW VarName
  • Value: New value
• BSTR GetLastError(): Return the last error text
• long SetWinHandle(long hWnd): Set the graphic window for the next MathXplorer/WW plot. This method is called while executing a MathXplorer/WW event, GraphCallback(), .
  • hWnd: Window handle
• long SetOption(BSTR Option, BSTR Value): Set certain, undocumented, MathViews options.
  • Option: MathViews option
  • Value: Option value.
• Note: the computational thread waits for return value to continue computations.

Events

• AppError(BSTR ErrMessage): When MathViews needs to inform the user/container about an error.
  • ErrMessage: error message
• AppPrint(long PrintCode, BSTR Line): When MathViews needs to print a line. An optional flag specifies if the current output need to be erased.
  • PrintCode: print flag
    • 0: request clear of the output window
    • 1: Append to output window
  • Line: message to print
• CalcDone(long CalcNesting): Called when the computational thread completed it task.
  • CalcNesting: nesting level.
• GraphCallback(long GraphOption, long lParam): Fired when MathXplorer/WW needs to draw/create a graphic window.
  • GraphOption: Graphic request type
    • 1: new graphic
  • lParam: Graphic window number. Use this number to alternate between several graphic windows.

  The user interface code must return, by calling the SetReturnValue method, a valid handle to a graphic window. If the handle is not valid, the MathViews control window will be used.
  Note: Use the MathViews Graphic Control to enable Copy to clipboard and Print features.

• VarChanged(BSTR VarName): When AutoAssign is active, MathViews inform the user that the variable has been changed.
  • VarName: variable that changed

MathViews ActiveX Graph Control -- Reference Info

Properties: None

Methods

• [id(2)] long GetWinHandle();

• long Copy(): Copy the graph to the clipboard (PICT and Metafile formats)
• long Print(long Option): Print the graph to the default printer
  • Option Print option.
• long Write(BSTR FileName, long Option): Write the graph to the specified file (metafile format)
  • FileName file name
  • Option Write option.
• long GetWinHandle(): Return the handle to the Graphic window (Can be used during GraphCallback event to call SetLongReturnValue)

Events: None

This page, and all contents, are Copyright © 1997 by The MathWizards