ReferencePattern Class

class NXOpen.GeometricUtilities.ReferencePattern

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

the reference pattern definition.

New in version NX8.0.0.

Properties

Property	Description
ReferencedPattern	Returns the referenced pattern object.
Tag	Returns the Tag for this object.

Methods

Method	Description
ResetBaseInstance	Reset the base instance indices to an undefined state.
SetBaseInstance	Set the base instance
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

ReferencedPattern

ReferencePattern.ReferencedPattern

Returns the referenced pattern object.

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

Getter Method

Signature ReferencedPattern

Returns: Return type:NXOpen.SelectNXObject

New in version NX8.0.0.

License requirements: None.

Method Detail

ResetBaseInstance

ReferencePattern.ResetBaseInstance

Reset the base instance indices to an “undefined” state.

The base instance will be reset so that the indices do not correspond to indices from any instance of the referenced pattern selected. The base instance indices must be set after this call before commit.

Signature ResetBaseInstance()

New in version NX8.0.0.

License requirements: None.

SetBaseInstance

ReferencePattern.SetBaseInstance

Set the base instance

Signature SetBaseInstance(firstIndex, secondIndex)

Parameters:

• firstIndex (int) –
• secondIndex (int) –

New in version NX8.0.0.

License requirements: None.

Validate

ReferencePattern.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.