Teledyne LeCroy FireInspector Automation Application Programming Interface - Manual (Page 3)

iii
FireInspector Automation User’s Manual CATC Version 1.0
T
ABLE OF
C
ONTENTS
Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
Chapter 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Setting Up Automation for Local Use . . . . . . . . . . . . . . . . . . . . . . 1
Setting Up Automation for Remote Use. . . . . . . . . . . . . . . . . . . . . 2
Chapter 2 FireInspector Automation API . . . . . . . . . . . . . . . . . . 3
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Command Descriptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Primary Dual Interface for Analyzer . . . . . . . . . . . . . . . . . . . . . . . 5
IAnalyzer::GetVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
IAnalyzer::GetSerialNumber . . . . . . . . . . . . . . . . . . . . . . . 8
IAnalyzer::OpenFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
IAnalyzer::StartGeneration . . . . . . . . . . . . . . . . . . . . . . . . 12
IAnalyzer::StopGeneration . . . . . . . . . . . . . . . . . . . . . . . . 13
IAnalyzer::StartRecording . . . . . . . . . . . . . . . . . . . . . . . . 14
IAnalyzer::StopRecording . . . . . . . . . . . . . . . . . . . . . . . . 16
IAnalyzer::MakeRecording . . . . . . . . . . . . . . . . . . . . . . . 18
IAnalyzer::LoadDisplayOptions . . . . . . . . . . . . . . . . . . . . 20
IAnalyzer::GetRecordingOptions . . . . . . . . . . . . . . . . . . . 21
IFwAnalyzer::EnableConfigROM . . . . . . . . . . . . . . . . . . 23
IFwAnalyzer::LoadConfigROM. . . . . . . . . . . . . . . . . . . . 24
IFwAnalyzer::RetrieveTree . . . . . . . . . . . . . . . . . . . . . . . 25
Primary Dual Interface for Trace . . . . . . . . . . . . . . . . . . . . . . . . . 26
ITrace::GetName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
ITrace::ApplyDisplayOptions. . . . . . . . . . . . . . . . . . . . . . 28
ITrace::Save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
ITrace::ExportToText . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
ITrace::Close. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
ITrace::ReportFileInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
ITrace::ReportErrorSummary . . . . . . . . . . . . . . . . . . . . . . 38
ITrace::ReportTrafficSummary. . . . . . . . . . . . . . . . . . . . . 40
ITrace::GetPacket . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
ITrace::GetPacketsCount . . . . . . . . . . . . . . . . . . . . . . . . . 44
ITrace::GetTriggerPacketNum . . . . . . . . . . . . . . . . . . . . . 46
ITrace::AnalyzerErrors . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Primary Dual Interface for Recording Options. . . . . . . . . . . . . . . 49
IRecOptions::Load . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
IRecOptions::Save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
IRecOptions::SetRecMode . . . . . . . . . . . . . . . . . . . . . . . . 52
IRecOptions::SetBufferSize . . . . . . . . . . . . . . . . . . . . . . . 53