IterateFrameSizeCommand Object

HOME | TECHNOLOGIES | TEST CONFIGURATION | SEQUENCER COMMANDS | GUI COMMAND NAMES | ALL COMMANDS | RESULT | PDU | ALL | OBJECT TREE

Description:

Adjust the frame size from iteration to iteration.

The method of adjustment is set by FrameSizeType.

Can be used with Command Sequencer: Yes

GUI Command Name: Basic: Iterate Frame Size

Parents: Sequencer, StcSystem

IterateFrameSizeCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
CustomFrameSizeList

List of frame sizes in the format of a native Tcl list. Applicable when FrameSizeType is CUSTOM.

Type: u16

Default: 0
FixedFrameSize

Sets the fixed frame size in bytes when FrameSizeType is FIXED.

Type: u16

Default: 128

Range: 40 - 16383
FrameSizeEnd

Maximum 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: u16

Default: 256

Range: 40 - 16383
FrameSizeStart

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: u16

Default: 128

Range: 40 - 16383
FrameSizeStep

Step value for incrementing the frame size from FrameSizeStart to FrameSizeEnd. This attribute is ignored if FrameSizeType is set to RANDOM, FIXED or CUSTOM.

Type: u16

Default: 128

Range: 1 - 16383
FrameSizeType

Method of setting the frame size.

Type: enum

Default: FIXED

Possible Values:

Value Description
FIXED

Frame size is constant and equal to FixedFrameSize. The IterateFrameSizeCommand will automatically break out of its parent loop when the iteration count is greater than one.
STEP

Frame size increases by FrameSizeStep with each test iteration, beginning with FrameSizeStart and increasing to FrameSizeEnd. When all step frame sizes have been set, the IterateFrameSizeCommand will automatically break out of its parent loop.

CUSTOM

Customized frame sizes. CustomFrameSizeList specifies all frame sizes. When all custom frame sizes have been set, the IterateFrameSizeCommand will automatically break out of its parent loop.
IMIX

Frame sizes defined by existing iMIX distribution.
RANDOM

Frame size is randomly chosen within the range set by RandomMinFrameSize and RandomMaxFrameSize. The IterateFrameSizeCommand will automatically break out of its parent loop when the iteration count is greater than one.
NONE

Frame size type not specified.
ImixDistributionList

Specifies the list of selected iMIX distributions to iterate.

Type: handle

Default: 0
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.
RandomMaxFrameSize

Maximum frame size when FrameSizeType is RANDOM. This attribute is ignored if FrameSizeType is set to STEP, FIXED or CUSTOM.

Type: u16

Default: 256

Range: 40 - 16383
RandomMinFrameSize

Minimum frame size when FrameSizeType is RANDOM. This attribute is ignored if FrameSizeType is set to STEP, FIXED or CUSTOM.

Type: u16

Default: 128

Range: 40 - 16383
StreamBlockList

List of stream blocks to iterate frame sizes.

Type: handle

Default: 0

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