Element Class¶
-
class
NXOpen.CAE.Connections.
Element
¶ Bases:
NXOpen.CAE.NamedPropertyTable
,NXOpen.CAE.IExportableFEEntity
This is the class to access a connection element
To obtain an instance of this object use the Create creator in
CAE.Connections.ElementCollection
.New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
DescriptorType | Returns the descriptor name defines the type of the property table in named property table holder |
IsCompatibleType | Returns the compatibility of the element (whether it accepts compatible or incompatible meshes) |
IsOccurrence | Returns whether this object is an occurrence or not. |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
Label | Returns or sets the label of the named property table holder |
LanguageName | Returns the lanugage of the descriptor that defines the type of the property table in named property table holder |
MinBarLength | Returns the min bar length. |
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 |
PropertyTable | Returns the property table of the named property table holder |
Prototype | Returns the prototype of this object if it is an occurrence. |
SolverName | Returns the solver of lanugage of the descriptor that defines the type of the property table in named property table holder |
Status | Returns the status of the element |
Tag | Returns the Tag for this object. |
Type | Returns the type of the element |
Methods¶
Method | Description |
---|---|
AddConnections | Adds connections to this element |
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. |
GenerateElements | Mesh the Connection Element. |
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. |
GetConnections | Gets connections from this element |
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. |
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. |
GetSolverCardSyntax | Returns the solver card syntax strings for this entity. |
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 |
Prints a representation of this object to the system log file. | |
RemoveConnections | Removes a connection from this element. |
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. |
Property Detail¶
IsCompatibleType¶
-
Element.
IsCompatibleType
¶ Returns the compatibility of the element (whether it accepts compatible or incompatible meshes)
-------------------------------------
Getter Method
Signature
IsCompatibleType
Returns: Return type: bool New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
IsOccurrence¶
-
Element.
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¶
-
Element.
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.
MinBarLength¶
-
Element.
MinBarLength
¶ Returns the min bar length.
-------------------------------------
Getter Method
Signature
MinBarLength
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: None.
Name¶
-
Element.
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¶
-
Element.
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¶
-
Element.
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¶
-
Element.
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.
Status¶
-
Element.
Status
¶ Returns the status of the element
-------------------------------------
Getter Method
Signature
Status
Returns: Return type: NXOpen.CAE.Connections.ElementStatusType
New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
Type¶
-
Element.
Type
¶ Returns the type of the element
-------------------------------------
Getter Method
Signature
Type
Returns: Return type: NXOpen.CAE.Connections.ElementType
New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
Method Detail¶
AddConnections¶
-
Element.
AddConnections
¶ Adds connections to this element
Signature
AddConnections(connections)
Parameters: connections (list of NXOpen.CAE.Connections.IConnection
) –New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
FindObject¶
-
Element.
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.
GenerateElements¶
-
Element.
GenerateElements
¶ Mesh the Connection Element.
Signature
GenerateElements()
New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
GetConnections¶
-
Element.
GetConnections
¶ Gets connections from this element
Signature
GetConnections()
Returns: Return type: list of NXOpen.CAE.Connections.IConnection
New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
GetSolverCardSyntax¶
-
Element.
GetSolverCardSyntax
¶ Returns the solver card syntax strings for this entity.
Signature
GetSolverCardSyntax()
Returns: Return type: list of str New in version NX8.5.0.
License requirements: None.
Print¶
-
Element.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
RemoveConnections¶
-
Element.
RemoveConnections
¶ Removes a connection from this element.
This does not delete/destroy the connection, instead this element will no longer keep a reference to the connection.
Signature
RemoveConnections(connections)
Parameters: connections (list of NXOpen.CAE.Connections.IConnection
) –New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
SetName¶
-
Element.
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.