Teledyne LeCroy SierraFC Automation API - Manual (Page 3)

LeCroy Corporation SierraFC M8-4 API Reference Manual Manual Version 1.00
iii
Contents
1 Introduction........................................................................... 5
1.1 System Requirements ............................................................... 5
1.2 Support Resources ................................................................... 5
1.3 Setting Up Automation for Local Use ........................................ 5
1.4 Setting Up Automation for Remote Use ..................................... 5
2 SierraFC Protocol Analyzer Object Model ......................... 6
3 FCAnalyzer Object ............................................................... 8
3.1 IFCAnalyzer Interface ............................................................... 9
3.1.1 IFCAnalyzer::GetVersion ............................................................................................... 10
3.1.2 IFCAnalyzer::OpenFile ................................................................................................... 11
3.1.3 IFCAnalyzer::StartRecording ......................................................................................... 12
3.1.4 IFCAnalyzer::StopRecording.......................................................................................... 14
3.1.5 IFCAnalyzer::MakeRecording ........................................................................................ 15
3.1.6 IFCAnalyzer::LoadDisplayOptions ................................................................................. 17
3.1.7 IFCAnalyzer::GetRecordingOptions ............................................................................... 18
3.1.8 IFCAnalyzer::Attach ....................................................................................................... 19
3.1.9 IFCAnalyzer::Detach ...................................................................................................... 20
4 FCTrace Object ................................................................... 21
4.1 ITrace Interface ....................................................................... 22
4.1.1 ITrace::GetName ............................................................................................................ 23
4.1.2 ITrace::ApplyDisplayOptions .......................................................................................... 24
4.1.3 ITrace::Save ................................................................................................................... 25
4.1.4 ITrace::ExportToText ..................................................................................................... 26
4.1.5 ITrace::Close .................................................................................................................. 28
4.1.6 ITrace::ReportFileInfo .................................................................................................... 29
4.1.7 ITrace::ReportErrorSummary ......................................................................................... 30
4.1.8 ITrace::GetPacket .......................................................................................................... 33
4.1.9 ITrace::GetPacketsCount ............................................................................................... 36
4.1.10 ITrace::GetTriggerPacketNum ..................................................................................... 37
4.1.11 ITrace::AnalyzerErrors ................................................................................................. 38
4.2 IFCTrace Interface .................................................................. 39
4.2.1 IFCTrace::GetBusPacket ............................................................................................... 39
4.3 IFCVerificationScript Interface ................................................. 40
4.3.1 IFCVerificationScript::RunVerificationScript ................................................................... 41
4.3.2 IFCVerificationScript:: GetVScriptEngine ....................................................................... 43