public interface TemplateManager extends TransientObject
Part.newPartFamilyTemplateManager()
to create new instance of this class.
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[] |
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") . |
_value, dispose, printTestData, printTestData
String[] getSelectableAttributes(FamilyAttribute.AttrType attrType) throws NXException, RemoteException
attrType
- NXException
RemoteException
void deletePartFamilyAttribute(FamilyAttribute partFamilyAttribute) throws NXException, RemoteException
partFamilyAttribute
- NXException
RemoteException
FamilyAttribute[] getChosenAttributes() throws NXException, RemoteException
Template.getAttributes()
to get the committed attributes"
NXException
RemoteException
void addToChosenAttributes(String[] attrsToAdd, FamilyAttribute.AttrType[] attrsTypes, int indexAddAt) throws NXException, RemoteException
attrsToAdd
- attrsTypes
- indexAddAt
- NXException
RemoteException
void addAssertedMassToChosenAttributes(String attrToAdd, int indexAddAt) throws NXException, RemoteException
attrToAdd
- indexAddAt
- NXException
RemoteException
int moveDownAttributes(FamilyAttribute[] moveDownAttrs, int moveDownCount) throws NXException, RemoteException
moveDownAttrs
- moveDownCount
- NXException
RemoteException
int moveUpAttributes(FamilyAttribute[] moveUpAttrs, int moveUpCount) throws NXException, RemoteException
moveUpAttrs
- moveUpCount
- NXException
RemoteException
void cutAttributes(FamilyAttribute[] cutAttrs) throws NXException, RemoteException
cutAttrs
- NXException
RemoteException
void pasteAttributes(FamilyAttribute pasteAfter) throws NXException, RemoteException
pasteAfter
- NXException
RemoteException
void setImportable(boolean isImportable) throws NXException, RemoteException
isImportable
- NXException
RemoteException
boolean importable() throws NXException, RemoteException
NXException
RemoteException
void setSaveDirectory(String saveDirectory) throws NXException, RemoteException
saveDirectory
- NXException
RemoteException
String saveDirectory() throws NXException, RemoteException
NXException
RemoteException
Template createPartFamily() throws NXException, RemoteException
NXException
RemoteException
void editPartFamily() throws NXException, RemoteException
NXException
RemoteException
void deletePartFamily() throws NXException, RemoteException
NXException
RemoteException
String establishFamilyInstance(String memberName) throws NXException, RemoteException
memberName
- NXException
RemoteException
InstanceDefinition getInstanceDefinition(String familyMemberDefnName) throws NXException, RemoteException
familyMemberDefnName
- NXException
RemoteException
InstanceDefinition getInstanceDefinitionUsingMemberIdentifier(MemberIdentifier familyMemberIdentifier) throws NXException, RemoteException
familyMemberIdentifier
- NXException
RemoteException
InstanceDefinition addInstanceDefinition(String familyMemberDefnName, InstanceDefinition previousFamilyMemberDefn, String otherNameEntry) throws NXException, RemoteException
familyMemberDefnName
- previousFamilyMemberDefn
- otherNameEntry
- NXException
RemoteException
InstanceDefinition addInstanceDefinitionUsingMemberIdentifier(MemberIdentifier familyMemberIdentifier, InstanceDefinition previousFamilyMemberDefn, String otherNameEntry) throws NXException, RemoteException
familyMemberIdentifier
- previousFamilyMemberDefn
- otherNameEntry
- NXException
RemoteException
void deleteInstanceDefinition(InstanceDefinition familyMemberDefinition) throws NXException, RemoteException
familyMemberDefinition
- NXException
RemoteException
void reorderInstanceDefinition(InstanceDefinition familyMemberDefinition, InstanceDefinition previousFamilyMemberDefn) throws NXException, RemoteException
familyMemberDefinition
- previousFamilyMemberDefn
- NXException
RemoteException
void savePartFamily() throws NXException, RemoteException
NXException
RemoteException
FamilyAttribute getPartFamilyAttribute(FamilyAttribute.AttrType attrType, String attrName) throws NXException, RemoteException
attrType
- attrName
- NXException
RemoteException
int[] saveFamilyAndCreateMembers(InstanceDefinition[] instDefsToCreate) throws NXException, RemoteException
instDefsToCreate
- NXException
RemoteException
int[] saveFamilyAndUpdateMembers(boolean forceUpdate, InstanceDefinition[] instDefsToUpdate) throws NXException, RemoteException
PartFamily.TemplateManager#getInfoMessages
to query the names of those locked attributes.
forceUpdate
- instDefsToUpdate
- NXException
RemoteException
int saveFamilyAndApplyValues(InstanceDefinition familyMemberDefinition) throws NXException, RemoteException
familyMemberDefinition
- NXException
RemoteException
Template getPartFamilyTemplate() throws NXException, RemoteException
NXException
RemoteException
FamilyAttribute[] addOptionalCreationNonKeyAttrsToChosenAttrs(FamilyAttribute pasteAfter) throws NXException, RemoteException
pasteAfter
- NXException
RemoteException
void refreshDefaultAttrs() throws NXException, RemoteException
NXException
RemoteException
FamilyAttribute[] getAllKeyAttrs() throws NXException, RemoteException
NXException
RemoteException
MemberIdentifier createMemberIdentifier(FamilyAttribute[] keyAttrs, String[] attrValues, String itemType) throws NXException, RemoteException
keyAttrs
- attrValues
- itemType
- NXException
RemoteException
String[] getInfoMessages() throws NXException, RemoteException
NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.