IterateBurstSizeCommand Object


Description:

Adjust the burst size from iteration to iteration. The method of adjustment is set by IterationMode.

Can be used with Command Sequencer: Yes

GUI Command Name: Basic: Iterate Burst Size

Parents: Sequencer, StcSystem

IterateBurstSizeCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
CustomBurstSizeList

List of burst sizes in the format of a native Tcl list. Applicable when BurstSizeType is CUSTOM.

Type: u32

Default: 0

Range: 1 - 4294967295

FixedBurstSize

Sets the fixed burst size in bytes when BurstSizeType is FIXED.

Type: u32

Default: 1

Range: 1 - 4294967295

InterFrameGap

Size of the interframe gap in bytes.

Type: u32

Default: 12

Range: 11 - 16383

InterFrameGapConfigMode

Inter frame gap configuration mode.

Type: enum

Default: MINIMUM

Possible Values:

Value Description
MINIMUM

MINIMUM

USER

USER

IterationMode

Method of setting the burst size.

Type: enum

Default: FIXED

Possible Values:

Value Description
CUSTOM

Customized burst sizes. CustomBurstSizeList specifies all burst sizes. When all custom burst sizes have been set, the IterateBurstSizeCommand automatically breaks out of its parent loop.

FIXED

Burst size is constant and equal to FixedBurstSize. The IterateBurstSizeCommand automatically breaks out of its parent loop when the iteration count is greater than one.

STEP

Burst size increases by BurstSizeStep with each test iteration, beginning with BurstSizeStart and increasing to BurstSizeEnd. When all step burst sizes have been set, the IterateBurstSizeCommand automatically breaks out of its parent loop.

NeedApply

Specifies rather apply is required or not.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Apply is required.

FALSE

Apply is not required.

StepBurstSizeEnd

Maximum burst size when using Step mode for incrementing the burst size. This attribute is ignored if BurstSizeType is set to FIXED or CUSTOM.

Type: u32

Default: 1

Range: 1 - 4294967295

StepBurstSizeStart

Starting frame size when using Step mode for incrementing the frame size. This attribute is ignored if FrameSizeType is set to RANDOM, FIXED or CUSTOM.

Type: u32

Default: 1

Range: 1 - 4294967295

StepBurstSizeStep

Step value for incrementing the burst size from BurstSizeStart to BurstSizeEnd. This attribute is ignored if BurstSizeType is set to FIXED or CUSTOM.

Type: u32

Default: 1

Range: 1 - 4294967295

StreamBlockList

List of stream blocks or ports to calculate iteration burst size.

Type: handle

Default: 0

IterateBurstSizeCommand 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)