This class serves as the manager for all the part family related operations. More...
Public Member Functions | |
| unsafe string[] | GetSelectableAttributes (NXOpen.PartFamily.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 More... | |
| unsafe void | DeletePartFamilyAttribute (NXOpen.PartFamily.FamilyAttribute partFamilyAttribute) |
| Deletes a given part family attribute More... | |
| unsafe NXOpen.PartFamily.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. More... | |
| unsafe void | AddToChosenAttributes (string[] attrsToAdd, NXOpen.PartFamily.FamilyAttribute.AttrType[] attrsTypes, int indexAddAt) |
| Adds new attributes to chosen attributes list of a part family More... | |
| unsafe void | AddAssertedMassToChosenAttributes (string attrToAdd, int indexAddAt) |
| Adds new attribute of type asserted mass to chosen attributes list of a part family More... | |
| unsafe int | MoveDownAttributes (NXOpen.PartFamily.FamilyAttribute[] moveDownAttrs, int moveDownCount) |
| Move down the specified attributes of a part family by the moveDownCount. More... | |
| unsafe int | MoveUpAttributes (NXOpen.PartFamily.FamilyAttribute[] moveUpAttrs, int moveUpCount) |
| Move up the specified attributes of a part family by the moveUpCount. More... | |
| unsafe void | CutAttributes (NXOpen.PartFamily.FamilyAttribute[] cutAttrs) |
| Cut selected attributes of a part family. More... | |
| unsafe void | PasteAttributes (NXOpen.PartFamily.FamilyAttribute pasteAfter) |
| Paste the cut attributes of a part family. More... | |
| unsafe NXOpen.PartFamily.Template | CreatePartFamily () |
| Creates a part family associated with the owning part More... | |
| unsafe void | EditPartFamily () |
| Edits a part family associated with the manager/owning part More... | |
| unsafe void | DeletePartFamily () |
| Deletes a part family associated with the manager/owning part More... | |
| unsafe string | EstablishFamilyInstance (string memberName) |
| Creates a part family member if it doesn't exist on disk. More... | |
| unsafe NXOpen.PartFamily.InstanceDefinition | GetInstanceDefinition (string familyMemberDefnName) |
| Get the family member definition already present in family More... | |
| unsafe NXOpen.PartFamily.InstanceDefinition | GetInstanceDefinitionUsingMemberIdentifier (NXOpen.PartFamily.MemberIdentifier familyMemberIdentifier) |
| Obtains the family member definition already present in family A non zero return code implies familyMemberDefinition is NULL More... | |
| unsafe NXOpen.PartFamily.InstanceDefinition | AddInstanceDefinition (string familyMemberDefnName, NXOpen.PartFamily.InstanceDefinition previousFamilyMemberDefn, string otherNameEntry) |
| Creates a new family member definition with the supplied name and places it just under previous family member definition. More... | |
| unsafe NXOpen.PartFamily.InstanceDefinition | AddInstanceDefinitionUsingMemberIdentifier (NXOpen.PartFamily.MemberIdentifier familyMemberIdentifier, NXOpen.PartFamily.InstanceDefinition previousFamilyMemberDefn, string otherNameEntry) |
| Creates a new family member definition with the supplied member identifier places it just under previous family member definition. More... | |
| unsafe void | DeleteInstanceDefinition (NXOpen.PartFamily.InstanceDefinition familyMemberDefinition) |
| Delete the family member definition from template manager More... | |
| unsafe void | ReorderInstanceDefinition (NXOpen.PartFamily.InstanceDefinition familyMemberDefinition, NXOpen.PartFamily.InstanceDefinition previousFamilyMemberDefn) |
| Reorder (relocate) familyMemberDefinition just after the previousFamilyMemberDefn More... | |
| unsafe void | SavePartFamily () |
| Save the changes in template manager to core part family More... | |
| unsafe NXOpen.PartFamily.FamilyAttribute | GetPartFamilyAttribute (NXOpen.PartFamily.FamilyAttribute.AttrType attrType, string attrName) |
| Get the part family attribute from part family template More... | |
| unsafe int[] | SaveFamilyAndCreateMembers (NXOpen.PartFamily.InstanceDefinition[] instDefsToCreate) |
| Save part family and create the family members supplied through input array. More... | |
| unsafe int[] | SaveFamilyAndUpdateMembers (bool forceUpdate, NXOpen.PartFamily.InstanceDefinition[] instDefsToUpdate) |
| Save part family and update the family members supplied through input array. More... | |
| unsafe int[] | SaveFamilyAndFixOrphanMembers (bool forceUpdate, NXOpen.PartFamily.InstanceDefinition[] instDefsToFix) |
| Save part family and fix the orphan family members supplied through input array. More... | |
| unsafe int | SaveFamilyAndApplyValues (NXOpen.PartFamily.InstanceDefinition familyMemberDefinition) |
| Save part family and apply the values of chosen family member definition to the template part, It returns failure codes through errorCode. More... | |
| unsafe NXOpen.PartFamily.Template | GetPartFamilyTemplate () |
| Get the part family template This method may return NULL if there is no template associated with the templatemanager More... | |
| unsafe NXOpen.PartFamily.FamilyAttribute[] | AddOptionalCreationNonKeyAttrsToChosenAttrs (NXOpen.PartFamily.FamilyAttribute pasteAfter) |
| Add all optional creation non key attributes to chosen list at the end or after a selected attribute from chosen attribute list. More... | |
| unsafe 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. More... | |
| unsafe NXOpen.PartFamily.FamilyAttribute[] | GetAllKeyAttrs () |
| Obtains all key attributes (required and optional) required to construct the MFK ID. More... | |
| unsafe NXOpen.PartFamily.MemberIdentifier | CreateMemberIdentifier (NXOpen.PartFamily.FamilyAttribute[] keyAttrs, string[] attrValues, string itemType) |
| Creates a member identifier for a part family member from the key attributes and value pair. More... | |
| unsafe string[] | GetInfoMessages () |
| Obtains the list of messages that may have been encountered in any workflow. More... | |
Protected Member Functions | |
| override void | FreeResource () |
| Free resources associated with the instance. More... | |
Properties | |
| unsafe bool | Importable [get, set] |
| Returns or sets the importable flag value More... | |
| unsafe string | SaveDirectory [get, set] |
| Returns or sets the save directory path value More... | |
Detailed Description
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
Member Function Documentation
| unsafe void NXOpen.PartFamily.TemplateManager.AddAssertedMassToChosenAttributes | ( | string | attrToAdd, |
| int | indexAddAt | ||
| ) |
Adds new attribute of type asserted mass to chosen attributes list of a part family
Created in NX9.0.0
License requirements: adv_assemblies ("ADVANCED ASSEMBLIES"), solid_modeling ("SOLIDS MODELING")
- Parameters
-
attrToAdd indexAddAt
| unsafe NXOpen.PartFamily.InstanceDefinition NXOpen.PartFamily.TemplateManager.AddInstanceDefinition | ( | string | familyMemberDefnName, |
| NXOpen.PartFamily.InstanceDefinition | previousFamilyMemberDefn, | ||
| string | otherNameEntry | ||
| ) |
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.
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
familyMemberDefnName previousFamilyMemberDefn otherNameEntry
- Returns
| unsafe NXOpen.PartFamily.InstanceDefinition NXOpen.PartFamily.TemplateManager.AddInstanceDefinitionUsingMemberIdentifier | ( | NXOpen.PartFamily.MemberIdentifier | familyMemberIdentifier, |
| NXOpen.PartFamily.InstanceDefinition | previousFamilyMemberDefn, | ||
| string | otherNameEntry | ||
| ) |
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.
Created in NX10.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
familyMemberIdentifier previousFamilyMemberDefn otherNameEntry
- Returns
| unsafe NXOpen.PartFamily.FamilyAttribute [] NXOpen.PartFamily.TemplateManager.AddOptionalCreationNonKeyAttrsToChosenAttrs | ( | NXOpen.PartFamily.FamilyAttribute | pasteAfter | ) |
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
Created in NX10.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
pasteAfter
- Returns
| unsafe void NXOpen.PartFamily.TemplateManager.AddToChosenAttributes | ( | string[] | attrsToAdd, |
| NXOpen.PartFamily.FamilyAttribute.AttrType[] | attrsTypes, | ||
| int | indexAddAt | ||
| ) |
Adds new attributes to chosen attributes list of a part family
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
attrsToAdd attrsTypes indexAddAt
| unsafe NXOpen.PartFamily.MemberIdentifier NXOpen.PartFamily.TemplateManager.CreateMemberIdentifier | ( | NXOpen.PartFamily.FamilyAttribute[] | keyAttrs, |
| string[] | attrValues, | ||
| string | itemType | ||
| ) |
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
Created in NX10.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
keyAttrs attrValues itemType
- Returns
| unsafe NXOpen.PartFamily.Template NXOpen.PartFamily.TemplateManager.CreatePartFamily | ( | ) |
Creates a part family associated with the owning part
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Returns
| unsafe void NXOpen.PartFamily.TemplateManager.CutAttributes | ( | NXOpen.PartFamily.FamilyAttribute[] | cutAttrs | ) |
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.
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
cutAttrs
| unsafe void NXOpen.PartFamily.TemplateManager.DeleteInstanceDefinition | ( | NXOpen.PartFamily.InstanceDefinition | familyMemberDefinition | ) |
Delete the family member definition from template manager
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
familyMemberDefinition
| unsafe void NXOpen.PartFamily.TemplateManager.DeletePartFamily | ( | ) |
Deletes a part family associated with the manager/owning part
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
| unsafe void NXOpen.PartFamily.TemplateManager.DeletePartFamilyAttribute | ( | NXOpen.PartFamily.FamilyAttribute | partFamilyAttribute | ) |
Deletes a given part family attribute
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
partFamilyAttribute
| unsafe void NXOpen.PartFamily.TemplateManager.EditPartFamily | ( | ) |
Edits a part family associated with the manager/owning part
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
| unsafe string NXOpen.PartFamily.TemplateManager.EstablishFamilyInstance | ( | string | memberName | ) |
Creates a part family member if it doesn't exist on disk.
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
memberName
- Returns
|
protected |
Free resources associated with the instance.
After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector
Created in NX9.0.0
License requirements: None.
| unsafe NXOpen.PartFamily.FamilyAttribute [] NXOpen.PartFamily.TemplateManager.GetAllKeyAttrs | ( | ) |
Obtains all key attributes (required and optional) required to construct the MFK ID.
These would be used to create the unique member identifier.
Created in NX10.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Returns
| unsafe NXOpen.PartFamily.FamilyAttribute [] NXOpen.PartFamily.TemplateManager.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.
"Use <see cref="Template.GetAttributes"> Template.GetAttributes </see> to get the committed attributes"
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Returns
| unsafe string [] NXOpen.PartFamily.TemplateManager.GetInfoMessages | ( | ) |
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.
Created in NX10.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Returns
| unsafe NXOpen.PartFamily.InstanceDefinition NXOpen.PartFamily.TemplateManager.GetInstanceDefinition | ( | string | familyMemberDefnName | ) |
Get the family member definition already present in family
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
familyMemberDefnName
- Returns
| unsafe NXOpen.PartFamily.InstanceDefinition NXOpen.PartFamily.TemplateManager.GetInstanceDefinitionUsingMemberIdentifier | ( | NXOpen.PartFamily.MemberIdentifier | familyMemberIdentifier | ) |
Obtains the family member definition already present in family A non zero return code implies familyMemberDefinition is NULL
Created in NX10.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
familyMemberIdentifier
- Returns
| unsafe NXOpen.PartFamily.FamilyAttribute NXOpen.PartFamily.TemplateManager.GetPartFamilyAttribute | ( | NXOpen.PartFamily.FamilyAttribute.AttrType | attrType, |
| string | attrName | ||
| ) |
Get the part family attribute from part family template
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
attrType attrName
- Returns
| unsafe NXOpen.PartFamily.Template NXOpen.PartFamily.TemplateManager.GetPartFamilyTemplate | ( | ) |
Get the part family template This method may return NULL if there is no template associated with the templatemanager
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Returns
| unsafe string [] NXOpen.PartFamily.TemplateManager.GetSelectableAttributes | ( | NXOpen.PartFamily.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
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
attrType
- Returns
| unsafe int NXOpen.PartFamily.TemplateManager.MoveDownAttributes | ( | NXOpen.PartFamily.FamilyAttribute[] | moveDownAttrs, |
| int | moveDownCount | ||
| ) |
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.
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
moveDownAttrs moveDownCount
- Returns
| unsafe int NXOpen.PartFamily.TemplateManager.MoveUpAttributes | ( | NXOpen.PartFamily.FamilyAttribute[] | moveUpAttrs, |
| int | moveUpCount | ||
| ) |
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.
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
moveUpAttrs moveUpCount
- Returns
| unsafe void NXOpen.PartFamily.TemplateManager.PasteAttributes | ( | NXOpen.PartFamily.FamilyAttribute | pasteAfter | ) |
Paste the cut attributes of a part family.
The pasteAfter attribute must be present in chosen attributes list for this operation to succeed.
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
pasteAfter
| unsafe void NXOpen.PartFamily.TemplateManager.RefreshDefaultAttrs | ( | ) |
Repopulates required attributes in chosen list so that it updates as per the teamcenter customizations, if it has changed since last saved template.
Created in NX10.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
| unsafe void NXOpen.PartFamily.TemplateManager.ReorderInstanceDefinition | ( | NXOpen.PartFamily.InstanceDefinition | familyMemberDefinition, |
| NXOpen.PartFamily.InstanceDefinition | previousFamilyMemberDefn | ||
| ) |
Reorder (relocate) familyMemberDefinition just after the previousFamilyMemberDefn
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
familyMemberDefinition previousFamilyMemberDefn
| unsafe int NXOpen.PartFamily.TemplateManager.SaveFamilyAndApplyValues | ( | NXOpen.PartFamily.InstanceDefinition | familyMemberDefinition | ) |
Save part family and apply the values of chosen family member definition to the template part, It returns failure codes through errorCode.
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
familyMemberDefinition
- Returns
| unsafe int [] NXOpen.PartFamily.TemplateManager.SaveFamilyAndCreateMembers | ( | NXOpen.PartFamily.InstanceDefinition[] | instDefsToCreate | ) |
Save part family and create the family members supplied through input array.
It returns success and failure codes via errorCodes array.
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
instDefsToCreate
- Returns
| unsafe int [] NXOpen.PartFamily.TemplateManager.SaveFamilyAndFixOrphanMembers | ( | bool | forceUpdate, |
| NXOpen.PartFamily.InstanceDefinition[] | instDefsToFix | ||
| ) |
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.
Created in NX11.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
forceUpdate instDefsToFix
- Returns
| unsafe int [] NXOpen.PartFamily.TemplateManager.SaveFamilyAndUpdateMembers | ( | bool | forceUpdate, |
| NXOpen.PartFamily.InstanceDefinition[] | instDefsToUpdate | ||
| ) |
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.
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
- Parameters
-
forceUpdate instDefsToUpdate
- Returns
| unsafe void NXOpen.PartFamily.TemplateManager.SavePartFamily | ( | ) |
Save the changes in template manager to core part family
Created in NX9.0.0
License requirements: solid_modeling ("SOLIDS MODELING")
Property Documentation
|
getset |
Returns or sets the importable flag value
Created in NX9.0.0
License requirements to get this property: solid_modeling ("SOLIDS MODELING")
License requirements to set this property: solid_modeling ("SOLIDS MODELING")
|
getset |
Returns or sets the save directory path value
Created in NX9.0.0
License requirements to get this property: solid_modeling ("SOLIDS MODELING")
License requirements to set this property: solid_modeling ("SOLIDS MODELING")
The documentation for this class was generated from the following file:
- dotnet_pool/PartFamily_TemplateManager.cs