GetPreviewDataCommand Object

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

Description:

Get the preview data for a port-level stream block.

Can be used with Command Sequencer: No

Parents: Sequencer, StcSystem

GetPreviewDataCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
EncapOption

Option to display all streams, resolved only streams or unresolved streams.

Type: enum

Default: SHOW_ALL

Possible Values:

Value Description
SHOW_ALL

Display all streams.
SHOW_RESOLVED_ONLY

Only display the streams with whose encapsulations are resolved.
SHOW_UNRESOLVED_ONLY

Only display the streams with whose encapsulations are unresolved.
IncludePathDescriptor

Indicate if the preview data will contain the information from path descriptor.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Include
FALSE

Exclude
RowCount

Number of rows to preview.

Type: u32

Default: 0
StartingRowIndex

Starting index (zero-based) of rows in the traffic path to preview. Each row corresponds to a flow/stream.

Type: u32

Default: 0
StreamBlock

Stream block for which to generate preview data.

Type: handle

Default: 0
TrafficPathIndex

Index of the traffic path to preview.

Type: u32

Default: 0

GetPreviewDataCommand Read-Only Attributes

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

Handle of the preview data object for the traffic path.

Type: handle

Default: 0