beautypg.com

Iexerciserengine, Default interface methods – Teledyne LeCroy Sierra SAS_SATA Protocol Analyzer STX API Reference Manual User Manual

Page 384

background image


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

IExerciserEngine 384

IExerciserEngine

This interface class is responsible to integrate all information needed for Exerciser and can run

project in exerciser or pattern generator mode.

Default Interface Methods

Method Name

Method Description

AddProtocolErrorToPacket

Adds a protocol error to the packet.

AssignLable

Adds a label to an object and returns

assigned label ID.

ChangeLable

Changes label name of label

corresponding to a label ID.

DeleteAll

Removes all objects (packets and

instructions).

DeleteInstruction

Removes instruction corresponding to

an object index.

DeletePacket

Removes a packet.

ExpandSATASelfTestInstructionField

Expands a field of a SATA self-test

instruction.

GetEnablePatternGenerator

Returns exerciser project mode:

run exerciser or pattern generator.

GetAffiliationType

Returns affiliation setting: Clear

affiliation after command complete

or Leave affiliation state unchanged.

GetAutomaticAction

Returns type of automatic action:

Abort task for railed command or

multi-command feature.

GetAutoUpdateProperties

Returns auto update features (type,

upper limit, lower limit) and returns

Error Code if an error occurs.

GetDataInProperties

Returns stored Data In features

(length, offset) and returns Error

Code if an error occurs.

GetDelayInstructionTime

Returns delay time value of delay

instruction.