Interface FamilyMember
Description
This class describes a member in a family table.
Direct Known Subclasses:
User Guide References:
Model Information:FamilyMember, Assembly Components:FamilyMember, Family Tables:FamilyMember, Accessing Instances:FamilyMember, Accessing Columns:FamilyMember, Accessing Cell Information:FamilyMember, Creating Family Table Instances:FamilyMember, Creating Family Table Columns:FamilyMember, Operations on Family Table Instances:FamilyMember, Family Table Utilities:FamilyMember, Creo Object TOOLKIT Java Classes:FamilyMember
Method Summary
Adds a new column to the family table. | |
Adds a new row to the family table. | |
Creates a new family table column object given a string symbol. | |
Creates a component model column that will be added to a family table. | |
Creates a single component column in the family table. | |
Creates a dimension column in the family table. | |
Creates a feature column in the family table. | |
Creates a group column in the family table. | |
Creates a merged-part column in the family table. | |
Creates a parameter column in the family table. | |
Creates a new family table column representing a dimension tolerance minus value. | |
Creates a new family table column representing a dimension tolerance plus value. | |
Creates a new family table column representing a dimension tolerance plus/minus symmetric value. | |
/*cipOptional*/ ParamValue | |
Retrieves the value in the specified cell of the family table. | |
boolean | |
Determines if the value of the item in the specified cell is the default value. | |
/*cipOptional*/ FamilyTableColumn | GetColumn (String Symbol) |
Returns a column in the family table, given its string name. | |
/*cipOptional*/ ModelDescriptor | |
Gets the model descriptor of the immediate generic model. | |
/*cipOptional*/ FamilyMember | GetParent () |
Get method for attribute "Parent" The parent of the member object (the immediate generic model). | |
/*cipOptional*/ FamilyTableRow | GetRow (String InstanceName) |
Returns the specified row of the family table. | |
Gets the model descriptor of the top generic model. | |
/*cipOptional*/ FamilyTableColumns | ListColumns () |
Lists the columns of the family table. | |
/*cipOptional*/ FamilyTableRows | ListRows () |
Lists the rows of the family table. | |
void | |
Removes a specified column from the family table. | |
void | |
Removes a specified row from the family table. | |
void | |
Sets the value of the specified cell in the family table. |
Method Detail
GetParent | ||
/*cipOptional*/ FamilyMember | GetParent | () |
The parent of the member object (the immediate generic model).
If immediate generic model is not in session an XToolkitCantOpen exception is thrown. In that case use FamilyMember.GetImmediateGenericInfo() to get the model descriptor of immediate generic.
Exceptions thrown (but not limited to):
XToolkitNotFound - The specified model is not an instance -- it has no generic model.
XToolkitCantOpen - The immediate generic is not in session ('immediate' is set to TRUE). Use ProFaminstanceImmediategenericinfoGet() to obtain the name and modeltype of immediate generic in such case.
User Guide References:
GetImmediateGenericInfo | ||
/*cipOptional*/ ModelDescriptor | GetImmediateGenericInfo | () |
Gets the model descriptor of the immediate generic model.
Exceptions thrown (but not limited to):
XToolkitNotFound - The specified model is not an instance -- it has no generic model.
User Guide References:
Returns:
The model descriptor of the immediate generic model.
GetTopGenericInfo | ||
GetTopGenericInfo | () |
Gets the model descriptor of the top generic model.
Exceptions thrown (but not limited to):
XToolkitNotFound - The specified model is not an instance -- it has no generic model.
XToolkitCantOpen - The immediate generic is not in session ('immediate' is set to TRUE). Use ProFaminstanceImmediategenericinfoGet() to obtain the name and modeltype of immediate generic in such case.
User Guide References:
Returns:
The model descriptor of the top generic model.
ListColumns | ||
/*cipOptional*/ FamilyTableColumns | ListColumns | () |
Lists the columns of the family table.
User Guide References:
Returns:
A sequence of the family table columns.
ListRows | ||
/*cipOptional*/ FamilyTableRows | ListRows | () |
Lists the rows of the family table.
User Guide References:
Returns:
A sequence of the family table rows.
GetCell | ||
/*cipOptional*/ ParamValue | GetCell |
Retrieves the value in the specified cell of the family table.
Exceptions thrown (but not limited to):
XToolkitNotFound - The specified instance does not exist in the family table, or the specified model item is not table-driven.
See Also:
User Guide References:
Parameters:
Column
The column in the family table
Row
The row in the family table
Returns:
The value in the specified cell
SetCell | ||
void | SetCell |
Sets the value of the specified cell in the family table.
Exceptions thrown (but not limited to):
XToolkitNotFound - The specified instance does not exist in the family table, or the specified model item is not table-driven.
See Also:
FamilyMember.GetCell(FamilyTableColumn, FamilyTableRow), pfcModelItem.CreateIntParamValue(int), pfcModelItem.CreateDoubleParamValue(double), pfcModelItem.CreateStringParamValue(String), pfcModelItem.CreateBoolParamValue(boolean)
User Guide References:
Parameters:
Column
The column where the cell is located.
Row
The row where the cell is located.
Value
The new cell value.
Returns:
GetCellIsDefault | ||
boolean | GetCellIsDefault |
Determines if the value of the item in the specified cell is the default value.
Exceptions thrown (but not limited to):
XToolkitNotFound - The specified instance does not exist in the family table, or the specified model item is not table-driven.
User Guide References:
Parameters:
Column
The column in the family table
Row
The row in the family table
Returns:
true if the value is default and false if not.
AddRow | ||
AddRow |
Adds a new row to the family table.
Exceptions thrown (but not limited to):
XToolkitFound - The specified instance already exists in the family table.
XToolkitAbort - Operation of adding instance is aborted since the supplied name was already in use.
User Guide References:
Parameters:
InstanceName
Name of the new instance.
Values
Values to add to the row (or NULL).
Returns:
New row
GetRow | ||
/*cipOptional*/ FamilyTableRow | GetRow | (String InstanceName) |
Returns the specified row of the family table.
User Guide References:
Parameters:
InstanceName
The name of the instance to find.
Returns:
The specified instance.
RemoveRow | ||
void | RemoveRow |
Removes a specified row from the family table.
Exceptions thrown (but not limited to):
XToolkitNotFound - The specified instance does not exist in the family table.
User Guide References:
Parameters:
Row
The row to be deleted.
Returns:
AddColumn | ||
AddColumn |
Adds a new column to the family table.
Exceptions thrown (but not limited to):
XToolkitNoChange - The specified item already exists in the family table.
User Guide References:
Parameters:
Column
The object describing the column to add.
Values
Values to add to the new column (or NULL).
Returns:
The new column
RemoveColumn | ||
void | RemoveColumn |
Removes a specified column from the family table.
Exceptions thrown (but not limited to):
XToolkitNotFound - The specified item was not found in the family table.
User Guide References:
Parameters:
Column
The column to be deleted.
Returns:
GetColumn | ||
/*cipOptional*/ FamilyTableColumn | GetColumn | (String Symbol) |
Returns a column in the family table, given its string name.
See Also:
User Guide References:
Parameters:
Symbol
The family table column symbol.
Returns:
The column object, or null, if the column was not found.
CreateColumn | ||
CreateColumn |
Creates a new family table column object given a string symbol.
The column will not be added to the family table until FamilyMember.AddColumn(FamilyTableColumn, /*cipOptional*/ ParamValues) is used.
User Guide References:
Parameters:
Type
The type of element contained in the column.
Symbol
The string symbol that will appear of the column, for example "F1" or "D7".
Returns:
The created family table column object.
CreateParamColumn | ||
CreateParamColumn |
Creates a parameter column in the family table.
The column name will be same as the parameter name.
The column will not be added to the family table until FamilyMember.AddColumn(FamilyTableColumn, /*cipOptional*/ ParamValues) is used.
See Also:
User Guide References:
Parameters:
Param
The parameter
Returns:
The new column
CreateDimensionColumn | ||
CreateDimensionColumn |
Creates a dimension column in the family table.
The string name for this column will be "d#", where # is the dimension id.
The column will not be added to the family table until FamilyMember.AddColumn(FamilyTableColumn, /*cipOptional*/ ParamValues) is used.
See Also:
User Guide References:
Parameters:
Dim
The dimension.
Returns:
The new column.
CreateFeatureColumn | ||
CreateFeatureColumn |
Creates a feature column in the family table.
The string name for this column will be "f#", where # is the feature id.
The column will not be added to the family table until FamilyMember.AddColumn(FamilyTableColumn, /*cipOptional*/ ParamValues) is used.
See Also:
User Guide References:
Parameters:
Feat
The feature
Returns:
The new column
CreateComponentColumn | ||
CreateComponentColumn |
Creates a single component column in the family table.
The string name for this column will be "m#", where # is the component id.
The return value must be passed to FamilyMember.AddColumn(FamilyTableColumn, /*cipOptional*/ ParamValues) .
See Also:
User Guide References:
Parameters:
Comp
The component.
Returns:
The new column.
CreateCompModelColumn | ||
CreateCompModelColumn |
Creates a component model column that will be added to a family table.
The string name for this column will be "mm#", where "#" is the component feature id.
A component model column drives all occurrences of a component part (or subassembly) in an assembly.
Creating a component model column is the same as using Family Tab > Add Item > Component, then selecting an occurrence of the component and choosing All.
The return value must be passed to FamilyMember.AddColumn(FamilyTableColumn, /*cipOptional*/ ParamValues) .
See Also:
FamilyMember.CreateComponentColumn(Feature), FamilyMember.AddColumn(FamilyTableColumn, /*cipOptional*/ ParamValues)
User Guide References:
Parameters:
Comp
Any ComponentFeat that contains the component being added
Returns:
The new column
CreateGroupColumn | ||
CreateGroupColumn |
Creates a group column in the family table.
The column will not be added to the family table until FamilyMember.AddColumn(FamilyTableColumn, /*cipOptional*/ ParamValues) is used.
See Also:
User Guide References:
Parameters:
Group
The feature group to add to the table
Returns:
The new column
CreateMergePartColumn | ||
CreateMergePartColumn |
Creates a merged-part column in the family table.
The column will not be added to the family table until FamilyMember.AddColumn(FamilyTableColumn, /*cipOptional*/ ParamValues) is used.
See Also:
User Guide References:
Parameters:
Feat
The feature
Returns:
The new column
CreateTolPlusColumn | ||
CreateTolPlusColumn |
Creates a new family table column representing a dimension tolerance plus value.
The string name for this column will be "tp#", where # is the dimension id.
The column will not be added to the family table until FamilyMember.AddColumn(FamilyTableColumn, /*cipOptional*/ ParamValues) is used.
See Also:
FamilyMember.CreateTolMinusColumn(Dimension), FamilyMember.CreateTolPlusMinusColumn(Dimension), FamilyMember.AddColumn(FamilyTableColumn, /*cipOptional*/ ParamValues)
Parameters:
Dim
The dimension whose tolerance will be assigned to the column.
Returns:
The created family table column.
CreateTolMinusColumn | ||
CreateTolMinusColumn |
Creates a new family table column representing a dimension tolerance minus value.
The string name for this column will be "tm#", where # is the dimension id.
The column will not be added to the family table until FamilyMember.AddColumn(FamilyTableColumn, /*cipOptional*/ ParamValues) is used.
See Also:
FamilyMember.CreateTolPlusColumn(Dimension), FamilyMember.CreateTolPlusMinusColumn(Dimension), FamilyMember.AddColumn(FamilyTableColumn, /*cipOptional*/ ParamValues)
Parameters:
Dim
The dimension whose tolerance will be assigned to the column.
Returns:
The created family table column.
CreateTolPlusMinusColumn | ||
CreateTolPlusMinusColumn |
Creates a new family table column representing a dimension tolerance plus/minus symmetric value.
The string name for this column will be "tpm#", where # is the dimension id.
The column will not be added to the family table until FamilyMember.AddColumn(FamilyTableColumn, /*cipOptional*/ ParamValues) is used.
See Also:
FamilyMember.CreateTolPlusColumn(Dimension), FamilyMember.CreateTolMinusColumn(Dimension), FamilyMember.AddColumn(FamilyTableColumn, /*cipOptional*/ ParamValues)
Parameters:
Dim
The dimension whose tolerance will be assigned to the column.
Returns:
The created family table column.