DAOObjective Class

class NXOpen.CAE.Optimization.DAOObjective

Bases: NXOpen.NXObject

Represents a NXOpen.CAE.Optimization.DAOObjective.

New in version NX8.0.0.

Properties

Property	Description
CategoryType	Returns or sets the category type
GeometryType	Returns or sets the geometry type
IsOccurrence	Returns whether this object is an occurrence or not.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
LoadCase	Returns or sets the frequency load case index
ModeNumber	Returns or sets the frequency mode number
Name	Returns the custom name of the object.
ObjectiveGoal	Returns or sets the objective goal
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.
Response	Returns or sets the objective response
ResultMeasure	Returns or sets the result measure
Tag	Returns the Tag for this object.
TargetUnit	Returns or sets the target unit
TargetValue	Returns or sets the target value

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
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.
GetGeometry	Gets the target geometry
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetNextUserAttribute	Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetNumberResultGroup	Gets the objective result group number
GetPdmReferenceAttributeValue	Gets the value of PDM Reference attribute for given object.
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.
GetResults	Gets the objective results
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.
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetGeometry	Sets the target geometry
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.

Property Detail

CategoryType

DAOObjective.CategoryType

Returns or sets the category type

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

Getter Method

Signature CategoryType

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

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature CategoryType

Parameters:categoryType (NXOpen.CAE.Optimization.Category) – Category type

New in version NX8.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

GeometryType

DAOObjective.GeometryType

Returns or sets the geometry type

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

Getter Method

Signature GeometryType

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

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature GeometryType

Parameters:geometryType (NXOpen.CAE.Optimization.Geometry) – Geometry type

New in version NX8.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

IsOccurrence

DAOObjective.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

DAOObjective.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.

LoadCase

DAOObjective.LoadCase

Returns or sets the frequency load case index

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

Getter Method

Signature LoadCase

Returns: Return type:int

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature LoadCase

Parameters:loadcase (int) –

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

ModeNumber

DAOObjective.ModeNumber

Returns or sets the frequency mode number

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

Getter Method

Signature ModeNumber

Returns:Mode number Return type:int

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature ModeNumber

Parameters:modeNumber (int) – Mode number

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

Name

DAOObjective.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.

ObjectiveGoal

DAOObjective.ObjectiveGoal

Returns or sets the objective goal

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

Getter Method

Signature ObjectiveGoal

Returns:Objective goal Return type:NXOpen.CAE.Optimization.Goal

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ObjectiveGoal

Parameters:objectiveGoal (NXOpen.CAE.Optimization.Goal) – Objective goal

New in version NX8.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

OwningComponent

DAOObjective.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

DAOObjective.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

DAOObjective.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.

Response

DAOObjective.Response

Returns or sets the objective response

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

Getter Method

Signature Response

Returns:Objective response Return type:NXOpen.CAE.Optimization.Response

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Response

Parameters:objectiveResponse (NXOpen.CAE.Optimization.Response) – Objective response

New in version NX8.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

ResultMeasure

DAOObjective.ResultMeasure

Returns or sets the result measure

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

Getter Method

Signature ResultMeasure

Returns: Return type:NXOpen.CAE.ResultMeasure

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature ResultMeasure

Parameters:resMeas (NXOpen.CAE.ResultMeasure) –

New in version NX8.5.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

TargetUnit

DAOObjective.TargetUnit

Returns or sets the target unit

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

Getter Method

Signature TargetUnit

Returns:Target unit Return type:NXOpen.Unit

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature TargetUnit

Parameters:targetUnit (NXOpen.Unit) – Target unit

New in version NX8.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

TargetValue

DAOObjective.TargetValue

Returns or sets the target value

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

Getter Method

Signature TargetValue

Returns:Target value Return type:float

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature TargetValue

Parameters:targetValue (float) – Target value

New in version NX8.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

Method Detail

FindObject

DAOObjective.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.

GetGeometry

DAOObjective.GetGeometry

Gets the target geometry

Signature GetGeometry()

Returns:Target geometry Return type:list of NXOpen.DisplayableObject

New in version NX8.0.0.

License requirements: None.

GetNumberResultGroup

DAOObjective.GetNumberResultGroup

Gets the objective result group number

Signature GetNumberResultGroup()

Returns:Result group number Return type:int

New in version NX8.0.0.

License requirements: None.

GetResults

DAOObjective.GetResults

Gets the objective results

Signature GetResults(resultGroupIndex)

Parameters:resultGroupIndex (int) – Result group index Returns:Objective optimization results Return type:list of float

New in version NX8.0.0.

License requirements: None.

Print

DAOObjective.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetGeometry

DAOObjective.SetGeometry

Sets the target geometry

Signature SetGeometry(geometry)

Parameters:geometry (list of NXOpen.DisplayableObject) – Target geometry

New in version NX8.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

SetName

DAOObjective.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.