Document Outline

• Automation API
• For PETracer/Trainer Software Version 7.x
• Document Disclaimer
• Trademarks and Servicemarks
• Copyright
• Table of Contents
• 1 Introduction
  • 1.1 System Requirements
  • 1.2 Support Resources
  • 1.3 Setting Up Automation for Local Use
  • 1.4 Setting Up Automation for Remote Use
• 2 PETracer Object Model
• A single object occupies the topmost tier of Teledyne LeCroy PETracer object hierarchy: PEAnalyzer.
• The Class ID and App ID for the PEAnalyzer object are the following.
• Class ID: 297CD804-08F5-4A4F-B3BA-779B2654B27C
• All objects implement ISupportErrorInfo interface for easy error handling from the client.
• Appropriate wrapper classes are created in .tli and .tlh files by the compiler.
• Samples of WSH, VBScript, and C++ client applications are provided.
• 3 PEAnalyzer Object
• The PEAnalyzer object is a top-level object of PETracer™ API.
• The IPEAnalyzer3 interface is a primary interface for the PEAnalyzer object.
• The Class ID and App ID for the PEAnalyzer object are the following.
• Class ID: 297CD804-08F5-4A4F-B3BA-779B2654B27C
• Example
• WSH:
• Set Analyzer = WScript.CreateObject( “CATC.PETracer” )
• C++:
• IPEAnalyzer* poPEAnalyzer;
  • 3.1 IAnalyzer interface
• The IAnalyzer interface is a dual interface for the PEAnalyzer object.
  • 3.1.1 IAnalyzer::GetVersion
• Retrieves the current version of a specified subsystem.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 3.1.2 IAnalyzer::OpenFile
• Opens a trace file, and creates the PETrace object.
• Parameters
• Return values
• Remarks
• PETrace object is created via this method call, if the call was successful.
• Example
• WSH:
• C++:
  • 3.1.3 IAnalyzer::StartGeneration
• Starts traffic generation from the file.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 3.1.4 IAnalyzer::StopGeneration
• Stops any current generation in progress.
• Return values
• Remarks
• Example
• C++:
• IPEAnalyzer* poAnalyzer;
  • 3.1.5 IAnalyzer::StartRecording
• Starts recording with the specified recording options.
• Parameters
• Return values
• Remarks
• Example
• Sub BtnStartRecording_OnClick
• C++:
  • 3.1.6 IAnalyzer::StopRecording
• Stops recording started by the IAnalyzer::StartRecording (see Page 10) method.
• Parameters
• Return values
• Remarks
• Example
• Sub BtnStopRecording_OnClick
• C++:
• IPEAnalyzer* pe_analyzer;
  • 3.1.7 IAnalyzer::MakeRecording
• Makes recording with the specified recording options file.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 3.1.8 IAnalyzer::LoadDisplayOptions
• Loads display options that apply to a trace opened or recorded later.
• Parameters
• Return values
• Remarks
• Example
• See ITrace::ApplyDisplayOptions, Page 27.
  • 3.1.9 IAnalyzer::GetRecordingOptions
• Retrieves the interface for access to the recording options.
• Parameters
• Return values
• Remarks
• PERecOptions object is created via this method call, if the call was successful.
• Example
• WSH:
• C++:
  • 3.1.10 IAnalyzer::GetSerialNumber
• Returns analyzer's serial number.
• Parameters
• Return values
• Remarks
• Example
  • 3.2 IPEAnalyzer interface
• The IPEAnalyzer interface is a dual interface for the PEAnalyzer object.
• This interface is derived from the IAnalyzer interface.
  • 3.2.1 IPEAnalyzer::GetGenerationOptions
• Retrieves the interface for access to the generation options.
• Parameters
• Return values
• Remarks
• PEGenOptions object is created via this method call, if the call was successful.
• Example
• WSH:
• C++:
  • 3.2.2 IPEAnalyzer::ResumeGeneration
• Resumes generation if it was previously paused.
• Return values
• Remarks
• Example
• C++:
• IPEAnalyzer* poAnalyzer;
  • 3.2.3 IPEAnalyzer::GetLinkStatus
• Returns two text strings with the link and flow control status.
• Parameters
• Return values
• Remarks
• Example
• C++:
• IPEAnalyzer* poAnalyzer;
• USES_CONVERSION;
• SysFreeString( link_status );
  • 3.3 IPEAnalyzer2 interface
• The IPEAnalyzer2 interface is a dual interface for the PEAnalyzer object.
• This interface is derived from the IPEAnalyzer interface.
  • 3.3.1 IPEAnalyzer2::GetHardwareInfo
• Returns information about the hardware (PETracer/PETrainer™) connected.
• Parameters
• Return values
• Remarks
• Example
  • 3.3.2 IPEAnalyzer2::ResetHardware
• Resets the hardware specified.
• Parameters
• Remarks
• Example
• C++:
• IPEAnalyzer2* poAnalyzer;
  • 3.4 IPEAnalyzer3 interface
• The IPEAnalyzer3 interface is a primary dual interface for the PEAnalyzer object.
• This interface is derived from the IPEAnalyzer2 interface.
  • 3.4.1 IPEAnalyzer3::StartImportFile
• Begins process of importing specified file into a trace file.
• Parameters
• Return values
• Remarks
• Example
• C++:
• IPEAnalyzer3* poAnalyzer;
• 4 PETrace Object
• PETrace object represents the recorded trace file.
• The IPETrace interface is a primary interface for the PETrace object.
  • 4.1 ITrace interface
• The ITrace interface is a dual interface for the PETrace object.
• Note: All methods of ITrace interface are also available in IPETrace (see Page 41).
  • 4.1.1 ITrace::GetName
• Retrieves the trace name.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
• IPETrace* pe_trace;
  • 4.1.2 ITrace::ApplyDisplayOptions
• Applies the specified display options to the trace.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 4.1.3 ITrace::Save
• Saves trace into a file while allowing you to specify a range of packets.
• Parameters
• Remarks
• Example
• C++:
  • 4.1.4 ITrace::ExportToText
• Exports the trace into a text file while allowing you to specify a range of packets.
• Parameters
• Return values
• Remarks
• Packet#
• _______| CompleterID(000:07:2) Status(UR)-BAD BCM(1) Byte Cnt(2618)-BAD
• Packet(1887) Downstream TS2 COM(K28.5 ) Link Lane N_FTS
• Packet(1889) Downstream TS2 COM(K28.5 ) Link Lane N_FTS
• Example
• WSH:
• C++:
  • 4.1.5 ITrace::Close
• Closes the trace.
• Parameters
• Return values
• Remarks
• Example
  • 4.1.6 ITrace::ReportFileInfo
• Saves trace information into a specified HTML file.
• Parameters
• Return values
• Remarks
• Creates a new trace information file if the file specified in the file_name parameter does not exist.
• Example
• WSH:
• C++:
  • 4.1.7 ITrace::ReportErrorSummary
• Saves trace error summary information into the specified text file.
• Parameters
• Return values
• Remarks
• This method doesn’t work on Multisegment traces.
• Error report for ErrorFinding_loop.pex recording file.
• Example
• WSH:
• C++:
  • 4.1.8 ITrace::GetPacket
• Parameters
• Return values
• Remarks
• Example
• Sub BtnGetPacket_OnClick
• C++:
• SAFEARRAY* packet_safearray = packet.parray;
  • 4.1.9 ITrace::GetPacketsCount
• Retrieves the total number of packets in the trace.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
• IPETrace* pe_trace;
  • 4.1.10 ITrace::GetTriggerPacketNum
• Retrieves the trigger packet number.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
• See an example for ITrace::GetPacketsCount, Page 37.
  • 4.1.11 ITrace::AnalyzerErrors
• Retrieves trace file errors. Returns an interface pointer to the PETraceErrors object.
• Parameters
• Return values
• Remarks
• PETraceErrors object is created via this method call if the call was successful.
• Example
• WSH:
• C++:
• IPETrace* pe_trace;
  • 4.2 IPETrace interface
• The IPETrace interface is a primary dual interface for the PETrace object.
• This interface is derived from the ITrace interface.
  • 4.2.1 IPETrace::GetBusPacket
• Retrieves the interface for a packet within a trace.
• Parameters
• Return values
• Remarks
• PEPacket object is created via this method call if the call was successful.
• Example
• WSH:
• C++:
• IPETrace* pe_trace;
  • 4.3 IPEVerificationScript interface
• Remarks
• Attention:
  • 4.3.1 IPEVerificationScript::RunVerificationScript
• Runs a verification script over the recorded trace
• Parameters
• Return values
• Remarks
• Example
• Example
• C++:
• IPEVerificationScript* vscript = NULL;
• WSH:
• Dim Result
• If Result = 1 Then
• Else
• MsgBox( "Done" )
  • 4.3.2 IPEVerificationScript::GetVScriptEngine
• Retrieves the verification script engine object
• Parameters
• Return values
• Remarks
• Example
• C++:
• IPETrace* pe_trace;
• IPEVerificationScript* pe_vscript = NULL;
• WSH:
• Dim Result
• If Result = 1 Then
• Else
• 5 PERecOptions Object
• The IPERecOptions2 interface is a primary interface for PERecOptions object.
  • 5.1 IRecOptions interface
• The IRecOptions interface is a dual interface for PERecOptions object.
  • 5.1.1 IRecOptions::Load
• Loads recording options from the specified file. The load options are:
•  Loads the whole Recording Options (.rec)
•  Loads only the Recording Rules portions of the recording options (.rr)
•  Loads only the Probe Settings portions of the recording options (.ps). This option only applies to the Summit T3-16, T3-8, T28 and T24 Protocol Analyzers.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 5.1.2 IRecOptions::Save
• Saves recording options into the specified file. The Save options are:
•  Saves the whole Recording Options (.rec)
•  Saves only the Recording Rules portions of the recording options (.rr)
•  Saves only the Probe Settings portions of the recording options (.ps). This option only applies to the Summit T3-16, T3-8, T28 and T24 Protocol Analyzers.
• Parameters
• Return values
• Remarks
• If the specified file does not exist, it is created; if it exists, it is overwritten.
• Example
• WSH:
• C++:
  • 5.1.3 IRecOptions::SetRecMode
• Sets the recording mode.
• Parameters
• Return values
• Remarks
• The default setting of recording options is a “snapshot” recording mode.
• Example
• WSH:
• C++:
  • 5.1.4 IRecOptions::SetBufferSize
• Sets the size of buffer to record.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 5.1.5 IRecOptions::SetPostTriggerPercentage
• Sets the post trigger buffer size.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 5.1.6 IRecOptions::SetTriggerBeep
• Sets a flag to make a sound when a trigger occurs.
• Parameters
• Return values
• Remarks
• The default state of the beeper is FALSE.
• Example
• WSH:
• C++:
  • 5.1.7 IRecOptions::SetSaveExternalSignals
• Sets a flag to save external signals.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 5.1.8 IRecOptions::SetTraceFileName
• Sets the file path to where the trace is stored after recording.
• Parameters
• Return values
• Remarks
• If the specified file does not exist, it is created; if it exists, it is overwritten.
• Example
• WSH:
• C++:
  • 5.1.9 IRecOptions::Reset
• Resets the recording options to the initial state.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• RecOptions.Reset
• C++:
  • 5.2 IPERecOptions interface
• This interface is identical to the IRecOptions interface (see Page 48).
  • 5.3 IPERecOptions2 interface
• The IPERecOptions2 interface is a primary dual interface for the PERecOptions object.
• This interface is derived from the IPERecOptions interface.
  • 5.3.1 IPERecOptions2::SetTargetAnalyzer
• Sets the hardware configuration for the recording options.
• Parameters
  • 5.3.2 IPERecOptions2::SetLinkWidth
• Sets the link width.
• Parameters
  • 5.3.3 IPERecOptions2::SetBase10Spec
• Sets PCI Express Base Specification 1.0 compatibility mode.
• Parameters
• Remarks
• Implemented for PETracer ML and PETracer EML. Not implemented for PETracer x1.
  • 5.3.4 IPERecOptions2::SetExternalRefClock
• Specifies whether to use the external or internal reference clock
• Parameters
  • 5.3.5 IPERecOptions2::SetDisableDescrambling
• Disables/enables descrambling of incoming traffic.
• Parameters
• Remarks
• Implemented for PETracer ML and PETracer EML. Not implemented for PETracer x1.
  • 5.3.6 IPERecOptions2::SetDisableDeskew
• Disables/enables deskew of incoming traffic.
• Parameters:
• Remarks
• Implemented for PETracer ML and PETracer EML. Not implemented for PETracer x1.
  • 5.3.7 IPERecOptions2::SetAutoConfigPolarity
• Enables/disables automatic polarity detection.
• Parameters:
• Remarks
• Implemented for PETracer ML and PETracer EML. Not implemented for PETracer x1.
  • 5.3.8 IPERecOptions2::SetInhibit
• Inhibits one of the traffic directions.
• Parameters:
• Remarks
• Implemented for PETracer ML and PETracer EML. Not implemented for PETracer x1.
  • 5.3.9 IPERecOptions2::SetReverseLanes
• Allows lane reversal on the specified traffic direction.
• Parameters:
• Remarks
• Implemented for PETracer ML and PETracer EML. Not implemented for PETracer x1.
  • 5.3.10 IPERecOptions2::SetInvertPolarity
• Allows polarity inversion of the specified lane and specified traffic direction.
• Parameters:
• Remarks
  • 5.4 IPERecOptions3 interface
• The IPERecOptions3 interface is a primary dual interface for the PERecOptions object.
• This interface is derived from the IPERecOptions interface.
  • 5.4.1 IPERecOptions3::SetLinkSpeed
• Parameters:
  • 5.4.2 IPERecOptions3::GetSimpleTrigger
• Parameters:
• Return values
• Remarks
• Example
  • 5.4.3 IPERecOptions3::GetSimpleFilter
• Returns simple filter interface of the given filter type.
• Parameters:
• Return values
• SimpleFilter object
• Remarks
• Example
  • 5.4.4 IPERecOptions3:: RestoreDefaultFactorySettings
• Restores factory default settings.
• Parameters:
• Return values
• SimpleFilter object
• Remarks
• Example
  • 5.5 SimpleTrigger
    • 5.5.1 SimpleTrigger::SetEnabled
• Puts the trigger into enabled or disabled state.
  • 5.5.2 SimpleTrigger::IsEnabled
  • Retrieves trigger's state.
  • 5.5.3 SimpleTrigger::SetDirection
• Sets the trigger's direction.
• Parameters:
• e_dir - enum that can have following values:
• DIRECTION_UPSTREAM ( 0 )
• DIRECTION_DOWNSTREAM ( 1 )
• DIRECTION_BOTH ( 2 )
• DIRECTION_NONE ( 4 )
• Example
  • 5.5.4 SimpleTrigger::GetDirection
• Gets the trigger's direction.
  • 5.6 SimpleFilter
• SimpleFilter allows enabling /disabling the filter and setting data stream direction..
  • 5.6.1 SimpleFilter::SetEnabled
• Puts the filter into enabled or disabled state.
  • 5.6.2 SimpleFilter::IsEnabled
  • Retrieves filter's state.
  • 5.6.3 SimpleFilter::SetDirection
• Sets the filter's direction.
• Parameters:
• e_dir - enum that can have following values:
• DIRECTION_UPSTREAM ( 0 )
• DIRECTION_DOWNSTREAM ( 1 )
• DIRECTION_BOTH ( 2 )
• DIRECTION_NONE ( 4 )
• Example
  • 5.6.4 SimpleFilter::GetDirection
• Gets the filter's direction.
• 6 PEGenOptions Object
• The IPERecOptions2 interface is a primary interface for PERecOptions object.
  • 6.1 IGenOptions interface
• The IgenOptions interface is a dual interface for the PEGenOptions object.
  • 6.1.1 IGenOptions::Load
• Loads generation options from the specified file.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 6.1.2 IGenOptions::Save
• Saves generation options into the specified file.
• Parameters
• Return values
• Remarks
• If the specified file does not exist, it is created; if it exists, it is overwritten.
• Example
• WSH:
• C++:
  • 6.1.3 IGenOptions::Reset
• Resets the generation options to its initial state.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 6.2 IPEGenOptions interface
• This interface is identical to the IGenOptions interface (see Page 69).
  • 6.3 IPEGenOptions2 interface
• The IPEGenOptions2 interface is a primary dual interface for the PEGenOptions object.
• This interface is derived from the IPEGenOptions interface.
  • 6.3.1 IPEGenOptions2::SetTargetGenerator
• Sets the hardware configuration for the generation options.
• Parameters:
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 6.3.2 IPEGenOptions2::SetWorkAsRoot
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 6.3.3 IPEGenOptions2::SetLinkWidth
• Sets the link width.
• Parameters:
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 6.3.4 IPEGenOptions2::SetBase10Spec
• Sets the PCI Express Base Specification 1.0 compatibility mode.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 6.3.5 IPEGenOptions2::SetExternalRefClock
• Specifies whether to use the external or the internal reference clock
• Parameters
• Remarks
• Implemented for PETrainer ML. Not implemented for PETrainer EML.
  • 6.3.6 IPEGenOptions2::SetDisableDescrambling
• Disables/enables descrambling of incoming traffic.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 6.3.7 IPEGenOptions2::SetDisableScrambling
• Disables/enables scrambling of outgoing traffic.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 6.3.8 IPEGenOptions2::SetAutoConfig
• Enables/disables automatic link configuration detection.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 6.3.9 IPEGenOptions2::SetReverseLanes
• Allows lane reversal in the specified traffic direction.
• Parameters:
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 6.3.10 IPEGenOptions2::SetInvertPolarity
• Allows polarity inversion on the specified lane and specified traffic direction.
• Parameters:
• Return values
• Remarks
• Example
• WSH:
• For i = 1 To 4
• C++:
  • 6.3.11 IPEGenOptions2::SetSkew
• Allows skew values to be set for each lane of outgoing traffic.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
• 7 PEPacket Object
• The PEPacket object represents a single packet of the recorded trace file.
• The PEPacket object can be created by calling IPETrace::GetBusPacket method (See Page 41)
  • 7.1 IPacket interface
• The IPacket interface is a dual interface for PEPacket object.
• Note: All methods of the IPacket interface are also available in the IPEPacket interface (see Page 57).
  • 7.1.1 IPacket::GetTimestamp
• Returns the packet timestamp in nanoseconds.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 7.2 IPEPacket interface
• The IPEPacket interface is a primary dual interface for the PEPacket object.
• This interface is derived from the IPacket interface.
  • 7.2.1 IPEPacket::GetPacketData
• Retrieves a raw packet representation.
• Parameters
• Return values
• Remarks
• Example
• ID = Analyzer
• While Param > 0
• Else
• DecToBin = Replace( Space(NeedLen - Len(Res)), " ", "0") & Res
• Sub BtnGetPacket_OnClick
• If Err.Number <> 0 Then
• Else
• NumberOfUnits = Packet.GetPacketData ( PACKETFORMAT_BYTES, PacketData)
• If Err.Number <> 0 Then
• For Each PacketByte In PacketData
• NBytes = NBytes + 1
• End If
• End Sub
• C++:
• SAFEARRAY* packet_safearray = packet_data.parray;
  • 7.2.2 IPEPacket::GetLinkWidth
• Returns link width for this packet.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 7.2.3 IPEPacket::GetStartLane
• Returns start lane for this packet.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 7.2.4 IPEPacket::GetLFSR
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 7.2.5 IPEPacket::GetDirection
• Returns direction (upstream/downstream) of this packet.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
  • 7.2.6 IPEPacket::GetErrors
• Returns an array of errors present in this packet.
• Parameters
• Return values
• Remarks
• Example
• WSH:
• C++:
• 8 PETraceErrors Object
• The PETraceErrors object represents the collection of errors that occurred in the recorded trace file.
• The PETraceErrors object can be created by calling ITrace::AnalyzerErrors method (see Page 45).
• The IAnalyzerErrors interface is a primary interface for the PETraceErrors object.
  • 8.1 IAnalyzerErrors dispinterface
    • 8.1.1 IAnalyzerErrors::get_Item
• Returns a zero based packet number from error collection
• Parameters
  • 8.1.2 IAnalyzerErrors::get_Count
• Returns the number of errors in the trace.
• Parameters
• Remarks
• Example
• WSH:
• ' where "Running Disparity" errors occured
• Set Errors = Trace.AnalyzerErrors( 32 ) ' Running Disparity Error
• ErrorFile = CurrentDir & "\Output\PckLen_error_span_" &
• C++:
• IPETrace* pe_trace;
• 9 PEVScriptEngine Object
• The IVScriptEngine interface is a primary interface for PEVScriptEngine object.
• Remarks
  • 9.1 IVScriptEngine interface
• The IVScriptEngine interface is the primary dual interface for the PEVScriptEngine object.
  • 9.1.1 IVScriptEngine::VScriptName
• Property putting and getting current verification script name.
• Parameters
• Return values
• Remarks
• Example
• C++:
• IPETrace* pe_trace;
• IPEVerificationScript* pe_vscript = NULL;
  • 9.1.2 IVScriptEngine::Tag
• Parameters
• Return values
• Remarks
• Example
• C++:
• IPETrace* pe_trace;
• IPEVerificationScript* pe_vscript = NULL;
  • 9.1.3 IVScriptEngine::RunVScript
• Runs the verification script currently specified for this engine.
• Parameters
• Return values
• Remarks
• Example
• See C++ example to IVScriptEngine::VScriptName, Page 101.
  • 9.1.4 IVScriptEngine::RunVScriptEx
• Changes the current verification script name and runs verification script .
• Parameters
• Return values
• Remarks
• Example
• C++:
• IPETrace* pe_trace;
• IPEVerificationScript* pe_vscript = NULL;
  • 9.1.5 IVScriptEngine::LaunchVScript
• Launches verification script.
• Return values
• Remarks
• Example
• C++:
• IPETrace* pe_trace;
• IPEVerificationScript* pe_vscript = NULL;
• VS_RESULT result = pe_vsengine ->LaunchVScript();
  • 9.1.6 IVScriptEngine::Stop
• Parameters
• Return values
• Remarks
• Example
• C++:
• IPETrace* pe_trace;
• IPEVerificationScript* pe_vscript = NULL;
  • 9.1.7 IVScriptEngine::GetScriptVar
• Parameters
• Return values
• Remarks
• Example
• C++:
• IPETrace* pe_trace;
• IPEVerificationScript* pe_vscript = NULL;
• WSH:
• Result = VSEngine.RunVScript
• MsgBox " MyIntVar = " & CStr(MyIntVar) & ", MyStrVar = " & MyStrVar
  • 9.1.8 IVScriptEngine::SetScriptVar
• Parameters
• Return values
• Remarks
• Example
• C++:
• IPETrace* pe_trace;
• IPEVerificationScript* pe_vscript = NULL;
• WSH:
• 10 PEVScriptEngine Object Events
  • 10.1 _IVScriptEngineEvents interface
• Example
• C++:
• END_SINK_MAP()
• HRESULT __stdcall OnVScriptReportUpdated ( BSTR newLine, int TAG );
• HRESULT __stdcall OnVScriptFinished( BSTR script_name, VS_RESULT result, int TAG );
• HRESULT __stdcall OnNotifyClient ( int eventId, VARIANT eventBody, int TAG );
• IVScriptEngine vscript_engine = NULL;
• VBA: ( MS Excel )
• Public PETracer As PeAnalyzer
• Dim X As New VSEngineEventsModule...
• ScriptName = ThisWorkbook.Sheets("Sheet1").Cells(2, 2)
• If PETracer Is Nothing Then
• If PETracer Is Nothing Then
• Set X.VSEEvents = VSEngine
• Set X.VSEEvents = Nothing ' "Unsubscribe" for receiving VSE events
  • 10.1.1 _IVScriptEngineEvents::OnVScriptReportUpdated
• Parameters
• Return values
• Remarks
• Make sure that C++ event handlers have __stdcall calling convention.
• Example
• C++:
• Public WithEvents VSEEvents As VScriptEngine
• Private Sub VSEEvents_OnVScriptReportUpdated(ByVal newLine As String, ByVal Tag As Long)
• ThisWorkbook.Sheets("Sheet1").Cells(LineIndex, 1) = newLine
• End Sub
  • 10.1.2 _IVScriptEngineEvents::OnVScriptFinished
• Fired when the verification script stops running.
• Parameters
• Return values
• Remarks
• Make sure that C++ event handlers have __stdcall calling convention.
• Example
• C++:
• HRESULT __stdcall CComplTestSink::OnVScriptFinished(
• USES_CONVERSION;
• Public WithEvents VSEEvents As VScriptEngine
• Dim ResString As String
• ThisWorkbook.Sheets("Sheet1").Cells(7, 2) = ResString
  • 10.1.3 _IVScriptEngineEvents::OnNotifyClient
• Fired when running a verification script, calls the NotifyClient() function.
• Parameters
• Return values
• Remarks
• Example
• ThisWorkbook.Sheets("Sheet1").Cells(LineIndex, 1) = eventId
• If IsArray(eventBody) Then
• For Each Item In eventBody
• LineIndex = LineIndex + 1
• 11 PEAnalyzer Object Events
  • 11.1 _IAnalyzerEvents dispinterface
• END_SINK_MAP()
  • 11.1.1 _IAnalyzerEvents::OnTraceCreated
• Parameters
• Remarks
• Make sure the event handlers have __stdcall calling convention.
• Example
• Dim CurrentTrace
• C++:
  • 11.1.2 _IAnalyzerEvents::OnStatusReport
• Parameters
• Return values
• Remarks
• Make sure the event handlers have __stdcall calling convention.
• Example
• Dim RecordingStatus
• End Sub
• C++:
• 12 CATCAnalyzerAdapter
• The Class ID and App ID for PEAnalyzer object are the following.
• Class ID: A0CB5386-38BA-4970-8782-3D1B707C3E5F
  • 12.1 IAnalyzerAdapter Interface
    • 12.1.1 IAnalyzerAdapter::CreateObject
• Parameters
• Return values
• Remarks
• Example
• Sub BtnConnect_onclick
• Set Analyzer = AnalyzerAdapter.CreateObject("CATC.PETracer", RemoteServer.value )
• WSH:
• RemoteServer = "EVEREST"
  • 12.1.2 IAnalyzerAdapter::Attach
• This method attaches the LeCroy analyzer object to the adapter.
• Parameters
• Return values
• Remarks
• Example
• Sub BtnConnect_onclick
• WSH:
• 'VBScript functioncreates object locally
• AnalyzerAdapter.Attach Analyzer ' Attach analyzer object to the adapter
  • 12.1.3 IAnalyzerAdapter::Detach
• This method detaches the LeCroy analyzer object from the adapter.
• Parameters
• Return values
• Remarks
• Example
• Sub BtnConnect_onclick
• Set Analyzer = AnalyzerAdapter.CreateObject("CATC.PETracer", RemoteServer.value )
• Sub BtnDisconnect_OnClick
• WSH:
• RemoteServer = "EVEREST"
  • 12.1.4 IAnalyzerAdapter::IsValidObject
• This method helps to determine whether some automation object can be attached to the adapter.
• Parameters
• Return values
• Remarks
• Only LeCroy analyzer COM servers can be attached to the adapter.
• Example
• Sub BtnConnect_onclick
• 'Launch MS Excel instead of PETracer !!!
• If Not AnalyzerAdapter.IsValidObject( Analyzer ) Then
• 13 Teledyne LeCroy Internal Interfaces
• How to Contact Teledyne LeCroy