DraftingSurfaceFinish Class

class NXOpen.Annotations.DraftingSurfaceFinish

Bases: NXOpen.Annotations.BaseSurfaceFinish

Represents a Drafting Surface Finish

To create or edit an instance of this class, use NXOpen.Annotations.DraftingSurfaceFinishBuilder

New in version NX7.5.0.

Properties

Property	Description
AnnotationOrigin	Returns or sets the origin (location) of the annotation.
AnnotationPlane	Returns or sets the annotation plane.
Color	Returns or sets the color of the object.
HasAssociativeOrigin	Returns a flag indicating whether the origin is associative
IsBlanked	Returns the blank status of this object.
IsOccurrence	Returns whether this object is an occurrence or not.
IsRetained	Returns a flag indicating whether the annotation is retained
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.
LeaderOrientation	Returns or sets the leader orientation for the annotation.
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.
NumberOfAssociativities	Returns the number of associativities for the annotation.
OwningComponent	Returns the owning component, if this object is an occurrence.
OwningPart	Returns the owning part of this object
ParallelToScreen	Returns or sets the PMI parallel to screen setting
Prototype	Returns the prototype of this object if it is an occurrence.
Suppressed	Returns the flag indicating whether the annotation is suppressed
Tag	Returns the Tag for this object.

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.
GetAssociativeOrigin	Gets data that specifies the origin’s associativity
GetAssociativity	Returns the associativity at specified index.
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.
GetInferredAnnotationPlane	Returns the inferred annotation plane
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
GetInvertSymbol	Return the invert symbol flag for symbol having flag type leader
GetLetteringPreferences	Returns the lettering preferences for the annotation
GetLineAndArrowPreferences	Returns the line and arrow preferences for the annotation
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.
GetSymbolPreferences	Returns the symbol preferences for the annotation
GetTimeAttribute	Gets a time attribute by title.
GetTimeUserAttribute	Gets a time attribute by Title and array Index.
GetTolerance	Returns the tolerance
GetUnitsFormatPrefs	Returns the unit format preferences
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.
GetViews	Returns the views that the PMI display instance object is displayed in NOTE: This method is only valid for PMI display instance objects.
HasUserAttribute	Determines if an attribute exists on the object, that satisfies the given iterator
Highlight	Highlights the object.
InsertIntoStack	Inserts the annotation into a stack.
Print	Prints a representation of this object to the system log file.
RedisplayObject	Redisplays the object in all views.
RemoveFromStack	Removes the annotation from a stack.
RemoveViewDependency	Remove dependency on all views from an object.
SetAssociativeOrigin	Associates the annotation’s origin to the specified geometry.
SetAssociativity	Sets the associativity at specified index.
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
SetInvertSymbol	Set the invert symbol flag for symbol having flag type leader.
SetLetteringPreferences	Sets the lettering preferences for the annotation.
SetLineAndArrowPreferences	Sets the line and arrow preferences for the annotation.
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.
SetSymbolPreferences	Sets the symbol preferences for the annotation.
SetTimeAttribute	Creates or modifies a time attribute.
SetTimeUserAttribute	Creates or modifies a time attribute with the option to update or not.
SetTolerance	Sets the tolerance.
SetUnitsFormatPrefs	Sets the unit format preferences.
SetUserAttribute	Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock	Lock or unlock the given attribute.
SetViews	Sets the views that the PMI display instance object is displayed in.
Unblank	Unblanks the object.
Unhighlight	Unhighlights the object.

Property Detail

IsOccurrence

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

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

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

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

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

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

FindObject

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

GetTolerance

DraftingSurfaceFinish.GetTolerance

Returns the tolerance

Signature GetTolerance()

Returns: Return type:NXOpen.Annotations.LinearTolerance

New in version NX4.0.0.

License requirements: None.

Print

DraftingSurfaceFinish.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

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

SetTolerance

DraftingSurfaceFinish.SetTolerance

Sets the tolerance.

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 SetTolerance(tolerance)

Parameters:tolerance (NXOpen.Annotations.LinearTolerance) –

New in version NX4.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)