logic:splitter::streams

Version: 0.0.0

Description

Splits a Streams into multiple coherent streams, actual number of outputs is always less or equal to the given desired number of ouputs.

Inputs

This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.

streams (Pin 0)

• Required: Yes
• Expected type(s): streams_container

Streams to split.

output_count (Pin 1)

• Required: Yes
• Expected type(s): int32

Number of desired outputs.

Outputs

This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.

output_count (Pin -1)

• Expected type(s): int32

Actual number of outputs.

outputs (Pin 0)

• Expected type(s): streams_container

Streams outputs.

Configurations

This operator supports configuration options that modify its behavior.

mutex

• Expected type(s): bool
• Default value: false

If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

Scripting

This operator can be accessed through scripting interfaces using these identifiers.

Category: logic

Plugin: core

Scripting name: split_streams

Full name: logic.split_streams

Internal name: splitter::streams

License: any_dpf_supported_increments

Examples

These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.

#include "dpf_api.h"

ansys::dpf::Operator op("splitter::streams"); // operator instantiation
op.connect(0, my_streams);
op.connect(1, my_output_count);
int my_output_count = op.getOutput<int>(-1);
ansys::dpf::Streams my_outputs = op.getOutput<ansys::dpf::Streams>(0);

import ansys.dpf.core as dpf

op = dpf.operators.logic.split_streams() # operator instantiation
op.inputs.streams.connect(my_streams)
op.inputs.output_count.connect(my_output_count)
my_output_count = op.outputs.output_count()
my_outputs = op.outputs.outputs()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.logic.split_streams() # operator instantiation
op.inputs.streams.Connect(my_streams)
op.inputs.output_count.Connect(my_output_count)
my_output_count = op.outputs.output_count.GetData()
my_outputs = op.outputs.outputs.GetData()

Changelog

• Version 0.0.0: Initial release.