IterateThroughputCommand Object


Description:

Adjust the throughput rate for each iteration on stream blocks or ports.

Can be used with Command Sequencer: Yes

GUI Command Name: Basic: Iterate Throughput

Parents: Sequencer, StcSystem

IterateThroughputCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
AcceptableFrameLoss

Maximum number of frames that can be lost during an iteration in order for the iteration to be considered successful.

Type: double

Default: 0

Range: 0.0 - 100.0

Backoff

Rate at which the load decreases after the DUT fails at the current load. Applicable when LoadType is BINARY or COMBO.

Type: double

Default: 50

Range: 0.001 - 99.999

IgnoreMinMaxLimits

Specifies whether the search stops at the specified RateLowerLimit or RateUpperLimit value, or whether it continues beyond those limits if an acceptable load has not yet been found. This attribute is ignored if LoadType is set to BINARY.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Continues beyond minimum and maximum limits to find acceptable load

FALSE

Search stops at the RateLowerLimit or RateUpperLimit value.

InitalRate

If LoadType is set to BINARY, the load rate at the beginning of the test. This attribute is ignored if LoadType is set to STEP.

Type: double

Default: 10

LoadType

Method of setting the load rate.

Type: enum

Default: BINARY

Possible Values:

Value Description
STEP

Load rate increases by RateStep with each test iteration, beginning with RateLowerLimit and increasing to RateUpperLimit.

BINARY

A binary search algorithm is used to determine the load rate, beginning at RateInitial.

COMBO

Test begins in step mode and then switches to binary mode when a step iteration fails.

RateLowerLimit

If LoadType is set to STEP, the starting throughput rate for each port. This attribute is ignored if LoadType is set to BINARY.

Type: double

Default: 10.0

RateStep

Amount the throughput increases from iteration to iteration. This attribute is ignored if LoadType is set to BINARY.

Type: double

Default: 1

Range: 0.001 - 100000000000.0

RateUpperLimit

If LoadType is set to STEP, the maximum throughput rate for each port. This attribute is ignored if LoadType is set to BINARY.

Type: double

Default: 100

Resolution

Finest adjustment possible for the load from iteration to iteration. If the required adjustment to the current load for the next iteration is less than the resolution, the search stops. Applicable when LoadType is BINARY or COMBO.

Type: double

Default: 1.0

Range: 0.001 - 1000.0

StreamBlockList

List of stream blocks or ports to calculate throughput.

Type: handle

Default: 0

IterateThroughputCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status
TestStatus

Specifies the status of the test.

Type: string

Default: "" (empty string)