CoordinateSystem Class¶
-
class
NXOpen.CoordinateSystem¶ Bases:
NXOpen.SmartObject,NXOpen.ILocation,NXOpen.IOrientation,NXOpen.CAE.IExportableFEEntityRepresents a coordinate system
This is an abstract class
New in version NX3.0.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. |
| IsTemporary | Returns true if the coordinate system is temporary, which means that the object is not saved in the part file |
| JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
| Label | Returns or sets the label of the coordinate system |
| 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 or sets the name of the coordinate system |
| NameLocation | Returns the location of the object’s name. |
| Orientation | Returns the orientation matrix of the coordinate system |
| Origin | Returns or sets the origin of the coordinate system |
| 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. |
| Update | Returns the update option. |
| Visibility | Returns the visibility. |
Methods¶
| Method | Description |
|---|---|
| Blank | Blanks the object. |
| 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 encountered with the given Type with option to update or not. |
| Evaluate | Evaluate a smart object. |
| 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. |
| GetDirections | Returns the orientation of the coordinate system |
| GetIntegerAttribute | Gets an integer attribute by title. |
| GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
| 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, of the given type. |
| 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. |
| GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
| HasUserAttribute | Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. |
| Highlight | Highlights the object. |
| Prints a representation of this object to the system log file. | |
| RedisplayObject | Redisplays the object in all views. |
| RemoveParameters | Removes the smart object parameters. |
| RemoveViewDependency | Remove dependency on all views from an object. |
| ReplaceParameters | Edit a smart object by replacing its parameters using parameters of other smart object of the same class. |
| SetAttribute | Creates or modifies an integer attribute. |
| SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
| SetDirections | The orientation of the coordinate system |
| SetNameLocation | Sets the location of the object’s name. |
| 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. |
| SetVisibility | Sets the visibility. |
| Unblank | Unblanks the object. |
| Unhighlight | Unhighlights the object. |
Property Detail¶
IsOccurrence¶
-
CoordinateSystem.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.
IsTemporary¶
-
CoordinateSystem.IsTemporary¶ Returns true if the coordinate system is temporary, which means that the object is not saved in the part file
-------------------------------------Getter Method
Signature
IsTemporary()Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
CoordinateSystem.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.
Label¶
-
CoordinateSystem.Label¶ Returns or sets the label of the coordinate system
-------------------------------------Getter Method
Signature
Label()Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Label(label)Parameters: label (int) – New in version NX6.0.0.
License requirements: None.
Name¶
-
CoordinateSystem.Name¶ Returns or sets the name of the coordinate system
-------------------------------------Getter Method
Signature
Name()Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Name(name)Parameters: name (str) – New in version NX6.0.0.
License requirements: None.
Orientation¶
-
CoordinateSystem.Orientation¶ Returns the orientation matrix of the coordinate system
-------------------------------------Getter Method
Signature
Orientation()Returns: Cartesian, cylindrical or spherical orientation matrix This parameter may not be None. Return type: NXOpen.NXMatrixNew in version NX3.0.0.
License requirements: None.
Origin¶
-
CoordinateSystem.Origin¶ Returns or sets the origin of the coordinate system
-------------------------------------Getter Method
Signature
Origin()Returns: Return type: NXOpen.Point3dNew in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Origin(origin)Parameters: origin ( NXOpen.Point3d) –New in version NX5.0.0.
License requirements: None.
OwningComponent¶
-
CoordinateSystem.OwningComponent¶ Returns the owning component, if this object is an occurrence.
-------------------------------------Getter Method
Signature
OwningComponent()Returns: Return type: NXOpen.Assemblies.ComponentNew in version NX3.0.0.
License requirements: None.
OwningPart¶
-
CoordinateSystem.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.BasePartNew in version NX3.0.0.
License requirements: None.
Prototype¶
-
CoordinateSystem.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.INXObjectNew in version NX3.0.0.
License requirements: None.
Method Detail¶
FindObject¶
-
CoordinateSystem.FindObject¶ Finds the
NXOpen.NXObjectwith 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.INXObjectNew in version NX3.0.0.
License requirements: None.
GetDirections¶
-
CoordinateSystem.GetDirections¶ Returns the orientation of the coordinate system
Signature
GetDirections()Returns: a tuple Return type: A tuple consisting of (xDirection, yDirection). xDirection is a NXOpen.Vector3d. yDirection is aNXOpen.Vector3d.New in version NX5.0.0.
License requirements: None.
GetSolverCardSyntax¶
-
CoordinateSystem.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¶
-
CoordinateSystem.Print¶ Prints a representation of this object to the system log file.
Signature
Print()New in version NX3.0.0.
License requirements: None.
SetDirections¶
-
CoordinateSystem.SetDirections¶ The orientation of the coordinate system
Signature
SetDirections(xDirection, yDirection)Parameters: - xDirection (
NXOpen.Vector3d) – - yDirection (
NXOpen.Vector3d) –
New in version NX5.0.0.
License requirements: None.
- xDirection (