TExternalViewer ClassVisual Signal ExternalBase Class Library Documentation
API version 1.5.2

[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.
Inheritance Hierarchy

SystemObject
  VSignal.ExternalBaseTExternalBase
    VSignal.ExternalBaseTExternalViewer

Namespace: VSignal.ExternalBase
Assembly: vsmExternalBase (in vsmExternalBase.dll) Version: 1.6.0.0
Syntax

public class TExternalViewer : TExternalBase, 
	IExternalViewer, IExternalDll

The TExternalViewer type exposes the following members.

Constructors

  NameDescription
Public methodTExternalViewer
Initializes a new instance of the TExternalViewer class
Top
Methods

  NameDescription
Protected methodAcceptInput(TExternalBaseInputDataTypes)
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.)
Protected methodAcceptInput(TExternalBaseInputDataTypes, Int32, TExternalBaseInputCoordinateTypes, TExternalBaseInputChannelTypes, TExternalBaseInputValueTypes)
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.)
Public methodcompute
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. External properties, input and output data are processed by Visual Signal before and after the execution of this function. User should expect _inputData to contain the input data and update _outputData to sent to Visual Signal. User should also expect _properties to contain properties from Visual Signal and use UpdateProperty(String, Object) to update properties to Visual Signal.
(Inherited from TExternalBase.)
Protected methodDoCompute
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.)
Public methoddoubleClick
Interface for exported function "doubleClick", used by Visual Signal's ExternalDll module to handle the callback when user double-clicks the corresponding Visual Signal component. This function just calls the protected function OnDoubleClick, which the user DLL can override with own implementation. Like compute, external properties are processed by Visual Signal before and after the execution of this function; however, input and output data are not processed. User should expect _properties to contain properties from Visual Signal and use UpdateProperty(String, Object) to update properties to Visual Signal.
(Inherited from TExternalBase.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodgetDllInfo
Exported function "getDllInfo()", used by Visual Signal's ExternalDll module to obtain DLL info such as name, version, API version, language, license control and properties.
(Inherited from TExternalBase.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetInputCoords
Protected function "GetInputCoords", provided to the user DLL to obtain the input coordinates.
(Inherited from TExternalBase.)
Protected methodGetInputDataExtension
Protected function "GetInputDataExtensionKeys", provided to the user DLL to obtain the input data extension.
(Inherited from TExternalBase.)
Protected methodGetInputDataExtensionKeys
Protected function "GetInputDataExtensionKeys", provided to the user DLL to obtain the available input data extension keys.
(Inherited from TExternalBase.)
Protected methodGetInputDataIm
Protected function "GetInputDataRe", provided to the user DLL to obtain the imaginary part of the input data.
(Inherited from TExternalBase.)
Protected methodGetInputDataRe
Protected function "GetInputDataRe", provided to the user DLL to obtain the real part of the input data.
(Inherited from TExternalBase.)
Public methodgetOutputCoordinates
Exported function "getOutputCoordinates", used by Visual Signal's ExternalDll module to obtain the output data coordinates from the user DLL.
(Inherited from TExternalBase.)
Public methodgetOutputDataIm
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.)
Public methodgetOutputDataRe
Exported function "getOutputDataRe", used by Visual Signal's ExternalDll module to obtain the output data (real part) from the user DLL.
(Inherited from TExternalBase.)
Public methodgetOutputDescriptor
Exported function "getOutputDescriptor", used by Visual Signal's ExternalDll module to obtain output descriptor from the user DLL.
(Inherited from TExternalBase.)
Public methodgetProperties
Exported function "getProperties", used by Visual Signal's ExternalDll module to obtain property values from the user DLL.
(Inherited from TExternalBase.)
Protected methodGetPropertyValue
(Deprecated) Protected function "GetPropertyValue", provided to the user DLL for retrieving the current property values. This function is usually invoked in the DoCompute function after the computation stage. This is deprecated. Property values can now be accessed like regular C# public properties.
(Inherited from TExternalBase.)
Public methodGetType (Inherited from Object.)
Public methodgetViewerPanel
Exported function "getViewerPanel()", used by Visual Signal's ExternalViewer module to obtain external viewer object created by the user Dll
Protected methodInit
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.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnDoubleClick
Protected virtual function "OnDoubleClick", intended to be overridden by the inherited user DLL class to provide the actual computation. This function is called by the exported function doubleClick which is in turn used by Visual Signal's ExternalDll module to handle callback when user double-clicked on the module.
(Inherited from TExternalBase.)
Protected methodRegisterProperty
(Deprecated) 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. This is deprecated. Property values can now be defined like regular C# properties, with appropriate attributes attached to the properties to define their categories, display names, descriptions, etc. Properties must be public and browsable.
(Inherited from TExternalBase.)
Public methodsetBackColor
Exported function "setBackColor()", used by Visual Signal's ExternalViewer module to set external viewer background color
Protected methodSetExtendedInfo
Override protected function SetExtendedInfo(XmlDocument) to set additional viewer-specific root attributes. This function is called by the exported function getDllInfo.
(Overrides TExternalBaseSetExtendedInfo(XmlDocument).)
Public methodsetInputCoordinates
Exported function "setInputCoordinates", used by Visual Signal's ExternalDll module to set input coordinates in the user DLL.
(Inherited from TExternalBase.)
Public methodsetInputDataIm
Exported function "setInputDataIm", used by Visual Signal's ExternalDll module to set the input data (imaginary part) in the user DLL.
(Inherited from TExternalBase.)
Public methodsetInputDataRe
Exported function "setInputDataRe", used by Visual Signal's ExternalDll module to set the input data (real part) in the user DLL.
(Inherited from TExternalBase.)
Public methodsetInputDescriptors
Exported function "setInputDescriptors", used by Visual Signal's ExternalDll module to set input descriptors in the user DLL.
(Inherited from TExternalBase.)
Protected methodSetOutputCoords
Protected function "SetOutputCoords", provided to the user DLL to set the output coordinates.
(Inherited from TExternalBase.)
Protected methodSetOutputDataExtension
Protected function "SetOutputDataExtension", provided to the user DLL to set the output data extension info.
(Inherited from TExternalBase.)
Protected methodSetOutputDataIm
Protected function "SetOutputDataIm", provided to the user DLL to set the imaginary part of the output data.
(Inherited from TExternalBase.)
Protected methodSetOutputDataRe
Protected function "SetOutputDataRe", provided to the user DLL to set the real part of the output data.
(Inherited from TExternalBase.)
Public methodsetProperties
Exported function "setProperties", used by Visual Signal's ExternalDll module to set property values in the user DLL.
(Inherited from TExternalBase.)
Public methodsetTitle
Exported function "setTitle()", used by Visual Signal's ExternalViewer module to set external viewer title
Public methodToString (Inherited from Object.)
Protected methodUpdateProperty
(Deprecated) 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. This is deprecated. Property values can now be updated like regular C# public properties.
(Inherited from TExternalBase.)
Protected methodUpdateViewerProperty
Virtual hook function "UpdateViewerProperty()". This function can be overridden in user's code to provide custom behaviour for updating viewer properties.
Top
Fields

  NameDescription
Protected field_autoResizeViewer
This protected member contains persistent AutoResizeViewer state which should be initialized in Init.
Protected field_backColor
This protected member contains persistent BackColor state which will be updated from Visual Signal viewer properties before DoCompute is executed.
Protected field_inputData (Inherited from TExternalBase.)
Protected field_inputTypes
This protected member contains a table of TExternalBaseDllInputType 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.)
Protected field_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.)
Protected field_properties
(Deprecated) This protected member contains a table of TExternalBaseDllProperty objects which stores the parameters used by the DLL. The table (in the form of a Dictionary) should be initialized in Init using RegisterProperty(). This is deprecated. It is no longer necessary to access property object directly. Define and access the properties like any other C# property using appropriate attributes. Properties must be public and browsable.
(Inherited from TExternalBase.)
Protected field_props
This protected member contains a table of ExtensionProperty objects which stores the parameters used by the use's DLL, it is not necessary to access this object directly. Use RegisterProperty(String, Type, Object, String, String, String, String, Int32), GetPropertyValue(String), and UpdateProperty(String, Object) functions instead to initialize, get, and set properties.
(Inherited from TExternalBase.)
Protected field_showTitle
This protected member contains persistent ShowTitle state which will be updated from Visual Signal viewer properties before DoCompute is executed.
Protected field_title
This protected member contains persistent Title state which will be updated from Visual Signal viewer properties before DoCompute is executed.
Protected field_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.
Top
Properties

  NameDescription
Public propertyAutoResizeViewer
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.
Public propertyBackColor
Get the viewer background color The value will be updated from Visual Signal viewer properties before DoCompute is executed.
Protected propertyInfoText
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.)
Protected propertyLicenseManagerID
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.)
Protected propertyLicenseName
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.)
Protected propertyMinInputCount
Set this property in Init to register the minimum number of inputs acceptable by the user DmoduleLL.
(Inherited from TExternalBase.)
Protected propertyName
Set this property in Init to register the name of the user module.
(Inherited from TExternalBase.)
Public propertyShowTitle
Get whether to show the title in the viewer. The value will be updated from Visual Signal viewer properties before DoCompute is executed.
Public propertyTitle
Get the viewer title string The value will be updated from Visual Signal viewer properties before DoCompute is executed.
Protected propertyVersion
Set this property in Init to register the version of the user module.
(Inherited from TExternalBase.)
Public propertyViewerPanel
Set the external vewer System.Windows.Forms.Panel object. This property should be set in Init.
Top
See Also

Reference