IterateLoadSizeCommand Object

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

Description:

Adjust the load size from iteration to iteration.

Can be used with Command Sequencer: Yes

GUI Command Name: Basic: Iterate Load Size

Parents: Sequencer, StcSystem

IterateLoadSizeCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
AdjustStreamBlockLoad

For example, if the command contains three stream blocks belonging to the same port and the load is set to 30%. For "NONE" each of the three stream blocks is set to 30% for a combined total of 90% load on the port. But for "PER_PORT" each of the three stream blocks is set to 10% for a combined total of 30% load on the port.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

The specified load is applied to all stream blocks.
PER_PORT

The specified load is split to number of streamblocks under each ports to make the total load of the port as specified.
CustomLoadList

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

Type: double

Default: 0
FixedLoad

Sets the fixed load size when LoadType is FIXED.

Type: double

Default: 10
LoadEnd

When LoadType is STEP, the maximum load for each port. This attribute is ignored if LoadType is set to CUSTOM, RANDOM or FIXED.

Type: double

Default: 50
LoadStart

When LoadType is STEP, the starting load for each port. This attribute is ignored if LoadType is set to CUSTOM, RANDOM or FIXED.

Type: double

Default: 10
LoadStep

Step value for incrementing the load from LoadStart to LoadEnd. This attribute is ignored if LoadType is set to CUSTOM, RANDOM or FIXED.

Type: double

Default: 10

Range: 0.001 - 100000000000.0
LoadType

Method of setting the load rate.

Type: enum

Default: FIXED

Possible Values:

Value Description
CUSTOM

Customized load rates. CustomLoadList specifies all load rates. When all custom load sizes have been set, the IterateLoadSizeCommand will automatically break out of its parent loop.
FIXED

Load rate is constant and equal to FixedLoad. The IterateLoadSizeCommand will automatically break out of its parent loop when the iteration count is greater than one.

RANDOM

Load rate is randomly chosen within the range set by RandomMinLoad and RandomMaxLoad. The IterateLoadSizeCommand will automatically break out of its parent loop when the iteration count is greater than one.
STEP

Load rate increases by LoadStep with each test iteration, beginning with LoadStart and increasing to LoadEnd. When all step frame sizes have been set, the IterateLoadSizeCommand will automatically break out of its parent loop.
LoadUnits

Unit of measurement for the load parameter, applied to all ports and streams in the test.

Type: enum

Default: PERCENT_LINE_RATE

Possible Values:

Value Description
PERCENT_LINE_RATE

Percentage of the line rate.
FRAMES_PER_SECOND

Frames per second.
INTER_BURST_GAP

Inter-burst gap, or idle time between packets.
MEGABITS_PER_SECOND

Megabits per second.
KILOBITS_PER_SECOND

Kilobits per second.
BITS_PER_SECOND

Bits per second.
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.
RandomMaxLoad

When using Random mode for load on the ports, the maximum load for each port. This attribute is ignored if LoadType is set to CUSTOM, FIXED or STEP.

Type: double

Default: 50
RandomMinLoad

When using Random mode for load on the ports, the minimum load for each port. This attribute is ignored if LoadType is set to CUSTOM, FIXED or STEP.

Type: double

Default: 10
StreamBlockList

List of ports to iterate load sizes. If the generator scheduling mode is set to "Port Based" then load will be set on the port. If the generator scheduling mode is set to "Priority Based" or "Rate Based" then load will be set on stream blocks.

Type: handle

Default: 0

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