IExternalViewer Interface

Visual Signal ExternalBase Class Library Documentation

API version 1.5.2

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

IExternalViewer - Interface of externally visible functions provided by external user viewers. All functions exported in the interface are used by Visual Signal's ExternalDll module to communicate with and control the execution of the user DLL. Default implementations will be provided in TExternalViewer, which can be inherited to provide custom behaviour.

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

Syntax

C++

Copy

public interface IExternalViewer : IExternalDll

Public Interface IExternalViewer
	Inherits IExternalDll

public interface class IExternalViewer : IExternalDll

type IExternalViewer =  
    interface
        interface IExternalDll
    end

The IExternalViewer type exposes the following members.

Methods

	Name	Description
	compute	Interface for exported function "compute", used by Visual Signal's ExternalDll module to execute the actual computation provided by the user DLL. (Inherited from IExternalDll.)
	getDllInfo	Interface for exported function "getDllInfo()", used by Visual Signal's ExternalDll module to obtain DLL info such as name, version, API version, language, and properties. (Inherited from IExternalDll.)
	getOutputCoordinates	Interface for exported function "getOutputCoordinates", used by Visual Signal's ExternalDll module to obtain the output data coordinates from the user DLL. (Inherited from IExternalDll.)
	getOutputDataIm	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 IExternalDll.)
	getOutputDataRe	Interface for exported function "getOutputDataRe", used by Visual Signal's ExternalDll module to obtain the output data (real part) from the user DLL. (Inherited from IExternalDll.)
	getOutputDescriptor	Interface for exported function "getOutputDescriptor", used by Visual Signal's ExternalDll module to obtain output descriptor from the user DLL. (Inherited from IExternalDll.)
	getProperties	Interface for exported function "getProperties", used by Visual Signal's ExternalDll module to obtain property values from the user DLL. (Inherited from IExternalDll.)
	getViewerPanel	Exported function "getViewerPanel()", used by Visual Signal's ExternalViewer module to obtain external viewer object created by the user DLL
	setBackColor	Exported function "setBackColor()", used by Visual Signal's ExternalViewer module to set external viewer background color
	setInputCoordinates	Interface for exported function "setInputCoordinates", used by Visual Signal's ExternalDll module to set input coordinates in the user DLL. (Inherited from IExternalDll.)
	setInputDataIm	Interface for exported function "setInputDataIm", used by Visual Signal's ExternalDll module to set the input data (imaginary part) in the user DLL. (Inherited from IExternalDll.)
	setInputDataRe	Interface for exported function "setInputDataRe", used by Visual Signal's ExternalDll module to set the input data (real part) in the user DLL. (Inherited from IExternalDll.)
	setInputDescriptors	Interface for exported function "setInputDescriptors", used by Visual Signal's ExternalDll module to set input descriptors in the user DLL. (Inherited from IExternalDll.)
	setProperties	Interface for exported function "setProperties", used by Visual Signal's ExternalDll module to set property values in the user DLL. (Inherited from IExternalDll.)
	setTitle	Exported function "setTitle()", used by Visual Signal's ExternalViewer module to set external viewer title

Top

Reference

VSignal.ExternalBase Namespace