design_variation#

Hfss3dLayout.design_variation(variation_string=None)[source]#

Generate a string to specify a desired variation.

This method converts an input string defining a desired solution variation into a valid string taking into account all existing design properties and project variables, including dependent (non-sweep) properties.

This is needed because the standard method COM function GetVariationVariableValue does not work for obtaining values of dependent (non-sweep) variables. Using the object-oriented scripting model, which is a beta feature, could make this redundant in future releases.

Parameters:
variation_stringstr, optional

Variation string. For example, "p1=1mm" or "p2=3mm".

Returns:
str

String specifying the desired variation.

References

>>> oDesign.GetNominalVariation