StreamBlockGetInfoCommand Object


Description:

Get general information about a stream block, such as total stream count, flow count, traffic path count, etc.

Can be used with Command Sequencer: No

Parents: Sequencer, StcSystem

StreamBlockGetInfoCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
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

StreamBlock

Target stream block.

Type: handle

Default: 0

StreamBlockGetInfoCommand Read-Only Attributes

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

Separator to use between strings.

Type: string

Default:

TotalFlowCount

Total number of flows generated by the stream block.

Type: u32

Default: 0

TotalStreamCount

Total number of streams generated by the stream block.

Type: u32

Default: 0

TotalTrackableFlowCount

Total trackable flow count

Type: u32

Default: 0

TotalTrafficPathCount

Total number of traffic paths generated by the stream block.

Type: u32

Default: 0

TrafficPathInfoList

Handles of traffic path info objects for the stream block.

Type: handle

Default: 0