PierceItemBuilder Class

class NXOpen.Die.PierceItemBuilder

Bases: NXOpen.NXObject

Represents a NXOpen.Die.PierceItemBuilder

New in version NX5.0.0.

Properties

Property Description
HoleShape Returns or sets the hole shape
IsOccurrence Returns whether this object is an occurrence or not.
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
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
Prototype Returns the prototype of this object if it is an occurrence.
PunchDiameter Returns the punch radius
PunchLength Returns the punch length
PunchRadius Returns the punch radius
PunchWidth Returns the punch width
ReferenceVector Returns or sets the reference direction of the hole
SizingMethod Returns or sets the sizing method
Tag Returns the Tag for this object.

Methods

Method Description
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.
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.
GetPierceObjects Gets the objects making up the hole to be pierced.
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
Print Prints a representation of this object to the system log file.
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.
SetPierceObjects Sets the objects making up the hole to be pierced.
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.

Enumerations

PierceItemBuilderHoleShapeType Enumeration Settings for the hole shape of individual pierces.
PierceItemBuilderSizingMethodOption Enumeration Settings for the sizing method of individual pierces.

Property Detail

HoleShape

PierceItemBuilder.HoleShape

Returns or sets the hole shape

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

Getter Method

Signature HoleShape

Returns:
Return type:NXOpen.Die.PierceItemBuilderHoleShapeType

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature HoleShape

Parameters:holeShape (NXOpen.Die.PierceItemBuilderHoleShapeType) –

New in version NX5.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

IsOccurrence

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

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

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

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

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

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

PunchDiameter

PierceItemBuilder.PunchDiameter

Returns the punch radius

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

Getter Method

Signature PunchDiameter

Returns:
Return type:NXOpen.Expression

New in version NX5.0.0.

License requirements: None.

PunchLength

PierceItemBuilder.PunchLength

Returns the punch length

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

Getter Method

Signature PunchLength

Returns:
Return type:NXOpen.Expression

New in version NX5.0.0.

License requirements: None.

PunchRadius

PierceItemBuilder.PunchRadius

Returns the punch radius

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

Getter Method

Signature PunchRadius

Returns:
Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

PunchWidth

PierceItemBuilder.PunchWidth

Returns the punch width

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

Getter Method

Signature PunchWidth

Returns:
Return type:NXOpen.Expression

New in version NX5.0.0.

License requirements: None.

ReferenceVector

PierceItemBuilder.ReferenceVector

Returns or sets the reference direction of the hole

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

Getter Method

Signature ReferenceVector

Returns:
Return type:NXOpen.ILocation

New in version NX5.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature ReferenceVector

Parameters:refVector (NXOpen.ILocation) –

New in version NX5.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SizingMethod

PierceItemBuilder.SizingMethod

Returns or sets the sizing method

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

Getter Method

Signature SizingMethod

Returns:
Return type:NXOpen.Die.PierceItemBuilderSizingMethodOption

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature SizingMethod

Parameters:sizingMethod (NXOpen.Die.PierceItemBuilderSizingMethodOption) –

New in version NX5.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

Method Detail

FindObject

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

GetPierceObjects

PierceItemBuilder.GetPierceObjects

Gets the objects making up the hole to be pierced.

Signature GetPierceObjects()

Returns:Objects that make up the hole to be pierced
Return type:list of NXOpen.IProfile

New in version NX5.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

Print

PierceItemBuilder.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetName

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

SetPierceObjects

PierceItemBuilder.SetPierceObjects

Sets the objects making up the hole to be pierced.

Signature SetPierceObjects(objects)

Parameters:objects (list of NXOpen.IProfile) – Objects that make up the hole to be pierced

New in version NX5.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)