utility:default value

Version: 0.0.0

Description

Returns the value from pin 0 if provided, otherwise returns the default value from pin 1. This operator acts as a fallback mechanism for optional inputs.

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.

forced_value (Pin 0)

• Required: No
• Expected type(s):

Primary value to return if provided. Can be any type

default_value (Pin 1)

• Required: Yes
• Expected type(s):

Default value to return if pin 0 is not connected. Must be the same type as pin 0

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 (Pin 0)

• Expected type(s):

Returns primary_value if provided, otherwise default_value

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

Plugin: core

Scripting name: default_value

Full name: utility.default_value

Internal name: default_value

License: None

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("default_value"); // operator instantiation
op.connect(0, my_forced_value);
op.connect(1, my_default_value);
 my_output = op.getOutput<>(0);

import ansys.dpf.core as dpf

op = dpf.operators.utility.default_value() # operator instantiation
op.inputs.forced_value.connect(my_forced_value)
op.inputs.default_value.connect(my_default_value)
my_output = op.outputs.output()

import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.utility.default_value() # operator instantiation
op.inputs.forced_value.Connect(my_forced_value)
op.inputs.default_value.Connect(my_default_value)
my_output = op.outputs.output.GetData()

Changelog

• Version 0.0.0: Initial release.