Axis Class

class NXOpen.Axis

Bases: NXOpen.SmartObject

Represents an NXOpen.Axis class.

To create a new instance of this class, use NXOpen.AxisCollection.CreateAxis()

New in version NX3.0.1.

Properties

Property Description
Color Returns or sets the color of the object.
Direction Returns or sets the direction that the axis points for an axis with type NXOpen.AxisTypes.PointAndDirection.
DirectionVector Returns the direction vector
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.
Origin Returns the origin
OwningComponent Returns the owning component, if this object is an occurrence.
OwningPart Returns the owning part of this object
Point Returns or sets the point that defines the origin of the axis for an axis with type NXOpen.AxisTypes.PointAndDirection.
Prototype Returns the prototype of this object if it is an occurrence.
Tag Returns the Tag for this object.
Type Returns the associativity type for the axis
Update Returns the update option.
Visibility Returns the visibility.

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
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.
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.
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.
Print Prints a representation of this object to the system log file.
ProtectFromDelete Protects the SmartObject from being deleted if any referencing objects are deleted.
RedisplayObject Redisplays the object in all views.
ReleaseDeleteProtection Removes delete protection from the SmartObject.
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.
SetDirectionVector Sets the direction vector for a non-associative axis.
SetName Sets the custom name of the object.
SetNameLocation Sets the location of the object’s name.
SetOrigin Sets the origin for a non-associative axis.
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.
SetVisibility Sets the visibility.
Unblank Unblanks the object.
Unhighlight Unhighlights the object.

Enumerations

AxisTypes Enumeration Defines types of axes based on their associativity

Property Detail

Direction

Axis.Direction

Returns or sets the direction that the axis points for an axis with type NXOpen.AxisTypes.PointAndDirection.

An exception is thrown if the axis type is not NXOpen.AxisTypes.PointAndDirection,

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

Getter Method

Signature Direction

Returns:
Return type:NXOpen.Direction

New in version NX3.0.1.

License requirements: None.

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

Setter Method

Signature Direction

Parameters:direction (NXOpen.Direction) – This parameter may not be None.

New in version NX3.0.1.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

DirectionVector

Axis.DirectionVector

Returns the direction vector

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

Getter Method

Signature DirectionVector

Returns:
Return type:NXOpen.Vector3d

New in version NX5.0.0.

License requirements: None.

IsOccurrence

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

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

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

Origin

Axis.Origin

Returns the origin

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

Getter Method

Signature Origin

Returns:
Return type:NXOpen.Point3d

New in version NX5.0.0.

License requirements: None.

OwningComponent

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

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

Point

Axis.Point

Returns or sets the point that defines the origin of the axis for an axis with type NXOpen.AxisTypes.PointAndDirection.

An exception is thrown if the axis type is not NXOpen.AxisTypes.PointAndDirection, If the axis type is point and direction and the point is not specified, the point is inferred from the direction.

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

Getter Method

Signature Point

Returns:
Return type:NXOpen.Point

New in version NX3.0.1.

License requirements: None.

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

Setter Method

Signature Point

Parameters:point (NXOpen.Point) –

New in version NX3.0.1.

License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR geometric_tol (“GDT”) OR insp_programming (“INSPECTION PROGRAMMING”)

Prototype

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

Type

Axis.Type

Returns the associativity type for the axis

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

Getter Method

Signature Type

Returns:
Return type:NXOpen.AxisTypes

New in version NX5.0.0.

License requirements: None.

Method Detail

FindObject

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

Print

Axis.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetDirectionVector

Axis.SetDirectionVector

Sets the direction vector for a non-associative axis.

This method does nothing if the axis is associative

Signature SetDirectionVector(vector)

Parameters:vector (NXOpen.Vector3d) –

New in version NX5.0.0.

License requirements: None.

SetName

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

SetOrigin

Axis.SetOrigin

Sets the origin for a non-associative axis.

This method does nothing if the axis is associative

Signature SetOrigin(origin)

Parameters:origin (NXOpen.Point3d) –

New in version NX5.0.0.

License requirements: None.