CaeDOFSet Class

class NXOpen.CAE.CaeDOFSet

Bases: NXOpen.DisplayableObject

Represents a dofset class NXOpen.CAE.CaeDOFSet.

To obtain an instance of this object use on of the creator in NXOpen.CAE.CaeDOFSetCollection.

New in version NX7.5.0.

Properties

Property Description
Color Returns or sets the color of the object.
IsBlanked Returns the blank status of this object.
IsOccurrence Returns whether this object is an occurrence or not.
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
Layer Returns or sets the layer that the object is in.
LineFont Returns or sets the line font of the object.
LineWidth Returns or sets the line width of the object.
Name Returns the custom name of the object.
NameLocation Returns the location of the object’s name.
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.
Tag Returns the Tag for this object.

Methods

Method Description
AddNodes Add nodes to the CaeDOFSet A true for a dof logical entry would mean that the dof is included for that corresponding node.
Blank Blanks the object.
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.
GetDisplay The BC Display object associated with the BC object
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetLabel Gets the label of the CaeDOFSet
GetNextUserAttribute Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetNodes Get the nodes in the DOFSet
GetNodesWithDof Get the nodes with the given dof value in the DOFSet
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.
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
Highlight Highlights the object.
Information Display information of this DOFSet
ModifyNodeDofs Modify the dofs of the passed in nodes in the CaeDOFSet.
Print Prints a representation of this object to the system log file.
RedisplayObject Redisplays the object in all views.
RemoveAllNodes Remove all nodes from the CaeDOFSet
RemoveNodes Remove nodes from the CaeDOFSet.
RemoveViewDependency Remove dependency on all views from an object.
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetLabel Sets the label of the CaeDOFSet
SetName Sets the custom name of the object.
SetNameLocation Sets the location of the object’s name.
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.
Unblank Unblanks the object.
Unhighlight Unhighlights the object.

Property Detail

IsOccurrence

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

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

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

OwningComponent

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

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

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

Method Detail

AddNodes

CaeDOFSet.AddNodes

Add nodes to the CaeDOFSet A true for a dof logical entry would mean that the dof is included for that corresponding node.

A false would mean that the dof is not included for that node.

Signature AddNodes(nodes, dof1, dof2, dof3, dof4, dof5, dof6)

Parameters:
  • nodes (list of NXOpen.CAE.FENode) – Array of nodes to Add NXOpen.CAE.FENode
  • dof1 (list of bool) – Array of DOF1 values
  • dof2 (list of bool) – Array of DOF2 values
  • dof3 (list of bool) – Array of DOF3 values
  • dof4 (list of bool) – Array of DOF4 values
  • dof5 (list of bool) – Array of DOF5 values
  • dof6 (list of bool) – Array of DOF6 values

New in version NX7.5.0.

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

FindObject

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

GetDisplay

CaeDOFSet.GetDisplay

The BC Display object associated with the BC object

Signature GetDisplay()

Returns:
Return type:NXOpen.CAE.CaeDOFSetDisplay

New in version NX7.5.0.

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

GetLabel

CaeDOFSet.GetLabel

Gets the label of the CaeDOFSet

Signature GetLabel()

Returns:Label of the DOFSet
Return type:int

New in version NX7.5.0.

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

GetNodes

CaeDOFSet.GetNodes

Get the nodes in the DOFSet

Signature GetNodes()

Returns:Array of nodes in the DOFSet NXOpen.CAE.FENode
Return type:list of NXOpen.CAE.FENode

New in version NX7.5.0.

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

GetNodesWithDof

CaeDOFSet.GetNodesWithDof

Get the nodes with the given dof value in the DOFSet

Signature GetNodesWithDof(dof1, dof2, dof3, dof4, dof5, dof6)

Parameters:
  • dof1 (bool) – DOF1 value
  • dof2 (bool) – DOF2 value
  • dof3 (bool) – DOF3 value
  • dof4 (bool) – DOF4 value
  • dof5 (bool) – DOF5 value
  • dof6 (bool) – DOF6 value
Returns:

Array of nodes NXOpen.CAE.FENode in the DOFSet with the dof value
Return type:

list of NXOpen.CAE.FENode

New in version NX7.5.0.

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

Information

CaeDOFSet.Information

Display information of this DOFSet

Signature Information()

New in version NX7.5.0.

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

ModifyNodeDofs

CaeDOFSet.ModifyNodeDofs

Modify the dofs of the passed in nodes in the CaeDOFSet.

A true for a dof logical entry would mean that the dof is included for that corresponding node. A false would mean that the dof is not included for that node.

Signature ModifyNodeDofs(nodes, dof1, dof2, dof3, dof4, dof5, dof6)

Parameters:
  • nodes (list of NXOpen.CAE.FENode) – Array of nodes to modify the dofs NXOpen.CAE.FENode
  • dof1 (list of bool) – Array of DOF1 values
  • dof2 (list of bool) – Array of DOF2 values
  • dof3 (list of bool) – Array of DOF3 values
  • dof4 (list of bool) – Array of DOF4 values
  • dof5 (list of bool) – Array of DOF5 values
  • dof6 (list of bool) – Array of DOF6 values

New in version NX7.5.0.

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

Print

CaeDOFSet.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

RemoveAllNodes

CaeDOFSet.RemoveAllNodes

Remove all nodes from the CaeDOFSet

Signature RemoveAllNodes()

New in version NX7.5.0.

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

RemoveNodes

CaeDOFSet.RemoveNodes

Remove nodes from the CaeDOFSet.

If the passed in nodes are not there in the DOF Set, the call does nothing.

Signature RemoveNodes(nodes)

Parameters:nodes (list of NXOpen.CAE.FENode) – Array of nodes to Remove NXOpen.CAE.FENode

New in version NX7.5.0.

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

SetLabel

CaeDOFSet.SetLabel

Sets the label of the CaeDOFSet

Signature SetLabel(label)

Parameters:label (int) – Label of the DOFSet

New in version NX7.5.0.

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

SetName

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