add_variation

SetupParam.add_variation(sweep_variable: str, start_point: float, end_point: float = None, step: float = 100, units: str = None, variation_type: str = 'LinearCount') → bool

Add a variation to an existing parametric setup.

Parameters:

sweep_variablestr

Name of the variable.

start_pointfloat or int

Variation Start Point.

end_pointfloat or int, optional

Variation End Point. This parameter is optional if a Single Value is defined.

stepfloat or int, optional

Variation Step or Count depending on variation_type. Default is 100.

unitsstr, optional

Variation units. Default is None.

variation_typestr, optional

Variation Type. Admitted values are “SingleValue”, `”LinearCount”, “LinearStep”, “DecadeCount”, “OctaveCount”, “ExponentialCount”.

Returns:

bool

True when successful, False when failed.

References

>>> oModule.EditSetup