Skip to main content

optiSLang Python API 2026 R1

py_os_parameter

Last update: 05.08.2026

class py_os_parameter.DProp

__init__()

class py_os_parameter.DPropList

__init__()

__iter__() → object

dprop_export_list() → DPropList

push_back(arg2: DPropPair)

size() → int

class py_os_parameter.DPropPair

__init__()

property first

property second

class py_os_parameter.ParameterList

__init__()

__iter__() → object

param_export_list() → ParameterList

push_back(arg2: PyParameter)

size() → int

class py_os_parameter.PyParameter

__eq__(arg2: PyParameter) → bool

__init__()

__init__(arg2: str)

__init__(arg2: str, arg3: float, arg4: float, arg5: float, arg6: int)

__init__(arg2: str, arg3: float, arg4: float, arg5: PyOSDesignEntry, arg6: int)

__init__(arg2: str, arg3: PyOSDesignEntryVec, arg4: DeterministicType)

__init__(arg2: str, arg3: str)

__init__(arg2: str, arg3: RandomVariableType, arg4: RandomVariableKind, arg5: PyOSDesignEntry)

__is_equal__(arg2: PyParameter) → bool

__is_not_equal__(arg2: PyParameter) → bool

__ne__(arg2: PyParameter) → bool

erase_det_prop(name: str)

get_dependency_expression() → str

get_det_discrete_states() → PyOSDesignEntryVec

get_det_kind() → DeterministicType

get_det_prop_by_index(index: int) → DProp

get_det_prop_name(index: int) → object

get_det_props() → DPropList

get_det_type() → EntryType

get_id() → UUID

get_lower_bound() → PyOSDesignEntry

get_mutable_map() → object

get_name() → str

get_parameter_type() → ParameterType

get_ran_cov() → float

get_ran_kind() → RandomVariableKind

get_ran_parameters() → doubleVec

get_ran_prop() → RanProp

get_ran_statistical_moments() → doubleVec

get_ran_type() → RandomVariableType

get_reference_value() → PyOSDesignEntry

get_upper_bound() → PyOSDesignEntry

has_continuous_distribution() → bool

has_marginal_distribution() → bool

has_set_ran_cov() → bool

has_set_ran_parameters() → bool

has_set_ran_statistical_moments() → bool

is_active() → bool

is_const() → bool

is_continuous() → bool

is_dependent() → bool

is_empirical() → bool

is_mixed() → bool

is_modifiable() → bool

is_mutable(member: object) → bool

is_optimization() → bool

is_pure_optimization() → bool

is_pure_stochastic() → bool

is_ran_prop_validated() → bool

is_stochastic() → bool

rename_det_prop(arg2: str)

rename_det_prop(arg2: str, to: str)

rename_parameter(to: str)

set_active(active: bool)

set_bounds(lower_bound: PyOSDesignEntry, upper_bound: PyOSDesignEntry)

set_const(constant: bool)

set_dependent(expression: str)

set_det_prop_by_index(value: DProp, index: int)

set_discrete_states(states: PyOSDesignEntryVec)

set_kind(kind: DeterministicType)

set_lower_bound(value: PyOSDesignEntry)

set_modifiable(arg2: bool)

set_mutable(member: object, state: bool)

set_mutable_map(arg2: object)

set_parameter_type(type: ParameterType)

set_ran_cov(cov: float) → float

set_ran_kind(kind: RandomVariableKind)

set_ran_parameters(parameters: doubleVec)

set_ran_prop_validated(arg2: bool)

set_ran_statistical_moments(moments: doubleVec)

set_ran_type(type: RandomVariableType)

set_reference_value(value: PyOSDesignEntry)

set_type(type: EntryType)

set_upper_bound(value: PyOSDesignEntry)

class py_os_parameter.PyParameterManager

__eq__(arg2: PyParameterManager) → bool

__init__()

__is_equal__(arg2: PyParameterManager) → bool

__is_not_equal__(arg2: PyParameterManager) → bool

__iter__() → object

__len__() → int

__ne__(arg2: PyParameterManager) → bool

add_dependent_parameter(parameter_name: str, expression: str)

add_deterministic_continuous_parameter(name: str, lower_bound: float, upper_bound: float, reference_value: float)

Add a new deterministic continuous parameter. A range_mode of 1 or 2 sets a relative lower respectively upper bound. A range_mode of 3 sets both bounds relative.

pm = PyParameterManager()
pm.add_deterministic_continuous_parameter('a', 0., 3., 1.5)

add_parameter(name: str)

add_stochastic_parameter(name: str, type: RandomVariableType, kind: RandomVariableKind, reference_value: PyOSDesignEntry)

Add a new stochastic parameter. It is required to set a parameter type and random parameters afterwards.

pm = PyParameterManager()
pm.add_stochastic_parameter('s1', RandomVariableType.NORMAL, RandomVariableKind.DETERMINISTIC, PyOSDesignEntry(0.72))
pm.set_parameter_type('s1', ParameterType.STOCHASTIC)
pm.set_ran_parameters('s1', double_list_to_vec([0.72, 0.3]))   # normal distribution: mu, sigmah

clear()

contains_parameter(name: str) → bool

contains_parameter(id: UUID) → bool

empty() → bool

erase_correlation(arg2: str, parameter_name: str) → bool

erase_correlations(parameter_name_b: str) → bool

erase_parameter(parameter_name: str)

get_bounds(parameter_name: str, lower_bound: PyOSDesignEntry, upper_bound: PyOSDesignEntry)

get_bounds(parameter_name: str) → tuple

[0] Note, that lower_bound and upper_bound are output arguments.

[1] Return a parameter’s boundaries as a tuple.

get_det_props() → DPropList

get_det_props_by_index(parameter_name: str, index: int) → DProp

get_parameter(parameter_name: str) → PyParameter

get_parameter(parameter_id: UUID) → PyParameter

get_parameter_by_index(index: int) → PyParameter

get_parameters() → ParameterList

get_ran_prop(parameter_name: str) → RanProp

get_ran_props() → RanPropList

get_reference_design() → PyOSDesignEntryVec

get_reference_design_point() → PyOSDesignPoint

get_size() → int

get_unique_name() → str

import_from_csv(csv: Path path)

Add parameters from csv to parameter manager.

import_from_json(path: Path)

Add parameters from json to parameter manager.

import_from_json_string(content: str)

Add parameters from json string to parameter manager.

insert_parameter(parameter: PyParameter)

rename_det_prop(parameter_name: str, from: str, to: str)

rename_parameter(from: str, to: str)

reset_correlations()

save_to_csv(csv: Path path)

Save parameter manager to a csv file.

save_to_json(path: Path)

Save parameter manager to a json file.

set_active(parameter_name: str, active: bool)

set_bounds(parameter_name: str, lower_bound: PyOSDesignEntry, upper_bound: PyOSDesignEntry)

set_const_all_in_list(names: WStrList) → PyParameterManager

set_const_flag(parameter_name: str)

set_correlation(parameter_name_a: str, parameter_name_b: str, value: float) → bool

set_dependent(parameter_name: str, expression: str)

set_discrete_states(parameter_name: str, discrete_states: PyOSDesignEntryVec)

set_kind(parameter_name: str, kind: DeterministicType)

set_lower_bound(parameter_name: str, value: PyOSDesignEntry)

set_modifiable(parameter_name: str, modifiable: bool)

set_parameter_type(parameter_name: str, type: ParameterType)

set_ran_cov(parameter_name: str, cov: float) → float

set_ran_kind(parameter_name: str, kind: RandomVariableKind)

set_ran_parameters(parameter_name: str, parameters: doubleVec)

set_ran_statistical_moments(parameter_name: str, moments: doubleVec)

set_ran_type(parameter_name: str, type: RandomVariableType)

set_reference_design_point(design_point: PyOSDesignPoint)

set_reference_value(parameter_name: str, value: PyOSDesignEntry)

set_type(parameter_name: str, type: EntryType)

set_upper_bound(parameter_name: str, value: PyOSDesignEntry)

class py_os_parameter.RanProp

__init__()

class py_os_parameter.RanPropList

__init__()

__iter__() → object

push_back(arg2: RanPropPair)

ran_prop_export_list() → RanPropList

size() → int

class py_os_parameter.RanPropPair

__init__()

property first

property second

py_os_parameter.get_const_parameter_names(parameter_manager: PyParameterManager, exclude_dependent: bool) → WStrList

py_os_parameter.get_dependent_parameter_names(parameter_manager: PyParameterManager) → WStrList

py_os_parameter.get_lower_bound_values(parameter_manager: PyParameterManager) → PyOSDesignPoint

py_os_parameter.get_non_const_det_props(parameter_manager: PyParameterManager) → DPropList

py_os_parameter.get_non_const_parameter_names(parameter_manager: PyParameterManager, exclude_dependent: bool) → WStrList

py_os_parameter.get_non_const_ran_props(parameter_manager: PyParameterManager) → ParameterList

py_os_parameter.get_num_non_const_det_props(parameter_manager: PyParameterManager) → int

py_os_parameter.get_num_non_const_ran_props(parameter_manager: PyParameterManager) → int

py_os_parameter.get_parameter_names(parameter_manager: PyParameterManager) → WStrList

py_os_parameter.get_pure_deterministic_parameter_names(parameter_manager: PyParameterManager) → WStrList

py_os_parameter.get_pure_stochastic_parameter_names(parameter_manager: PyParameterManager) → WStrList

py_os_parameter.get_upper_bound_values(parameter_manager: PyParameterManager) → PyOSDesignPoint

Connect with Ansys