Rigid Class¶
-
class
NXOpen.CAE.Connections.
Rigid
¶ Bases:
NXOpen.CAE.Connections.IConnection
,NXOpen.CAE.Connections.IDof
,NXOpen.CAE.Connections.ICsys
,NXOpen.CAE.Connections.INodalTargetsContainer
,NXOpen.CAE.Connections.INodalTargetsPairing
Rigid connection.
Use this interface to set/get properties and parameters of the Rigid connection. .. versionadded:: NX12.0.0
Properties¶
Property | Description |
---|---|
Color | Returns or sets the color of the object. |
Csys | Returns or sets the csys |
CsysType | Returns or sets the csys type |
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 |
PairingMethod | Returns or sets the pairing method of targets |
Prototype | Returns the prototype of this object if it is an occurrence. |
SearchConeAngle | Returns the search cone angle |
SearchOrientation | Returns or sets the pairing search orientation |
SearchRange | Returns the search range |
Tag | Returns the Tag for this object. |
UserDescription | Returns or sets the connection user description |
Methods¶
Method | Description |
---|---|
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. |
GetDof | Get the specified degrees of freedom |
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. |
GetStringAttribute | Gets a string attribute value by title. |
GetStringUserAttribute | Gets a string attribute by Title and array Index. |
GetSupportedCsysTypes | Gets supported csys types of connection. |
GetTarget | Get target |
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. |
Prints a representation of this object to the system log file. | |
RedisplayObject | Redisplays the object in all views. |
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. |
SetDof | Set the specified degrees of freedom |
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. |
SetTargetType | Set the target type |
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¶
Csys¶
-
Rigid.
Csys
¶ Returns or sets the csys
-------------------------------------
Getter Method
Signature
Csys
Returns: Return type: NXOpen.CoordinateSystem
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Csys
Parameters: csys ( NXOpen.CoordinateSystem
) –New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
CsysType¶
-
Rigid.
CsysType
¶ Returns or sets the csys type
-------------------------------------
Getter Method
Signature
CsysType
Returns: Return type: NXOpen.CAE.Connections.CsysType
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CsysType
Parameters: csysType ( NXOpen.CAE.Connections.CsysType
) –New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
IsOccurrence¶
-
Rigid.
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¶
-
Rigid.
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¶
-
Rigid.
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¶
-
Rigid.
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¶
-
Rigid.
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.
PairingMethod¶
-
Rigid.
PairingMethod
¶ Returns or sets the pairing method of targets
-------------------------------------
Getter Method
Signature
PairingMethod
Returns: Return type: NXOpen.CAE.Connections.NodalPairingMethod
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PairingMethod
Parameters: method ( NXOpen.CAE.Connections.NodalPairingMethod
) –New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
Prototype¶
-
Rigid.
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.
SearchConeAngle¶
-
Rigid.
SearchConeAngle
¶ Returns the search cone angle
-------------------------------------
Getter Method
Signature
SearchConeAngle
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: None.
SearchOrientation¶
-
Rigid.
SearchOrientation
¶ Returns or sets the pairing search orientation
-------------------------------------
Getter Method
Signature
SearchOrientation
Returns: Return type: NXOpen.Direction
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SearchOrientation
Parameters: orientation ( NXOpen.Direction
) –New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
SearchRange¶
-
Rigid.
SearchRange
¶ Returns the search range
-------------------------------------
Getter Method
Signature
SearchRange
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: None.
Method Detail¶
FindObject¶
-
Rigid.
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.
GetDof¶
-
Rigid.
GetDof
¶ Get the specified degrees of freedom
Signature
GetDof(dof)
Parameters: dof ( NXOpen.CAE.Connections.Dof
) –Returns: Return type: NXOpen.CAE.Connections.DofType
New in version NX12.0.0.
License requirements: None.
GetSupportedCsysTypes¶
-
Rigid.
GetSupportedCsysTypes
¶ Gets supported csys types of connection.
Signature
GetSupportedCsysTypes()
Returns: Supported CSys Types Return type: list of NXOpen.CAE.Connections.CsysType
New in version NX12.0.0.
License requirements: None.
GetTarget¶
-
Rigid.
GetTarget
¶ Get target
Signature
GetTarget(index)
Parameters: index (int) – Returns: Return type: NXOpen.CAE.Connections.NodalTarget
New in version NX12.0.0.
License requirements: None.
Print¶
-
Rigid.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetDof¶
-
Rigid.
SetDof
¶ Set the specified degrees of freedom
Signature
SetDof(dof, type)
Parameters: - dof (
NXOpen.CAE.Connections.Dof
) – - type (
NXOpen.CAE.Connections.DofType
) –
New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
- dof (
SetName¶
-
Rigid.
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.
SetTargetType¶
-
Rigid.
SetTargetType
¶ Set the target type
Signature
SetTargetType(index, type)
Parameters: - index (int) –
- type (
NXOpen.CAE.Connections.NodalTargetType
) –
New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)