Teledyne LeCroy UWBTracer Automation Manual - Manual (Page 23)

LeCroy UWBTracer Automation API Reference Manual Manual Version 3.02
19
3.2 IUwbAnalyzer2 interface
The IUwbAnalyzer2 interface is the Primary interface for the UwbAnalyzer object that gives access
to the most important functionalities of the LeCroy UWBTrainer™ analyzer.
Class ID:
5C7F6A69-7439-4248-852C-45A0A9462D4A
Prog ID: CATC.UwbAnalyzer
COM server: UWBTracer.exe
IUwbAnalyzer IID: A5C45799-261C-4b22-8D64-EFFAE592313B
3.2.1 IUwbAnalyzer2::StartGenerating
HRESULT StartGeneration ( [ in , defaultvalue ("")] BSTR gen_file_name);
Starts generating UWB traffic.
Parameters
gen_file_name UWBTrainer script file name to execute.
If this parameter is an empty string, the last executed script is repeated.
Return values
ANALYZERCOMERROR_ANALYZERNOTCONNECTED No Analyzer Connected
ANALYZERCOMERROR_UNABLESTARTGENERATION Analyzer cannot start for one of
the following reasons:
-Script has compiling error
-Analyzer is currently running or paused
-Analyzer is currently used by another client
-License for trainer device was not purchased
Remarks
This function returns after generation starts. Analyzer continues generating until it finishes or until the
StopGeneration
or Pause Generation method call is performed. During generation, the events are
sent to the event sink (see the _IAnalyzerEvents interface section).
The script file should have the file extension “.uwbg”. It can be created by either the UWBTrainer text
editor or any plain-text editor. Please note that graphic scenario files (“.ugg”) cannot be executed here.