Visual Signal ExternalBase Class Library Documentation
TExternalViewer Class
VisualSignalVSignal.ExternalBaseTExternalViewer
API version 1.2.2.0

[This is preliminary documentation and is subject to change.]

ExternalViewer - Base viewer class inherited from TExternalBase, and also implementing the IExternalViewer interface . Any C# external user viewer DLL must inherit this class and override implementation for Init()()() and DoCompute()()(), and optionally UpdateViewerProperty()()().
Declaration Syntax
C#Visual BasicVisual C++
public class TExternalViewer : TExternalBase, 
	IExternalViewer, IExternalDll
Public Class TExternalViewer _
	Inherits TExternalBase _
	Implements IExternalViewer, IExternalDll
public ref class TExternalViewer : public TExternalBase, 
	IExternalViewer, IExternalDll
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
TExternalViewer()()()
Initializes a new instance of the TExternalViewer class

_autoResizeViewer
This protected member contains persistent AutoResizeViewer state which should be initialized in Init()()().

_backColor
This protected member contains persistent BackColor state which will be updated from Visual Signal viewer properties before DoCompute()()() is executed.

_inputData
This protected member will be initialized and updated by Visual Signal's ExternalDll module via setInputDescriptors(String), setInputCoordinates(Int32, Int32, array<Object>[]()[]), setInputDataRe(Int32, Int32, array<Double>[]()[]), and setInputDataIm(Int32, Int32, array<Double>[]()[]). The user DLL can directly access the DllData objects to obtain the data descriptor information.
(Inherited from TExternalBase.)
_inputTypes
This protected member contains a table of TExternalBase..::.DllInputType objects which stores the parameters used by the Dll. The table (in the form of a List) should be initialized in Init()()() using AcceptInput().
(Inherited from TExternalBase.)
_outputData
This protected member should be initialized and updated in the user DLL's DoCompute()()() function to contain the output data (only one allowed).
(Inherited from TExternalBase.)
_properties
This protected member contains a table of TExternalBase..::.DllProperty objects which stores the parameters used by the Dll. The table (in the form of a Dictionary) should be initialized in Init()()() using RegisterProperty().
(Inherited from TExternalBase.)
_showTitle
This protected member contains persistent ShowTitle state which will be updated from Visual Signal viewer properties before DoCompute()()() is executed.

_title
This protected member contains persistent Title state which will be updated from Visual Signal viewer properties before DoCompute()()() is executed.

_viewerPanel
This protected member contains the System.Windows.Forms.Panel-derived object which should be initialized in Init()()(). This member can be accessed via the ViewerPanel proeprty.

AcceptInput(TExternalBase..::.InputDataTypes)
Protected function "AcceptInput", proved to the user DLL for registering input types acceptable by the DLL for computation. This function should be invoked in Init()()(), and the registered acceptable input types will be passed to Visual Signal's ExternalDll module via getDllInfo()()(). Visual Signal will use this information to determine whether an input connection is valid or not.
(Inherited from TExternalBase.)
AcceptInput(TExternalBase..::.InputDataTypes, Int32, TExternalBase..::.InputCoordinateTypes, TExternalBase..::.InputChannelTypes, TExternalBase..::.InputValueTypes)
Protected function "AcceptInput", proved to the user DLL for registering input types acceptable by the DLL for computation. This function should be invoked in Init()()(), and the registered acceptable input types will be passed to Visual Signal's ExternalDll module via getDllInfo()()(). Visual Signal will use this information to determine whether an input connection is valid or not.
(Inherited from TExternalBase.)
AutoResizeViewer
If this property is set to "True", instruct the Visual Signal viewer to resize itself base on the control's size If set to "False", Visual Signal will try to resize the control based on the viewer's size. This property should be set in Init()()().

BackColor
Get the viewer background color The value will be updated from Visual Signal viewer properties before DoCompute()()() is executed.

compute()()()
Interface for exported function "compute", used by Visual Signal's ExternalDll module to execute the actual computation provided by the user DLL. This function just calls the protected function DoCompute()()(), which the user DLL must override with own implementation.
(Inherited from TExternalBase.)
DoCompute()()()
Protected virtual function "DoCompute", intended to be overridden by the inherited user DLL class to provide the actual computation. This function is called by the exported function compute()()() which is in turn used by Visual Signal's ExternalDll module to start computation.
(Inherited from TExternalBase.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
getDllInfo()()()
Exported function "getDllInfo()", used by Visual Signal's ExternalDll module to obtain DLL info such as name, version, API version, langauge, license control and properties.
(Inherited from TExternalBase.)
GetHashCode()()()
Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
GetInputCoord(Int32, Int32)
Protected function "GetInputCoord", provided to the user DLL to obtain the input coordinates.
(Inherited from TExternalBase.)
GetInputDataIm(Int32, Int32)
Protected function "GetInputDataRe", provided to the user DLL to obtain the imaginary part of the input data.
(Inherited from TExternalBase.)
GetInputDataRe(Int32, Int32)
Protected function "GetInputDataRe", provided to the user DLL to obtain the real part of the input data.
(Inherited from TExternalBase.)
getOutputCoordinates(Int32)
Exported function "getOutputCoordinates", used by Visual Signal's ExternalDll module to obtain the output data coordinates from the user DLL.
(Inherited from TExternalBase.)
getOutputDataIm(Int32)
Interface for exported function "getOutputDataIm", used by Visual Signal's ExternalDll module to obtain the output data (imaginary part) from the user DLL.
(Inherited from TExternalBase.)
getOutputDataRe(Int32)
Exported function "getOutputDataRe", used by Visual Signal's ExternalDll module to obtain the output data (real part) from the user DLL.
(Inherited from TExternalBase.)
getOutputDescriptor()()()
Exported function "getOutputDescriptor", used by Visual Signal's ExternalDll module to obtain output descriptor from the user DLL.
(Inherited from TExternalBase.)
getProperties()()()
Exported function "getProperties", used by Visual Signal's ExternalDll module to obtain property values from the user DLL.
(Inherited from TExternalBase.)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
getViewerPanel()()()
Exported function "getViewerPanel()", used by Visual Signal's ExternalViewer module to obtain external viewer object created by the user Dll

InfoText
Set this property in Init()()() to register the infoText of the user module. This will appear in Visual Signal as a tooltip for the dll.
(Inherited from TExternalBase.)
Init()()()
Protected virtual function "Init", intended to be overridden by the inherited user Dll class to provide the initialization function. This function is called by the exported function getDllInfo()()().
(Inherited from TExternalBase.)
LicenseManagerID
Set this property in Init()()() to register the license manager ID. If a license manager matching the ID were found, Visual Signal will attempt to use license control for the user module. If the property is not set or set to an empty string, license control will not be used for the user module.
(Inherited from TExternalBase.)
LicenseName
Set this property in Init()()() to register the license name. Visual Signal will attempt to match the license name against any license files loaded by the license manager. If no valid license file matches the license name, then the user module will not be available for use in Visual Signal. For security reasons, the module will also not be available if a license manager matching LicenseManagerID were *not* found.
(Inherited from TExternalBase.)
MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
MinInputCount
Set this property in Init()()() to register the minimum number of inputs acceptable by the user DmoduleLL.
(Inherited from TExternalBase.)
Name
Set this property in Init()()() to register the name of the user module.
(Inherited from TExternalBase.)
RegisterProperty(String, Type, Object, String, String, String)
Protected function "RegisterProperty", proved to the user DLL for registering properties used by the DLL computation. This function should be invoked in Init()()(), and the registered properties will be passed to Visual Signal's ExternalDll module via getDllInfo()()() and become available in the module's property dialog for editing. The current values will be communicated back and forth between ExternalDll module and the user DLL via setProperties(String) and getProperties()()() exported functions.
(Inherited from TExternalBase.)
RegisterProperty(String, Type, Object, String, String, String, String)
Protected function "RegisterProperty", proved to the user DLL for registering properties used by the DLL computation. This function should be invoked in Init()()(), and the registered properties will be passed to Visual Signal's ExternalDll module via getDllInfo()()() and become available in the module's property dialog for editing. The current values will be communicated back and forth between ExternalDll module and the user DLL via setProperties(String) and getProperties()()() exported functions.
(Inherited from TExternalBase.)
setBackColor(Color)
Exported function "setBackColor()", used by Visual Signal's ExternalViewer module to set external viewer background color

SetExtendedInfo(XmlDocument)
Override protected function SetExtendedInfo(XmlDocument) to set additional viewer-specific root atributes. This function is called by the exported function getDllInfo()()().
(Overrides TExternalBase.SetExtendedInfo(XmlDocument).)
setInputCoordinates(Int32, Int32, array<Object>[]()[])
Exported function "setInputCoordinates", used by Visual Signal's ExternalDll module to set input coordinates in the user Dll.
(Inherited from TExternalBase.)
setInputDataIm(Int32, Int32, array<Double>[]()[])
Exported function "setInputDataIm", used by Visual Signal's ExternalDll module to set the input data (imaginary part) in the user DLL.
(Inherited from TExternalBase.)
setInputDataRe(Int32, Int32, array<Double>[]()[])
Exported function "setInputDataRe", used by Visual Signal's ExternalDll module to set the input data (real part) in the user DLL.
(Inherited from TExternalBase.)
setInputDescriptors(String)
Exported function "setInputDescriptors", used by Visual Signal's ExternalDll module to set input descriptors in the user DLL.
(Inherited from TExternalBase.)
SetOutputCoords(Int32, array<Object>[]()[])
Protected function "SetOutputCoords", provided to the user DLL to set the output coordinates.
(Inherited from TExternalBase.)
SetOutputDataIm(Int32, array<Double>[]()[])
Protected function "SetOutputDataIm", provided to the user DLL to set the imaginary part of the output data.
(Inherited from TExternalBase.)
SetOutputDataRe(Int32, array<Double>[]()[])
Protected function "SetOutputDataRe", provided to the user DLL to set the real part of the output data.
(Inherited from TExternalBase.)
setProperties(String)
Exported function "setProperties", used by Visual Signal's ExternalDll module to set property values in the user DLL.
(Inherited from TExternalBase.)
setTitle(String, Boolean)
Exported function "setTitle()", used by Visual Signal's ExternalViewer module to set external viewer title

ShowTitle
Get whether to show the title in the viewer. The value will be updated from Visual Signal viewer properties before DoCompute()()() is executed.

Title
Get the viewer title string The value will be updated from Visual Signal viewer properties before DoCompute()()() is executed.

ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
UpdateProperty(String, Object)
Protected function "UpdateProperty", provided to the user DLL for updating the current property values. This function is usually invoked in the DoCompute()()() function after the computation stage.
(Inherited from TExternalBase.)
UpdateViewerProperty()()()
Virtual hook function "UpdateViewerProperty()". This function can be overridden in user's code to provide custom behaviour for updating viewer properties.

Version
Set this property in Init()()() to register the version of the user module.
(Inherited from TExternalBase.)
ViewerPanel
Set the external vewer System.Windows.Forms.Panel object. This property should be set in Init()()().

Inheritance Hierarchy
Object
TExternalBase
 TExternalViewer

Assembly: vsmExternalBase (Module: vsmExternalBase) Version: 1.2.2.0 (1.3.0.0)