nxopen.partfamily

Interface TemplateManager

All Superinterfaces:

Remote, TransientObject

public interface TemplateManager
extends TransientObject

This class serves as the manager for all the part family related operations. All operations that create, edit or delete part family objects are done through this class. Use the method Part.newPartFamilyTemplateManager() to create new instance of this class.
Created in NX9.0.0

Method Summary

Modifier and Type	Method and Description
void	addAssertedMassToChosenAttributes(String attrToAdd, int indexAddAt) Adds new attribute of type asserted mass to chosen attributes list of a part family License requirements: adv_assemblies ("ADVANCED ASSEMBLIES"), solid_modeling ("SOLIDS MODELING") .
InstanceDefinition	addInstanceDefinition(String familyMemberDefnName, InstanceDefinition previousFamilyMemberDefn, String otherNameEntry) Creates a new family member definition with the supplied name and places it just under previous family member definition.
InstanceDefinition	addInstanceDefinitionUsingMemberIdentifier(MemberIdentifier familyMemberIdentifier, InstanceDefinition previousFamilyMemberDefn, String otherNameEntry) Creates a new family member definition with the supplied member identifier places it just under previous family member definition.
FamilyAttribute[]	addOptionalCreationNonKeyAttrsToChosenAttrs(FamilyAttribute pasteAfter) Add all optional creation non key attributes to chosen list at the end or after a selected attribute from chosen attribute list.
void	addToChosenAttributes(String[] attrsToAdd, FamilyAttribute.AttrType[] attrsTypes, int indexAddAt) Adds new attributes to chosen attributes list of a part family License requirements: solid_modeling ("SOLIDS MODELING") .
MemberIdentifier	createMemberIdentifier(FamilyAttribute[] keyAttrs, String[] attrValues, String itemType) Creates a member identifier for a part family member from the key attributes and value pair.
Template	createPartFamily() Creates a part family associated with the owning part License requirements: solid_modeling ("SOLIDS MODELING") .
void	cutAttributes(FamilyAttribute[] cutAttrs) Cut selected attributes of a part family.
void	deleteInstanceDefinition(InstanceDefinition familyMemberDefinition) Delete the family member definition from template manager License requirements: solid_modeling ("SOLIDS MODELING") .
void	deletePartFamily() Deletes a part family associated with the manager/owning part License requirements: solid_modeling ("SOLIDS MODELING") .
void	deletePartFamilyAttribute(FamilyAttribute partFamilyAttribute) Deletes a given part family attribute License requirements: solid_modeling ("SOLIDS MODELING") .
void	editPartFamily() Edits a part family associated with the manager/owning part License requirements: solid_modeling ("SOLIDS MODELING") .
String	establishFamilyInstance(String memberName) Creates a part family member if it doesn't exist on disk.
FamilyAttribute[]	getAllKeyAttrs() Obtains all key attributes (required and optional) required to construct the MFK ID.
FamilyAttribute[]	getChosenAttributes() Returns the attributes on the template manager These might include the attributes which have not yet been committed onto the core object and have only been created by this instance of the manager.
String[]	getInfoMessages() Obtains the list of messages that may have been encountered in any workflow.
InstanceDefinition	getInstanceDefinition(String familyMemberDefnName) Get the family member definition already present in family License requirements: solid_modeling ("SOLIDS MODELING") .
InstanceDefinition	getInstanceDefinitionUsingMemberIdentifier(MemberIdentifier familyMemberIdentifier) Obtains the family member definition already present in family A non zero return code implies familyMemberDefinition is NULL License requirements: solid_modeling ("SOLIDS MODELING") .
FamilyAttribute	getPartFamilyAttribute(FamilyAttribute.AttrType attrType, String attrName) Get the part family attribute from part family template License requirements: solid_modeling ("SOLIDS MODELING") .
Template	getPartFamilyTemplate() Get the part family template This method may return NULL if there is no template associated with the templatemanager License requirements: solid_modeling ("SOLIDS MODELING") .
String[]	getSelectableAttributes(FamilyAttribute.AttrType attrType) The list of attribute names of a given type in the owning part These can be used to create part family attributes License requirements: solid_modeling ("SOLIDS MODELING") .
boolean	importable() Returns the importable flag value License requirements: solid_modeling ("SOLIDS MODELING") .
int	moveDownAttributes(FamilyAttribute[] moveDownAttrs, int moveDownCount) Move down the specified attributes of a part family by the moveDownCount.
int	moveUpAttributes(FamilyAttribute[] moveUpAttrs, int moveUpCount) Move up the specified attributes of a part family by the moveUpCount.
void	pasteAttributes(FamilyAttribute pasteAfter) Paste the cut attributes of a part family.
void	refreshDefaultAttrs() Repopulates required attributes in chosen list so that it updates as per the teamcenter customizations, if it has changed since last saved template.
void	reorderInstanceDefinition(InstanceDefinition familyMemberDefinition, InstanceDefinition previousFamilyMemberDefn) Reorder (relocate) familyMemberDefinition just after the previousFamilyMemberDefn License requirements: solid_modeling ("SOLIDS MODELING") .
String	saveDirectory() Returns the save directory path value License requirements: solid_modeling ("SOLIDS MODELING") .
int	saveFamilyAndApplyValues(InstanceDefinition familyMemberDefinition) Save part family and apply the values of chosen family member definition to the template part, It returns failure codes through errorCode.
int[]	saveFamilyAndCreateMembers(InstanceDefinition[] instDefsToCreate) Save part family and create the family members supplied through input array.
int[]	saveFamilyAndFixOrphanMembers(boolean forceUpdate, InstanceDefinition[] instDefsToFix) Save part family and fix the orphan family members supplied through input array.
int[]	saveFamilyAndUpdateMembers(boolean forceUpdate, InstanceDefinition[] instDefsToUpdate) Save part family and update the family members supplied through input array.
void	savePartFamily() Save the changes in template manager to core part family License requirements: solid_modeling ("SOLIDS MODELING") .
void	setImportable(boolean isImportable) License requirements: solid_modeling ("SOLIDS MODELING") .
void	setSaveDirectory(String saveDirectory) License requirements: solid_modeling ("SOLIDS MODELING") .

Methods inherited from interface nxopen.TransientObject

_value, dispose, printTestData, printTestData

Method Detail

getSelectableAttributes

String[] getSelectableAttributes(FamilyAttribute.AttrType attrType)
                          throws NXException,
                                 RemoteException

The list of attribute names of a given type in the owning part These can be used to create part family attributes
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Parameters:

attrType -

Throws:

NXException

RemoteException

deletePartFamilyAttribute

void deletePartFamilyAttribute(FamilyAttribute partFamilyAttribute)
                        throws NXException,
                               RemoteException

Deletes a given part family attribute
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Parameters:

partFamilyAttribute -

Throws:

NXException

RemoteException

getChosenAttributes

FamilyAttribute[] getChosenAttributes()
                               throws NXException,
                                      RemoteException

Returns the attributes on the template manager These might include the attributes which have not yet been committed onto the core object and have only been created by this instance of the manager. "Use Template.getAttributes() to get the committed attributes"
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX9.0.0

Throws:

NXException

RemoteException

addToChosenAttributes

void addToChosenAttributes(String[] attrsToAdd,
                           FamilyAttribute.AttrType[] attrsTypes,
                           int indexAddAt)
                    throws NXException,
                           RemoteException

Adds new attributes to chosen attributes list of a part family
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Parameters:

attrsToAdd -

attrsTypes -

indexAddAt -

Throws:

NXException

RemoteException

addAssertedMassToChosenAttributes

void addAssertedMassToChosenAttributes(String attrToAdd,
                                       int indexAddAt)
                                throws NXException,
                                       RemoteException

Adds new attribute of type asserted mass to chosen attributes list of a part family
License requirements: adv_assemblies ("ADVANCED ASSEMBLIES"), solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Parameters:

attrToAdd -

indexAddAt -

Throws:

NXException

RemoteException

moveDownAttributes

int moveDownAttributes(FamilyAttribute[] moveDownAttrs,
                       int moveDownCount)
                throws NXException,
                       RemoteException

Move down the specified attributes of a part family by the moveDownCount. If the attributes cannot be moved down by the specified count, this method will execute the partial move and return the count that the attributes are actually moved down by.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX9.0.0

Parameters:

moveDownAttrs -

moveDownCount -

Throws:

NXException

RemoteException

moveUpAttributes

int moveUpAttributes(FamilyAttribute[] moveUpAttrs,
                     int moveUpCount)
              throws NXException,
                     RemoteException

Move up the specified attributes of a part family by the moveUpCount. If the attributes cannot be moved up by the specified count, this method will execute the partial move and return the count that the attributes are actually moved up by.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX9.0.0

Parameters:

moveUpAttrs -

moveUpCount -

Throws:

NXException

RemoteException

cutAttributes

void cutAttributes(FamilyAttribute[] cutAttrs)
            throws NXException,
                   RemoteException

Cut selected attributes of a part family. These will be pasted during paste operation. If previously cut attributes are present then they will be lost because the new ones will overwrite them.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX9.0.0

Parameters:

cutAttrs -

Throws:

NXException

RemoteException

pasteAttributes

void pasteAttributes(FamilyAttribute pasteAfter)
              throws NXException,
                     RemoteException

Paste the cut attributes of a part family. The pasteAfter attribute must be present in chosen attributes list for this operation to succeed.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX9.0.0

Parameters:

pasteAfter -

Throws:

NXException

RemoteException

setImportable

void setImportable(boolean isImportable)
            throws NXException,
                   RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Parameters:

isImportable -

Throws:

NXException

RemoteException

importable

boolean importable()
            throws NXException,
                   RemoteException

Returns the importable flag value
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Throws:

NXException

RemoteException

setSaveDirectory

void setSaveDirectory(String saveDirectory)
               throws NXException,
                      RemoteException

License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Parameters:

saveDirectory -

Throws:

NXException

RemoteException

saveDirectory

String saveDirectory()
              throws NXException,
                     RemoteException

Returns the save directory path value
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Throws:

NXException

RemoteException

createPartFamily

Template createPartFamily()
                   throws NXException,
                          RemoteException

Creates a part family associated with the owning part
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Throws:

NXException

RemoteException

editPartFamily

void editPartFamily()
             throws NXException,
                    RemoteException

Edits a part family associated with the manager/owning part
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Throws:

NXException

RemoteException

deletePartFamily

void deletePartFamily()
               throws NXException,
                      RemoteException

Deletes a part family associated with the manager/owning part
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Throws:

NXException

RemoteException

establishFamilyInstance

String establishFamilyInstance(String memberName)
                        throws NXException,
                               RemoteException

Creates a part family member if it doesn't exist on disk.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX9.0.0

Parameters:

memberName -

Throws:

NXException

RemoteException

getInstanceDefinition

InstanceDefinition getInstanceDefinition(String familyMemberDefnName)
                                  throws NXException,
                                         RemoteException

Get the family member definition already present in family
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Parameters:

familyMemberDefnName -

Throws:

NXException

RemoteException

getInstanceDefinitionUsingMemberIdentifier

InstanceDefinition getInstanceDefinitionUsingMemberIdentifier(MemberIdentifier familyMemberIdentifier)
                                                       throws NXException,
                                                              RemoteException

Obtains the family member definition already present in family A non zero return code implies familyMemberDefinition is NULL
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX10.0.0

Parameters:

familyMemberIdentifier -

Throws:

NXException

RemoteException

addInstanceDefinition

InstanceDefinition addInstanceDefinition(String familyMemberDefnName,
                                         InstanceDefinition previousFamilyMemberDefn,
                                         String otherNameEntry)
                                  throws NXException,
                                         RemoteException

Creates a new family member definition with the supplied name and places it just under previous family member definition. If the part family is importable, then the otherNameEntry is a mandatory input. Depending on whether we are in managed mode or native, familyMemberDefn name may be os_part_name or db_part_name, and otherNameEntry may be db_part_name or os_part_name. In case of non-importable part family otherName Entry may be empty.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX9.0.0

Parameters:

familyMemberDefnName -

previousFamilyMemberDefn -

otherNameEntry -

Throws:

NXException

RemoteException

addInstanceDefinitionUsingMemberIdentifier

InstanceDefinition addInstanceDefinitionUsingMemberIdentifier(MemberIdentifier familyMemberIdentifier,
                                                              InstanceDefinition previousFamilyMemberDefn,
                                                              String otherNameEntry)
                                                       throws NXException,
                                                              RemoteException

Creates a new family member definition with the supplied member identifier places it just under previous family member definition. If the part family is importable, then the otherNameEntry is a mandatory input. Depending on whether we are in managed mode or native, otherNameEntry may be db_part_name or os_part_name. In case of non-importable part family otherNameEntry may be empty.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX10.0.0

Parameters:

familyMemberIdentifier -

previousFamilyMemberDefn -

otherNameEntry -

Throws:

NXException

RemoteException

deleteInstanceDefinition

void deleteInstanceDefinition(InstanceDefinition familyMemberDefinition)
                       throws NXException,
                              RemoteException

Delete the family member definition from template manager
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Parameters:

familyMemberDefinition -

Throws:

NXException

RemoteException

reorderInstanceDefinition

void reorderInstanceDefinition(InstanceDefinition familyMemberDefinition,
                               InstanceDefinition previousFamilyMemberDefn)
                        throws NXException,
                               RemoteException

Reorder (relocate) familyMemberDefinition just after the previousFamilyMemberDefn
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Parameters:

familyMemberDefinition -

previousFamilyMemberDefn -

Throws:

NXException

RemoteException

savePartFamily

void savePartFamily()
             throws NXException,
                    RemoteException

Save the changes in template manager to core part family
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Throws:

NXException

RemoteException

getPartFamilyAttribute

FamilyAttribute getPartFamilyAttribute(FamilyAttribute.AttrType attrType,
                                       String attrName)
                                throws NXException,
                                       RemoteException

Get the part family attribute from part family template
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Parameters:

attrType -

attrName -

Throws:

NXException

RemoteException

saveFamilyAndCreateMembers

int[] saveFamilyAndCreateMembers(InstanceDefinition[] instDefsToCreate)
                          throws NXException,
                                 RemoteException

Save part family and create the family members supplied through input array. It returns success and failure codes via errorCodes array.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX9.0.0

Parameters:

instDefsToCreate -

Throws:

NXException

RemoteException

saveFamilyAndUpdateMembers

int[] saveFamilyAndUpdateMembers(boolean forceUpdate,
                                 InstanceDefinition[] instDefsToUpdate)
                          throws NXException,
                                 RemoteException

Save part family and update the family members supplied through input array. It returns success and failure codes via errorCodes array. If errorCodes contains error about locked attributes, use PartFamily.TemplateManager#getInfoMessages to query the names of those locked attributes.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX9.0.0

Parameters:

forceUpdate -

instDefsToUpdate -

Throws:

NXException

RemoteException

saveFamilyAndFixOrphanMembers

int[] saveFamilyAndFixOrphanMembers(boolean forceUpdate,
                                    InstanceDefinition[] instDefsToFix)
                             throws NXException,
                                    RemoteException

Save part family and fix the orphan family members supplied through input array. The orphan member that is fixed would also be updated to the latest configuration. It returns success and failure codes via errorCodes array. If errorCodes contains error about locked attributes, use PartFamily.TemplateManager#getInfoMessages to query the names of those locked attributes.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX11.0.0

Parameters:

forceUpdate -

instDefsToFix -

Throws:

NXException

RemoteException

saveFamilyAndApplyValues

int saveFamilyAndApplyValues(InstanceDefinition familyMemberDefinition)
                      throws NXException,
                             RemoteException

Save part family and apply the values of chosen family member definition to the template part, It returns failure codes through errorCode.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX9.0.0

Parameters:

familyMemberDefinition -

Throws:

NXException

RemoteException

getPartFamilyTemplate

Template getPartFamilyTemplate()
                        throws NXException,
                               RemoteException

Get the part family template This method may return NULL if there is no template associated with the templatemanager
License requirements: solid_modeling ("SOLIDS MODELING")
.
Created in NX9.0.0

Throws:

NXException

RemoteException

addOptionalCreationNonKeyAttrsToChosenAttrs

FamilyAttribute[] addOptionalCreationNonKeyAttrsToChosenAttrs(FamilyAttribute pasteAfter)
                                                       throws NXException,
                                                              RemoteException

Add all optional creation non key attributes to chosen list at the end or after a selected attribute from chosen attribute list. To add all optional creation attributes at the end, pass pasteAfter as NULL. If an optional attribute is already present in chosen attribute list, it does not add it again. Outputs an array of the optional attributes that were actually added to chosen list
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX10.0.0

Parameters:

pasteAfter -

Throws:

NXException

RemoteException

refreshDefaultAttrs

void refreshDefaultAttrs()
                  throws NXException,
                         RemoteException

Repopulates required attributes in chosen list so that it updates as per the teamcenter customizations, if it has changed since last saved template.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX10.0.0

Throws:

NXException

RemoteException

getAllKeyAttrs

FamilyAttribute[] getAllKeyAttrs()
                          throws NXException,
                                 RemoteException

Obtains all key attributes (required and optional) required to construct the MFK ID. These would be used to create the unique member identifier.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX10.0.0

Throws:

NXException

RemoteException

createMemberIdentifier

MemberIdentifier createMemberIdentifier(FamilyAttribute[] keyAttrs,
                                        String[] attrValues,
                                        String itemType)
                                 throws NXException,
                                        RemoteException

Creates a member identifier for a part family member from the key attributes and value pair. In native mode the itemType is NULL In managed mode, the value of itemType could be NULL in which case Template's item type will be used while creating the MemberIdentifier
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX10.0.0

Parameters:

keyAttrs -

attrValues -

itemType -

Throws:

NXException

RemoteException

getInfoMessages

String[] getInfoMessages()
                  throws NXException,
                         RemoteException

Obtains the list of messages that may have been encountered in any workflow. This is a generic routine to get all information (Error/Warning/Info) that are deemed useful to user. Contains error messages encountered during save like material issues, interpart expression issues, invalid member names. In addition, if there were locked attributes (i.e. attributes whose value cannot be updated), this also would contain the names of such attributes.
License requirements: solid_modeling ("SOLIDS MODELING")

Created in NX10.0.0

Throws:

NXException

RemoteException