Object Script Property Function Summary

Object Path

The Object path can be used to navigate through objects and properties in an Ansys EM project.

• An Object path consisted of one or multiple Object-ID-Nodes separated by "/" . In the HFSS-Optimtee example, the Optimization Max value of variable "offset" is represented by the path "TeeModel/offset/Optimization/max" or "TeeModel/Variable[offset]/Optimization[max]"
• Object-ID-Node; may exist in the following forms:
  • A simple object name or property name.
  • Type[Name] for object; Tab[name] for property.
  • Name[attr1="v1", attr2 = "v2", ...]. When more than one child object have the same name, use attributes to specify the difference.
  • ArrayName[index]. For example, in an Optimetric setup with multiple calculations, "Calculation[0]" could be used to identify the first calculation.
  • Name beginning with '@' character denoted as a property name, when an object has a child and property with the same name.

Property Object

The Property Object is the base class defined for all script object that support property Get & Set.

• GetName()
  • Returns the name of the object.
• GetChildTypes()
  • An object may have different type of children. For example, a design may have variables, modules, and editors.
  • Returns array of text strings; may be empty if the children are not divided to different types.
• GetChildNames(<type>)
  • <type> – children type name; default returns all children names for all types.
  • Returns an array of immediate children names, belonging to the type if specified.
• GetChildObject(<objPath>)
  • <objPath> – A child object path. The path may include multiple generations, such as (designObject/moduleObj/SetupObject).
  • Returns a child property object if the object found.
• GetPropEvaluatedValue(<propName>)
  • Return the Evaluated-Value for Value-Property and Variable.
  • Return the Property-value as text string for other property types.
• GetPropSIValue(<propName>)
  • Return the SI-Value for Value-Property and Variable.
  • Return NAN for other property type if its value is cannot be converted to a double-floating point value.
• GetPropNames(<bIncludeReadOnly>);
  • <bIncludeReadOnly> – optional, default to true; True will include read-only properties, False will exclude read-only properties.
  • Returns an array of the object’s property names.
• GetPropValue(<propertyPath>)
  • <propertyPath> – the property's full path. A property name or child object’s path appended with a property name, like “TeeModel/Offset/SIValue”
  • Returns the property value if the property is foun; otherwise causes script error.
• SetPropValue(<propertyPath>, <data>)
  • <propertyPath> – the property's full path. A property name or child object’s path appended with a property name, like “TeeModel/Offset/Value”
  • <data> – new data, type is dependent on property type.
  • Returns True if property data is updated successfully; False if the new data is invalid.

Project Object

Project Object inherited all functions defined in the Property Object. But it doesn't have property, GetPropValue() & SetPropValue() function can be used to set its child object's property.

• GetChildTypes() always return [“Design”, “Variable”].
• GetChildNames(type)
  GetChildNames() & GetChildName(“Design”) will return all Design names of the project.
  GetChildNames(“Variable”) return all project variable names.
• GetChildObject(objPath)

  oDesign = oProject("TeeModel")

  oVariable = oProject.GetChildObject("VariableName")

  oReport = oProject.GetChildObject("TeeModel/Results/S Parameter Plot 1")

• GetPropNames(bIncludeReadOnly) always return empty array since the project has no property.
• GetPropValue(propertyPath)

  oProject.GetPropValue("TeeModel/offset") //get the offset variable value in the TeeModel Design
  oProject.GetPropValue("TeeModel/Results/S Parameter Plot 1/Display Type") // Get the report display type.

• SetPropValue(propertyPath, newValue)

  oProject.SetPropValue("TeeModel/offset", "2mm") //Set the offset variable value to "2mm" in the TeeModel Design
  oProject.SetPropValue("TeeModel/Results/S Parameter Plot 1/Display Type", "Data Table) // Set the report display type to data table.

Design Object

Design Object inherited all functions defined in the Property Object. But it doesn't have property, GetPropValue() & SetPropValue() function can be used to set its child object's property..

• GetChildTypes() always return ['Module', 'Editor', 'Variable'].
• GetChildNames(type)
  GetChildNames() will return modules & editor child names.
  GetChildNames(“Variable”) will return all variable names
  GetChildNames(“Module”) will return all module names that support property-object-script like ['Optimetrics', 'RadField', 'Results']
  GetChildNames(“Editor”) will return a 3D editor name for all 3D Designs
• GetChildObject()
  oVariable = oDesign.GetChildObject("VariableName")
  oReport = oDesign.GetChildObject("Results/S Parameter Plot 1")
  oRptModule = oDesign.GetChildObject("ReportSetup")
• GetPropNames(bIncludeReadOnly) always return empty array since the design has no property.
• GetPropValue()
  oDesign GetPropValue("offset/SIValue") //get the offset variable SI value in the DesignoDesign GetPropValue("offset/SIValue") //get the offset variable SI value in the Design
  oDesign.GetPropValue("Results/S Parameter Plot 1/Display Type") // Get the report display type
  
• SetPropValue()
  oDesign.SetPropValue("offset", "2mm") //Set the offset variable value to "2mm" in the Design
  oDesign.SetPropValue("Results/S Parameter Plot 1/Display Type", "Data Table) // Set the report display type to data table.

3D Modeler Object

GetChild commands returns the appropriate properties for modeler objects. For 3D Components and UDMs, these commands do not return parts, coordinate systems, plans, as top-level modeler children.

oModeler = oDesktop.GetActiveProject().GetActiveDesign().GetChildObject("3D Modeler")
oModeler.GetChildNames()
oModeler.GetChildNames("ModelParts")
oModeler.GetChildNames("AllParts")
oModeler.GetChildNames("NonModelParts")
oModeler.GetChildNames("Planes")
oModeler.GetChildNames("CoordinateSystems")

Variable Object

Is a Property Object that has no child. It also provides quick function call to get/set it properties by adding functions with property name appended to Get_ & Set_ prefix. To find what functions it provided enter dir(oVar) the command window. It can accessed by the project or design object’s GetChildObject(VariableName) function.

oProjVar = oProject.GetChildObject(“$VarName”)
oVar = oProject.GetChildObject(“DesignName/VarName”)
oVar = oDesign.GetChildObject(“variableName”)
oProject..GetChildNames(“Variable”) will return all project variable names.
oDesign.GetChildNames(Variable”) will return all Design Variable names.

• GetChildTypes() always return empty array.
• GetChildNames() always return empty array , since variable has no child.
• GetChildObject(objPath) it has no child.
• GetPropNames(bIncludeReadOnly) ['EvaluatedValue', 'SIValue'] are read-only properties
  • Independent variable :['Value', 'EvaluatedValue', 'SIValue', 'Description', 'ReadOnly', 'Hidden', 'Sweep', 'Optimization/Included', 'Optimization/Min', 'Optimization/Max', 'Sensitivity/Included', 'Sensitivity/Min', 'Sensitivity/Max', 'Sensitivity/IDisp', 'Statistical', 'Statistical/Included', 'Tuning/Included', 'Tuning/Step', 'Tuning/Min', 'Tuning/Max'].
  • Dependent variable ['Value', 'EvaluatedValue', 'SIValue', 'Description', 'ReadOnly', 'Hidden', 'Sweep']
• GetPropValue(propName)
  oVar.GetPropValue() return the variable value as text string.
  oVar.GetPropValue(“Value”) return the variable value as text string.
  oVar.GetPropValue(“SIValue”) return the SI-value of variable as number.
  oVar.Get_SIValue()also return the SI value.
• SetPropValue(propName, newValue)
  oVar.SetPropValue(“Value", 888)
  oVar.SetPropValue("Sensitivity'/Included", True)
  oVar.SetPropValue("Sensitivity/Max”, '1.8pF'])
  oVar.Set_Sensitivity_Max( '1.8pF') also works as last call.
  oVar.SetPropValue("Sensitivity", ['Min:=', '0.8pF', 'Max:=', '1.8pF'])
  //set multiple attributes at one call:
  oVar.SetPropValue("@", ['Value:=',288, 'Sensitivity', ['Included', True,'Min', '0.0']])
  oVar.SetPropValue("", ['Value:=',288, 'Sensitivity', ['Included', True,'Min', '0.0']])

Optimetrics Module Object:

Optimetrics Module Object inherited all functions defined in the Property Object. But it doesn't have property, GetPropValue() & SetPropValue() function can be used to set its child object's property..

• GetChildTypes() there are six type of children, they are ['OptiParametric', 'OptiOptimization', 'OptiSensitivity', 'OptiStatistical', 'OptiDesignExplorer', 'OptiDXDOE']. But the return array only included those that have setup defined, so it may be an empty array if no optimetrics setup is defined. The GetChildNames(type) function also recognized the type name without the prefix “Opti”.
• GetChildNames(type)
  GetChildNames() will return all setup for all types.
  GetChildNames(“OptiOptimization”) & GetChildNames(“Optimization”) will return all Optimization setup.
• GetChildObject()
  oParamSetup = oOptModule.GetChildObject('ParametricSetup1') get the
  oOptSetup = oOptModule.GetChildObject('OptimizationSetup1')
• GetPropNames(bIncludeReadOnly) always return empty array since the it has no property.
• GetPropValue(propPath) may be used to get its child’s property value
  oOptModule.GetPropValue("OptimizationSetup1\Optimizer") get the optimizer name for OptimizationSetup1
• SetPropValue(propPath, newValue) may be used to set its child’s property value
  oOptModule.SetPropValue(ParametricSetup1\Enabled", False) //disable ParametricSetup1
  

Optimetrics Setup Object

This is a new Object inherited all functions defined in the Property Object. But it doesn't have child. It is accessible through its parents.

oOptSetup = oOptModule.GetChildObject('OptimizationSetup1')

oOptSetup = oDesign.GetChildObject('Optimetrics\OptimizationSetup1')

oOptSetup = oProject.GetChildObject('TeeModel\Optimetrics\OptimizationSetup1')

• GetChildTypes() always return empty array.
• GetChildNames(type) always return empty array
• GetChildObject()
• GetPropNames(bIncludeReadOnly) will return the property names listed in the property window when the setup is selected.
• GetPropValue(propName)
  oOptSetup.GetPropValue("Optimizer") return the selected optimizer name.
  oOptSetup.GetPropValue("Optimizer/Choices") return all optimizer names.
• SetPropValue(propName, newValue)
  oOptSetup.SetPropValue("Optimizer", “NotAnOptimzerName”; will return false.
  oOptSetup.SetPropValue("Optimizer", “Quasi Newton”; return true, since “Quasi Newton” is one of the optimizer name returned as the Optimizer Choices.
• HasResult() return true if the setup is solved. Otherwise return false.
• Validate() return true if the setup is valid for analyze. Otherwise return false. Calling the SetPropValue() function to change the property may invalid the setup.

ReportSetup(Results) Module Object:

ReportSetup module Object inherited all functions defined in the Property Object. But it doesn't have property, GetPropValue() & SetPropValue() function can be used to get/set its child object's property..

• GetChildTypes() always empty array.
• GetChildNames(type)
  GetChildNames() return all report names
• •GetChildObject(objPath)
  oRpt = oRptModule.GetChildObject("S Parameter Plot 1") return the report property object
  oTrace = oRptModule.GetChildObject("S Parameter Plot 1/dB(S(Port1,Port1))") return the trace property object
  oAxisX = oRptModule.GetChildObject("S Parameter Plot 1/AxisX") return the axis X property object
• GetPropNames(bIncludeReadOnly) always return empty array since the it \has no property.
• GetPropValue()
  oRptModule.GetPropValue(“S Parameter Plot 1/Display Type”)
• SetPropValue()
  oRptModule.SetPropValue(“S Parameter Plot 1/Display Type”, “DataTable”)

ReportSetup(Results) Module Child Objects:

These are Property Objects. Its first level of child object is report. Report has trace, axis, header, Legend, and more children. Trace has curve as child etc.

Those child objects can be accessed by calling all levels of parent object’s GetChildObject(path) function.

oRpt = oRptModule.GetChildObject(reportName)

oRpt = oDesign.GetChildObject(“Results/reportName”)

oTrace = oRpt.GetChildObject(traceName)

oTrace = oRptModule.GetChildObject(ReportName/TraceName)

• GetChildTypes() always return empty array.
• GetChildNames() get the object’s child names. What will be returned will depended on the object instance.
• GetChildObject(objPath)
• GetPropNames(bIncludeReadOnly) will return the property names listed in the property window when the object is selected.
• GetPropValue(propName)
  oRpt.GetPropValue("Display Type") return the report’s display type.
  oOptSetup.GetPropValue("Display Type/Choices") return all optimizer names.
  oTrace.GetPropValue(“X Component”)
• SetPropValue(propName, newValue)
  oTrace.SetPropValue(“Primary sweep”, “Freq”)

Radiation Module Object:

This inherited all functions defined in the Property Object. But it doesn't have property, GetPropValue() & SetPropValue() function can be used to set its child object's property.

• GetChildTypes() always return empty array, now its children
• GetChildNames(type)
  GetChildNames() return all setup names.
• GetChildObject(setupName) return the setup object as Property object.
  oOverlay= oRadModule.GetChildObject('Antenna Parameter Overlay1')
  oSphere = oRadModule.GetChildObject('Infinite Sphere1')
• GetPropNames() return empty array; it has no property.
• GetPropValue()
  oRadModule.GetPropValue('Line1/Num Points') //Get the the Line1 setups’ “Num Points” property value.
• SetPropValue()
  oRadModule.SetPropValue('Line1/Num Points', 100) ; Set the Line1 setups’ “Num Points” property to 100.

Radiation Module Child Objects:

These are Property Objects. It also provides quick function call to get/set its properties by adding functions with property name appended to Get_ & Set_ prefix. To find what functions it provides enter dir(oVar) the command window.

Those child objects can be access by call all levels of parent object’s GetChildObject(path) function.

oRadSetup = oRadModule.GetChildObject(setupName)

oRadSetup = oDesign.GetChildObject(RadField/setupName)

• GetChildTypes() always return empty array.
• GetChildNames() always return empty array , since Radiation setup has no child.
• GetChildObject(objPath) it has no child.
• GetPropNames(bIncludeReadOnly) will return the property names listed in the property window when the setup is selected.
• GetPropValue(propName)
  oRadSetup.GetPropValue(”Num Points") return the line setup’s “Num Points” property value.
  oRadSetup.Get_NumPoints() will also get the same value.
• SetPropValue(propName, newValue)
  oRadSetup.SetPropValue('Num Points', 888)
  oRadSetup.Set_NumPoints(888)