VeeLink

Description: A Link to Agilent VEE
Library: Instruments
Class: SDFVeeLink

Parameters

Name	Description	Default	Type
HostName	The IP address or host name of the workstation that should host the remote VEE session		string
VeeLibraryName	An Agilent VEE saved program file containing User Functions		filename
BeginUserFunctionName	A User Function called once at the beginning of a simulation		string
UserFunctionName	A User Function called at each iteration of a simulation		string
WrapupUserFunctionName	A User Function called once the end of a simulation		string
TimeOut	Seconds to wait before giving up	10.0	real
DebugMode	Run Agilent VEE function in debug mode? NO, YES	NO	enum

Pin Inputs

Pin	Name	Description	Signal Type
1	VeeFunctionArguments		multiple anytype

Pin Outputs

Pin	Name	Description	Signal Type
2	VeeFunctionResults		multiple anytype

Notes/Equations

Note This item is for use on Win32 platforms only.

1. The VeeLink component enables you to use VEE UserFunctions as if these were integral parts of your Ptolemy simulation.
   Agilent VEE for Windows is a powerful graphical programming environment for fast measurement analysis results; for information, visit the website http://www.agilent.com/find/vee.
2. Invoke an Agilent VEE function by using the Callable VEE C- language library. Invoking an Agilent VEE function in this manner requires that the Agilent VEE development environment has been installed. Additionally, you must start the Agilent VEE Service Manager.
3. An Agilent Vee Library is a saved program file containing User Functions.
   The HostName parameter specifies which workstation (the remote host) actually is running the Vee User Function. If HostName is blank (default) the function runs on the same workstation as the one that initiated the simulation. The remote host must have Agilent Vee Pro installed.
   For a User Function to run on a workstation other than the one on which you initiated the simulation, the remote host must have the Vee Service Manager running. Unlike the Agilent Vee Pro software (a licensed product), you can install the Agilent Vee Service on any workstation. The Vee Service is installed as an optional part of the Connection Manager Server installation. Installing the Vee Service does not require that you install the Connection Manager Server.
   The Vee Service installation places a Windows Control Panel applet in the target PC Windows installation directory system32 sub-directory.
   A Vee Library is a saved Vee program file that contains UserFunctions. Vee programs typically have .vee or .vxe extensions. You can set the VeeLibraryName parameter to specify the path to the Vee Library using relative or absolute paths.
   • If you specify an absolute path (a path that contains a file separator character \ or / ) Vee loads a library from the specified location only.
   • If you specify a relative path (a path that does not contain a file path separator), VeeLink looks first in the project data directory, then in the directory specified in the registry key.
     _ HKEY_LOCAL_MACHINE\Software\Agilent\<latest>\UserDir_
     where <latest> is the highest-numbered version of Vee Pro installed on the server PC.

     Note The VeeLibraryName parameter must contain a file name complete with the extension, for example rz.vee.

4. The BeginUserFunctionName parameter identifies a UserFunction to be called once per VeeLink component at the start of a simulation run. You might use this to set instruments to a reset state before doing any other setup. If you leave this parameter empty, the VeeLink start just continues on without trying to call a VEE function at simulation start time.
5. The UserFunctionName parameter specifies the name of a User Function within the library; this function is called at each iteration of the simulation.
   It is legal to have User Functions of the same name in different libraries.
   Also, the UserFunctionName parameter can remain blank. For example, leave this parameter blank if you want something to happen at the beginning and/or end of a simulation but not at each iteration of the simulation.
6. The WrapupUserFunctionName parameter identifies a UserFunction to be called once at the end of a simulation (if the simulation has not stopped with an exception). For example, use this function to set instruments to a known state before initiating another simulation run.
7. The TimeOut parameter specifies the length of time (in seconds) the VeeLink component waits before determining that the VEE UserFunction can not complete. A TimeOut value of zero means the VeeLink component waits indefinitely for the UserFunction to complete.
   Common reasons a UserFunction can not complete in the expected time include:
   • An instrument is set to trigger on a hardware signal that never arrives.
   • A UserFunction contains an interactive control that you never interact with, possibly because the control is not contained in a Vee panel (a presentation view of the function) and therefore, is not visible.
   • A UserFunction contains an interactive control that you never interact with, possibly because the Vee Service Manager is not set up to enable interactive VEE Server sessions.
8. DebugMode = YES enables you to run the Agilent VEE process hosting your function in a mode that enables you to use Agilent VEE development environment debugging tools.

   Note For interactive debugging to work, the Agilent VEE Service Manager must be configured so that the service process can interact with the desktop. See Who Does It Run As?.

9. This component has been tested with VEE Pro 6.0, 6.1, 6.2, 7.0, and 7.5x.