DesignStudyBuilder Class

class NXOpen.Optimization.DesignStudyBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Optimization.DesignStudyBuilder

To create a new instance of this class, use NXOpen.Optimization.DesignStudyCollection.CreateDesignStudyBuilder()

New in version NX6.0.0.

Properties

Property Description
IsShowGraph Returns or sets the property - is show graph
IsUpdateDisp Returns or sets the property - is update display
StudyName Returns or sets the study name which is unique in one part
Tag Returns the Tag for this object.

Methods

Method Description
BuildAllObjectives Build all the objectives
BuildAllVariables Build all the variables
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetDesignStudyObjectives Returns the objectives
GetDesignStudyVariables Returns the variables
GetObject Returns the object currently being edited by this builder.
RemoveAllObjectives Remove all the objectives
RemoveAllVariables Remove all the variables
RunDesignStudy Run design study process
SetDesignStudyObjectives Sets the objectives
SetDesignStudyVariables Sets the variables
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

IsShowGraph

DesignStudyBuilder.IsShowGraph

Returns or sets the property - is show graph

-------------------------------------

Getter Method

Signature IsShowGraph

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IsShowGraph

Parameters:isShowGraph (bool) –

New in version NX6.0.0.

License requirements: None.

IsUpdateDisp

DesignStudyBuilder.IsUpdateDisp

Returns or sets the property - is update display

-------------------------------------

Getter Method

Signature IsUpdateDisp

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IsUpdateDisp

Parameters:isUpdateDisp (bool) –

New in version NX6.0.0.

License requirements: None.

StudyName

DesignStudyBuilder.StudyName

Returns or sets the study name which is unique in one part

-------------------------------------

Getter Method

Signature StudyName

Returns:
Return type:str

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature StudyName

Parameters:studyName (str) –

New in version NX6.0.0.

License requirements: None.

Method Detail

BuildAllObjectives

DesignStudyBuilder.BuildAllObjectives

Build all the objectives

Signature BuildAllObjectives()

New in version NX6.0.0.

License requirements: None.

BuildAllVariables

DesignStudyBuilder.BuildAllVariables

Build all the variables

Signature BuildAllVariables()

New in version NX6.0.0.

License requirements: None.

GetDesignStudyObjectives

DesignStudyBuilder.GetDesignStudyObjectives

Returns the objectives

Signature GetDesignStudyObjectives()

Returns:Objectives
Return type:list of NXOpen.Optimization.DesignStudyBuilderDesignStudyObjective_Struct

New in version NX6.0.0.

License requirements: None.

GetDesignStudyVariables

DesignStudyBuilder.GetDesignStudyVariables

Returns the variables

Signature GetDesignStudyVariables()

Returns:Variables
Return type:list of NXOpen.Optimization.DesignStudyBuilderDesignStudyVariable_Struct

New in version NX6.0.0.

License requirements: None.

RemoveAllObjectives

DesignStudyBuilder.RemoveAllObjectives

Remove all the objectives

Signature RemoveAllObjectives()

New in version NX6.0.0.

License requirements: None.

RemoveAllVariables

DesignStudyBuilder.RemoveAllVariables

Remove all the variables

Signature RemoveAllVariables()

New in version NX6.0.0.

License requirements: None.

RunDesignStudy

DesignStudyBuilder.RunDesignStudy

Run design study process

Signature RunDesignStudy()

New in version NX6.0.0.

License requirements: None.

SetDesignStudyObjectives

DesignStudyBuilder.SetDesignStudyObjectives

Sets the objectives

Signature SetDesignStudyObjectives(attributeNames, attributeObjects, objectiveTypes, warningLowerLimit, warningUpperLimit, failureLowerLimit, failureUpperLimit)

Parameters:
  • attributeNames (list of str) – Objective attribute name array
  • attributeObjects (list of NXOpen.NXObject) – Objective attribute object array
  • objectiveTypes (list of NXOpen.Optimization.DesignStudyBuilderDesignStudyAttributeType) – Objective attribute type array
  • warningLowerLimit (list of float) – Warning lower limit
  • warningUpperLimit (list of float) – Warning upper limit
  • failureLowerLimit (list of float) – Failure lower limit
  • failureUpperLimit (list of float) – Failure upper limit

New in version NX6.0.0.

License requirements: None.

SetDesignStudyVariables

DesignStudyBuilder.SetDesignStudyVariables

Sets the variables

Signature SetDesignStudyVariables(attributeNames, attributeObjects, variableTypes, variableLowerLimitValue, variableUpperLimitValue, distributeType, locationParameter, scaleParameter, shapeParameter, valuesCount)

Parameters:
  • attributeNames (list of str) – Variable attribute name array
  • attributeObjects (list of NXOpen.NXObject) – Variable attribute object array
  • variableTypes (list of NXOpen.Optimization.DesignStudyBuilderDesignStudyAttributeType) – Variable attribute type array
  • variableLowerLimitValue (list of float) – Variable lower limit value array
  • variableUpperLimitValue (list of float) – Variable upper limit value array
  • distributeType (list of NXOpen.Optimization.DesignStudyBuilderDesignStudyDistributeType) – Distribute type
  • locationParameter (list of float) – Location parameter
  • scaleParameter (list of float) – Scale parameter
  • shapeParameter (list of float) – Shape parameter
  • valuesCount (list of int) – Values count

New in version NX6.0.0.

License requirements: None.

Validate

DesignStudyBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.