nxopen.assemblies

Interface ComponentPattern

All Superinterfaces:

INXObject, NXObject, Remote, TaggedObject

public interface ComponentPattern
extends NXObject

Represents the component pattern class.
To create or edit an instance of this class, use ComponentPatternBuilder

Created in NX9.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface nxopen.NXObject

NXObject.AttributeInformation, NXObject.AttributeType, NXObject.ComputationalTime, NXObject.DateAndTimeFormat

Method Summary

Modifier and Type	Method and Description
void	changeReferencePatternTemplate(int firstBaseInstanceIndex, int secondBaseInstanceIndex) Changes the template component of a reference pattern to a pattern member at indices (firstBaseInstanceIndex, secondBaseInstanceIndex).
void	delete(boolean deleteComponents) Deletes the component pattern object.
void	displayInformation() Displays the information of the component pattern.
PatternMember[]	getAllPatternMembers() Returns all the pattern members.
Component[]	getComponentsToPattern() Gets all the Assemblies.Component that are selected for component pattern.
boolean	getPatternDeferredStatus() Gets the deferred status of the component pattern.
String	getPatternName() Gets the component pattern name.
boolean	getPatternSuppressedStatus() Gets the suppressed status of the component pattern.
PartLoadStatus	loadRelatedGeometry() Loads the parts containing data referenced by this pattern, including the parts that are patterned and parts containing the objects that define the pattern parameters.
void	suppress() Suppresses the component pattern object.
void	unsuppress() Unsuppresses the component pattern object.

Methods inherited from interface nxopen.NXObject

deleteAllAttributesByType, deleteAllAttributesByType, deleteAttributeByTypeAndTitle, deleteAttributeByTypeAndTitle, deleteUserAttribute, deleteUserAttributes, getAttributeTitlesByType, getBooleanUserAttribute, getComputationalTimeUserAttribute, getIntegerAttribute, getIntegerUserAttribute, getRealAttribute, getRealUserAttribute, getReferenceAttribute, getStringAttribute, getStringUserAttribute, getTimeAttribute, getTimeUserAttribute, getUserAttribute, getUserAttribute, getUserAttributeAsString, getUserAttributeCount, getUserAttributeCount, getUserAttributeLock, getUserAttributes, getUserAttributes, getUserAttributes, getUserAttributesAsStrings, getUserAttributeSize, getUserAttributeSourceObjects, hasUserAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBooleanUserAttribute, setReferenceAttribute, setReferenceAttribute, setTimeAttribute, setTimeAttribute, setTimeUserAttribute, setTimeUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttribute, setUserAttributeLock

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.INXObject

findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName

Method Detail

delete

void delete(boolean deleteComponents)
     throws NXException,
            RemoteException

Deletes the component pattern object.
License requirements: assemblies ("ASSEMBLIES MODULE")

Created in NX9.0.0

Parameters:

deleteComponents -

Throws:

NXException

RemoteException

suppress

void suppress()
       throws NXException,
              RemoteException

Suppresses the component pattern object.
License requirements: assemblies ("ASSEMBLIES MODULE")

Created in NX9.0.0

Throws:

NXException

RemoteException

unsuppress

void unsuppress()
         throws NXException,
                RemoteException

Unsuppresses the component pattern object.
License requirements: assemblies ("ASSEMBLIES MODULE")

Created in NX9.0.0

Throws:

NXException

RemoteException

displayInformation

void displayInformation()
                 throws NXException,
                        RemoteException

Displays the information of the component pattern.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

loadRelatedGeometry

PartLoadStatus loadRelatedGeometry()
                            throws NXException,
                                   RemoteException

Loads the parts containing data referenced by this pattern, including the parts that are patterned and parts containing the objects that define the pattern parameters.
License requirements: assemblies ("ASSEMBLIES MODULE")

Created in NX9.0.0

Returns:

Error information for any part that could not be loaded.

Throws:

NXException

RemoteException

getPatternName

String getPatternName()
               throws NXException,
                      RemoteException

Gets the component pattern name.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

getPatternSuppressedStatus

boolean getPatternSuppressedStatus()
                            throws NXException,
                                   RemoteException

Gets the suppressed status of the component pattern.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

getPatternDeferredStatus

boolean getPatternDeferredStatus()
                          throws NXException,
                                 RemoteException

Gets the deferred status of the component pattern.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

getAllPatternMembers

PatternMember[] getAllPatternMembers()
                              throws NXException,
                                     RemoteException

Returns all the pattern members.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

getComponentsToPattern

Component[] getComponentsToPattern()
                            throws NXException,
                                   RemoteException

Gets all the Assemblies.Component that are selected for component pattern.
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

changeReferencePatternTemplate

void changeReferencePatternTemplate(int firstBaseInstanceIndex,
                                    int secondBaseInstanceIndex)
                             throws NXException,
                                    RemoteException

Changes the template component of a reference pattern to a pattern member at indices (firstBaseInstanceIndex, secondBaseInstanceIndex).
License requirements: None.

Created in NX9.0.0

Parameters:

firstBaseInstanceIndex -

secondBaseInstanceIndex -

Throws:

NXException

RemoteException