beautypg.com

Iserialscsicaptureproject, Methods – Teledyne LeCroy Sierra SAS_SATA Protocol Analyzer STX API Reference Manual User Manual

Page 191

background image


Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

ISerialSCSICaptureProject 191

ISerialSCSICaptureProject

This interface class integrates all information needed for capturing, triggering, and running a

capture project.
You can define a capture project in one of two modes:

Easy: For all methods that are related to capture items, the nStateId parameter is

defined for pre-or post-capturing as a 0, 1 value or as a Capture ID definition. For all
methods that are related to trigger items (that have ConditionExpr in the method
name), nStateId and nConditionIndex are not meaningful parameters and can pass with
any value.

Advanced: nStateId shows a unique ID for a state, and nConditionIndex shows the Index

for a condition to trigger items.

(You can also get/set by related methods.)
NOTE: Some methods are only for Easy or Advanced mode, and the rest are for both modes.

Methods

Method Name

Method Description

AddCapturePattern

Interface function for adding a

pattern to capture items.

AddConditionExprPattern

Interface function for adding a

pattern to an expression for a

condition in advanced mode or

trigger items in easy mode.

AddConditionExprTimerToken

Interface function for adding a

timer to an expression for a

condition in advanced mode.

AddState

Adds new state in advanced

mode, with default values in

capture and trigger parts, and

returns StateId of added state to

pass to all other functions of this

ID.

CopyPasteState

Copies and pastes a state in a

position.

CopyState

Copies a state to the clipboard to

paste in a position.

GetProjectType

Returns the type of project:

Analyzer or Exerciser/Analyzer