Teledyne LeCroy SAS_SATA Tracer_Trainer Automation API Manual - Manual (Page 3)

LeCroy Corporation Automation API for SAS/SATATracer/Trainer Manual Version 1.11
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 SASTracer/SATracer Object Model ....................................... 6
3 SASAnalyzer Object ............................................................... 8
3.1 ISASAnalyzer Interface .............................................................. 9
3.1.1 ISASAnalyzer::GetVersion ............................................................................................. 10
3.1.2 ISASAnalyzer::OpenFile ................................................................................................ 11
3.1.3 ISASAnalyzer::StartGeneration...................................................................................... 12
3.1.4 ISASAnalyzer::StopGeneration...................................................................................... 15
3.1.5 ISASAnalyzer::StartRecording ....................................................................................... 16
3.1.6 ISASAnalyzer::StopRecording ....................................................................................... 18
3.1.7 ISASAnalyzer::MakeRecording...................................................................................... 19
3.1.8 ISASAnalyzer::LoadDisplayOptions............................................................................... 20
3.1.9 ISASAnalyzer::GetRecordingOptions ............................................................................ 21
3.1.10 ISASAnalyzer::ResumeGeneration............................................................................... 22
3.1.11 ISASAnalyzer::Attach .................................................................................................... 23
3.1.12 ISASAnalyzer::Detach................................................................................................... 24
4 SASTrace Object ................................................................ 25
4.1 ITrace Interface ........................................................................ 26
4.1.1 ITrace::GetName............................................................................................................ 27
4.1.2 ITrace::ApplyDisplayOptions.......................................................................................... 28
4.1.3 ITrace::Save ................................................................................................................... 29
4.1.4 ITrace::ExportToText ..................................................................................................... 30
4.1.5 ITrace::Close .................................................................................................................. 32
4.1.6 ITrace::ReportFileInfo .................................................................................................... 33
4.1.7 ITrace::ReportErrorSummary......................................................................................... 34
4.1.8 ITrace::GetPacket .......................................................................................................... 37
4.1.9 ITrace::GetPacketsCount............................................................................................... 40
4.1.10 ITrace::GetTriggerPacketNum ...................................................................................... 41
4.1.11 ITrace::AnalyzerErrors .................................................................................................. 42
4.2 ISASTrace Interface................................................................. 43
4.2.1 ISASTrace::GetBusPacket............................................................................................. 43
4.3 ISASVerificationScript Interface ............................................... 44
4.3.1 ISASVerificationScript::RunVerificationScript ................................................................ 45
4.3.2 ISASVerificationScript:: GetVScriptEngine .................................................................... 47