Manual

Teledyne LeCroy Automation API for PETracer/PETrainer
iii
Table of Contents
1 Introduction .......................................................................................................................................... 1
1.1 System Requirements .................................................................................................................... 1
1.2 Support Resources ......................................................................................................................... 1
1.3 Setting Up Automation for Local Use ............................................................................................. 1
1.4 Setting Up Automation for Remote Use ......................................................................................... 1
2 PETracer Object Model........................................................................................................................ 2
3 PEAnalyzer Object ............................................................................................................................... 4
3.1 IAnalyzer interface .......................................................................................................................... 5
3.1.1 IAnalyzer::GetVersion ............................................................................................................. 6
3.1.2 IAnalyzer::OpenFile ................................................................................................................. 7
3.1.3 IAnalyzer::StartGeneration ...................................................................................................... 8
3.1.4 IAnalyzer::StopGeneration ...................................................................................................... 9
3.1.5 IAnalyzer::StartRecording ..................................................................................................... 10
3.1.6 IAnalyzer::StopRecording ...................................................................................................... 12
3.1.7 IAnalyzer::MakeRecording .................................................................................................... 13
3.1.8 IAnalyzer::LoadDisplayOptions ............................................................................................. 14
3.1.9 IAnalyzer::GetRecordingOptions ........................................................................................... 15
3.1.10 IAnalyzer::GetSerialNumber .................................................................................................. 16
3.2 IPEAnalyzer interface ................................................................................................................... 17
3.2.1 IPEAnalyzer::GetGenerationOptions .................................................................................... 18
3.2.2 IPEAnalyzer::ResumeGeneration ......................................................................................... 19
3.2.3 IPEAnalyzer::GetLinkStatus .................................................................................................. 20
3.3 IPEAnalyzer2 interface ................................................................................................................. 21
3.3.1 IPEAnalyzer2::GetHardwareInfo ........................................................................................... 22
3.3.2 IPEAnalyzer2::ResetHardware .............................................................................................. 24
3.4 IPEAnalyzer3 interface ................................................................................................................. 25
3.4.1 IPEAnalyzer3::StartImportFile ............................................................................................... 26
4 PETrace Object .................................................................................................................................. 27
4.1 ITrace interface ............................................................................................................................. 28
4.1.1 ITrace::GetName ................................................................................................................... 29
4.1.2 ITrace::ApplyDisplayOptions ................................................................................................. 30
4.1.3 ITrace::Save .......................................................................................................................... 31
4.1.4 ITrace::ExportToText ............................................................................................................. 32
4.1.5 ITrace::Close ......................................................................................................................... 35
4.1.6 ITrace::ReportFileInfo ............................................................................................................ 36
4.1.7 ITrace::ReportErrorSummary ................................................................................................ 37
4.1.8 ITrace::GetPacket ................................................................................................................. 40
4.1.9 ITrace::GetPacketsCount ...................................................................................................... 43
4.1.10 ITrace::GetTriggerPacketNum .............................................................................................. 44
4.1.11 ITrace::AnalyzerErrors .......................................................................................................... 45
4.2 IPETrace interface ........................................................................................................................ 47
4.2.1 IPETrace::GetBusPacket ...................................................................................................... 47
4.3 IPEVerificationScript interface ...................................................................................................... 48
4.3.1 IPEVerificationScript::RunVerificationScript .......................................................................... 49
4.3.2 IPEVerificationScript::GetVScriptEngine ............................................................................... 51
5 PERecOptions Object ........................................................................................................................ 53
5.1 IRecOptions interface ................................................................................................................... 54
5.1.1 IRecOptions::Load ................................................................................................................. 54
5.1.2 IRecOptions::Save ................................................................................................................ 55
5.1.3 IRecOptions::SetRecMode .................................................................................................... 56
5.1.4 IRecOptions::SetBufferSize ................................................................................................... 57