FEModelOccurrence Class

class NXOpen.CAE.FEModelOccurrence

Bases: NXOpen.CAE.IFEModel, NXOpen.CAE.IHierarchicalFEModel, NXOpen.CAE.IPostScenarioDataSource

This class represents a Finite Element Model Occurrence. Only one instance of this class will exist in each sim part file

An instance of this class can not be obtained

New in version NX5.0.0.

Properties

Property Description
ConnectionsContainer Returns the universal connection container.
FeelementLabelMap Returns a CAE.FEElement Label to CAE.FEElement Map for this Interface to the Finite Element Model.
FenodeLabelMap Returns a CAE.FENode Label to CAE.FENode Map for this Interface to the Finite Element Model.
IsOccurrence Returns whether this object is an occurrence or not.
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
MeshManager Returns the IMeshManager
Name Returns the custom name of the object.
OwningComponent Returns the owning component, if this object is an occurrence.
OwningPart Returns the owning part of this object
Parent Returns the parent fem of this object, can be None
Prototype Returns the prototype of this object if it is an occurrence.
Tag Returns the Tag for this object.

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
Find Finds the object within the NXOpen.CAE.FEModelOccurrence context, 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.
GetAttributes Get the femodel occurrence attributes
GetBooleanUserAttribute Gets a boolean attribute by Title and array Index.
GetChildren Returns the child components of this component
GetComponent Gets the NXOpen.Assemblies.Component associated with this object
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.
GetLabelOffsets Returns node, element, and csys offset of the femodel occurrence
GetNextUserAttribute Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetOccEntityLabelOffsets Returns node, element, csys, physical, group, and ply offset of the femodel occurrence
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
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.
SetLabelOffsets Sets node, element, and csys offset of the femodel occurrence
SetName Sets the custom name of the object.
SetOccEntityLabelOffsets Sets node, element, csys, physical, group, and ply offset of the femodel occurrence
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

IsOccurrence

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

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

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

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

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

Parent

FEModelOccurrence.Parent

Returns the parent fem of this object, can be None

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

Getter Method

Signature Parent

Returns:The parent
Return type:NXOpen.CAE.IFEModel

New in version NX6.0.0.

License requirements: None.

Prototype

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

Find

FEModelOccurrence.Find

Finds the object within the NXOpen.CAE.FEModelOccurrence context, with the given identifier as recorded in a journal.

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:Object with the journal identifier
Return type:NXOpen.TaggedObject

New in version NX3.0.0.

License requirements: None.

FindObject

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

GetAttributes

FEModelOccurrence.GetAttributes

Get the femodel occurrence attributes

Signature GetAttributes()

Returns:
Return type:NXOpen.CAE.FEModelOccAttribute

New in version NX8.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

GetChildren

FEModelOccurrence.GetChildren

Returns the child components of this component

Signature GetChildren()

Returns:
Return type:list of NXOpen.CAE.FEModelOccurrence

New in version NX6.0.0.

License requirements: None.

GetComponent

FEModelOccurrence.GetComponent

Gets the NXOpen.Assemblies.Component associated with this object

Signature GetComponent()

Returns:
Return type:NXOpen.Assemblies.Component

New in version NX6.0.0.

License requirements: None.

GetLabelOffsets

FEModelOccurrence.GetLabelOffsets

Returns node, element, and csys offset of the femodel occurrence

Signature GetLabelOffsets()

Returns:a tuple
Return type:A tuple consisting of (nodeOffset, elemOffset, csysOffset) nodeOffset is a int. node offset elemOffset is a int. element offset csysOffset is a int. csys offset

New in version NX6.0.0.

Deprecated since version NX12.0.0: Use :py:meth:`NXOpen.CAE.FEModelOccurrence.GetOccEntityLabelOffsets`instead.

License requirements: nx_masterfem (“Finite Element Modeling”)

GetOccEntityLabelOffsets

FEModelOccurrence.GetOccEntityLabelOffsets

Returns node, element, csys, physical, group, and ply offset of the femodel occurrence

Signature GetOccEntityLabelOffsets()

Returns:a tuple
Return type:A tuple consisting of (nodeOffset, elemOffset, csysOffset, physOffset, groupOffset, plyOffset) nodeOffset is a int. node offset elemOffset is a int. element offset csysOffset is a int. csys offset physOffset is a int. physical offset groupOffset is a int. group offset plyOffset is a int. ply offset

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

Print

FEModelOccurrence.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetLabelOffsets

FEModelOccurrence.SetLabelOffsets

Sets node, element, and csys offset of the femodel occurrence

Signature SetLabelOffsets(nodeOffset, elemOffset, csysOffset)

Parameters:
  • nodeOffset (int) – node offset
  • elemOffset (int) – element offset
  • csysOffset (int) – csys offset

New in version NX6.0.0.

Deprecated since version NX12.0.0: Use :py:meth:`NXOpen.CAE.FEModelOccurrence.SetOccEntityLabelOffsets`instead.

License requirements: nx_masterfem (“Finite Element Modeling”)

SetName

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

SetOccEntityLabelOffsets

FEModelOccurrence.SetOccEntityLabelOffsets

Sets node, element, csys, physical, group, and ply offset of the femodel occurrence

Signature SetOccEntityLabelOffsets(nodeOffset, elemOffset, csysOffset, physOffset, groupOffset, plyOffset)

Parameters:
  • nodeOffset (int) – node offset
  • elemOffset (int) – element offset
  • csysOffset (int) – csys offset
  • physOffset (int) – physical offset
  • groupOffset (int) – group offset
  • plyOffset (int) – ply offset

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)