TBSOptimizationSolution Class

class NXOpen.CAE.Optimization.TBSOptimizationSolution

Bases: NXOpen.NXObject

Represents the solution to contain optimization setting

This is an abstract class, and cannot be created.

New in version NX8.0.0.

Properties

Property	Description
ControlParameters	Returns the parameters to control optimization
DesignArea	Returns the design area that will be modified during optimization
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
Name	Returns the custom name of the object.
Objectives	Returns the objective function of the optimization
OutputControlOptions	Returns the output control options of the optimization
OwningComponent	Returns the owning component, if this object is an occurrence.
OwningPart	Returns the owning part of this object
Prototype	Returns the prototype of this object if it is an occurrence.
StopCondition	Returns the stop condition to end the optimization
Tag	Returns the Tag for this object.
RestrictAreas	Represents the restrict area collection belonging to this optimization solution
Constraints	Represents the response constrain collection belonging to this optimization solution
DesignVariables	Represents the design variable collection belonging to this optimization solution
Smoothings	Represents the smooth collection belonging to this optimization solution

Methods

Method	Description
CreateAttributeIterator	Create an attribute iterator
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteUserAttribute	Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes	Deletes the attributes on the object, if any, that satisfy the given iterator
Destroy	Deletes an optimization solution and the associated result file optional
Find	Finds the NXOpen.TaggedObject with the given identifier as recorded in a journal.
FindObject	Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAttributeTitlesByType	Gets all the attribute titles of a specific type.
GetBooleanUserAttribute	Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute	Gets a time attribute by Title and array Index.
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetIterationNumber	Returns the iteration number during the optimization
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
GetPostResult	Returns the post result file name and status
GetRealAttribute	Gets a real attribute by title.
GetRealUserAttribute	Gets a real attribute by Title and array Index.
GetReferenceAttribute	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetSmoothResult	Returns the result file name and status for a specified smoothing setting
GetStringAttribute	Gets a string attribute value by title.
GetStringUserAttribute	Gets a string attribute by Title and array Index.
GetTimeAttribute	Gets a time attribute by title.
GetTimeUserAttribute	Gets a time attribute by Title and array Index.
GetUserAttribute	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString	Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount	Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock	Determine the lock of the given attribute.
GetUserAttributeSize	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects	Returns an array of objects from which this object presents attributes.
GetUserAttributes	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings	Gets all the attributes that have been set on the given object.
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
Print	Prints a representation of this object to the system log file.
Rename	Rename Solution and optionally rename associated results files
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetName	Sets the custom name of the object.
SetPdmReferenceAttribute	Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute	Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute	Creates or modifies a time attribute.
SetTimeUserAttribute	Creates or modifies a time attribute with the option to update or not.
SetUserAttribute	Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock	Lock or unlock the given attribute.
Solve	Solves the optimization solution

Enumerations

TBSOptimizationSolutionResultStatus Enumeration

Define the status of optimization result

Property Detail

ControlParameters

TBSOptimizationSolution.ControlParameters

Returns the parameters to control optimization

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

Getter Method

Signature ControlParameters

Returns: Return type:NXOpen.CAE.Optimization.TBSOptimizationParameters

New in version NX8.0.0.

License requirements: None.

DesignArea

TBSOptimizationSolution.DesignArea

Returns the design area that will be modified during optimization

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

Getter Method

Signature DesignArea

Returns: Return type:NXOpen.CAE.Optimization.TBSDesignArea

New in version NX8.0.0.

License requirements: None.

IsOccurrence

TBSOptimizationSolution.IsOccurrence

Returns whether this object is an occurrence or not.

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

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

TBSOptimizationSolution.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

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

Getter Method

Signature JournalIdentifier

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

Name

TBSOptimizationSolution.Name

Returns the custom name of the object.

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

Getter Method

Signature Name

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

Objectives

TBSOptimizationSolution.Objectives

Returns the objective function of the optimization

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

Getter Method

Signature Objectives

Returns: Return type:NXOpen.CAE.Optimization.TBSObjectives

New in version NX8.0.0.

License requirements: None.

OutputControlOptions

TBSOptimizationSolution.OutputControlOptions

Returns the output control options of the optimization

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

Getter Method

Signature OutputControlOptions

Returns: Return type:NXOpen.CAE.Optimization.TBSOutputControlOptions

New in version NX8.0.0.

License requirements: None.

OwningComponent

TBSOptimizationSolution.OwningComponent

Returns the owning component, if this object is an occurrence.

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

Getter Method

Signature OwningComponent

Returns: Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

TBSOptimizationSolution.OwningPart

Returns the owning part of this object

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

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

TBSOptimizationSolution.Prototype

Returns the prototype of this object if it is an occurrence.

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

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

StopCondition

TBSOptimizationSolution.StopCondition

Returns the stop condition to end the optimization

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

Getter Method

Signature StopCondition

Returns: Return type:NXOpen.CAE.Optimization.TBSStopCondition

New in version NX8.0.0.

License requirements: None.

RestrictAreas

TBSOptimizationSolution.RestrictAreas

Represents the restrict area collection belonging to this optimization solution

Signature RestrictAreas

New in version NX8.0.0.

Returns: Return type:NXOpen.CAE.Optimization.TBSRestrictAreaCollection

Constraints

TBSOptimizationSolution.Constraints

Represents the response constrain collection belonging to this optimization solution

Signature Constraints

New in version NX8.0.0.

Returns: Return type:NXOpen.CAE.Optimization.TBSConstraintCollection

DesignVariables

TBSOptimizationSolution.DesignVariables

Represents the design variable collection belonging to this optimization solution

Signature DesignVariables

New in version NX8.0.0.

Returns: Return type:NXOpen.CAE.Optimization.TBSDesignVariableCollection

Smoothings

TBSOptimizationSolution.Smoothings

Represents the smooth collection belonging to this optimization solution

Signature Smoothings

New in version NX8.0.0.

Returns: Return type:NXOpen.CAE.Optimization.TBSSmoothCollection

Method Detail

Destroy

TBSOptimizationSolution.Destroy

Deletes an optimization solution and the associated result file optional

Signature Destroy(deleteResult)

Parameters:deleteResult (bool) – true if you want associated result files to be deleted as well

New in version NX8.0.0.

License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

Find

TBSOptimizationSolution.Find

Finds the NXOpen.TaggedObject with the given identifier as recorded in a journal.

In general, this method should not be used in handwritten code and exists to support record and playback of journals. An exception will be thrown if no object can be found with the given journal identifier.

Signature Find(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object Returns: Return type:NXOpen.TaggedObject

New in version NX8.0.0.

License requirements: None.

FindObject

TBSOptimizationSolution.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object Returns: Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

GetIterationNumber

TBSOptimizationSolution.GetIterationNumber

Returns the iteration number during the optimization

Signature GetIterationNumber()

Returns: Return type:int

New in version NX8.0.0.

License requirements: None.

GetPostResult

TBSOptimizationSolution.GetPostResult

Returns the post result file name and status

Signature GetPostResult(iterationID)

Parameters:iterationID (int) – Returns:a tuple Return type:A tuple consisting of (status, postResultName). status is a NXOpen.CAE.Optimization.TBSOptimizationSolutionResultStatus. postResultName is a str.

New in version NX8.0.0.

License requirements: None.

GetSmoothResult

TBSOptimizationSolution.GetSmoothResult

Returns the result file name and status for a specified smoothing setting

Signature GetSmoothResult(smooth)

Parameters:smooth (NXOpen.CAE.Optimization.TBSSmooth) – Returns:a tuple Return type:A tuple consisting of (status, smoothResultName). status is a NXOpen.CAE.Optimization.TBSOptimizationSolutionResultStatus. smoothResultName is a str.

New in version NX8.0.0.

Deprecated since version NX8.5.0: Use NXOpen.CAE.Optimization.TBSSmooth.GetResults() instead.

License requirements: None.

Print

TBSOptimizationSolution.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

Rename

TBSOptimizationSolution.Rename

Rename Solution and optionally rename associated results files

Signature Rename(name, renameResults)

Parameters:

• name (str) – new solution name
• renameResults (bool) – true if you what associated results files to be renamed as well

New in version NX8.0.0.

License requirements: None.

SetName

TBSOptimizationSolution.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.

Solve

TBSOptimizationSolution.Solve

Solves the optimization solution

Signature Solve()

New in version NX8.0.0.

License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)