API Documentation > Classes > Interface IpfcFamilyMember
Interface IpfcFamilyMember
Description
This class describes a member in a family table.
Direct Parent Classes:
Direct Known Subclasses:
User Guide References:
Property Summary
Property
as IpfcFamilyMember [readonly, optional]
The parent of the member object (the immediate generic model).
Method Summary
Function
Adds a new column to the family table.
Function
AddRow (InstanceName as String, Values as IpfcParamValues [optional]) as IpfcFamilyTableRow
Adds a new row to the family table.
Function
Creates a new family table column object given a string symbol.
Function
Creates a component model column that will be added to a family table.
Function
Creates a single component column in the family table.
Function
Creates a dimension column in the family table.
Function
Creates a feature column in the family table.
Function
Creates a group column in the family table.
Function
Creates a merged-part column in the family table.
Function
Creates a parameter column in the family table.
Function
Creates a new family table column representing a dimension tolerance minus value.
Function
Creates a new family table column representing a dimension tolerance plus value.
Function
Creates a new family table column representing a dimension tolerance plus/minus symmetric value.
Function
Retrieves the value in the specified cell of the family table.
Function
Determines if the value of the item in the specified cell is the default value.
Function
GetColumn (Symbol as String) as IpfcFamilyTableColumn [optional]
Returns a column in the family table, given its string name.
Function
Gets the model descriptor of the immediate generic model.
Function
GetRow (InstanceName as String) as IpfcFamilyTableRow [optional]
Returns the specified row of the family table.
Function
Gets the model descriptor of the top generic model.
Function
Lists the columns of the family table.
Function
ListRows () as IpfcFamilyTableRows [optional]
Lists the rows of the family table.
Sub
Removes a specified column from the family table.
Sub
Removes a specified row from the family table.
Sub
Sets the value of the specified cell in the family table.
Property Detail
Property
Parent
as IpfcFamilyMember [readonly, optional]
The parent of the member object (the immediate generic model).
If immediate generic model is not in session an IpfcXToolkitCantOpen exception is thrown. In that case use IpfcFamilyMember.GetImmediateGenericInfo() to get the model descriptor of immediate generic.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - The specified model is not an instance -- it has no generic model.
IpfcXToolkitCantOpen - 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.
Method Detail
Function
AddColumn
(Column as IpfcFamilyTableColumn, Values as IpfcParamValues [optional]) as IpfcFamilyTableColumn
Adds a new column to the family table.
Exceptions thrown (but not limited to):
IpfcXToolkitNoChange - The specified item already exists in the family table.
Parameters:
Column
The object describing the column to add.
Values
Values to add to the new column (or NULL).
Returns:
The new column
User Guide References:
Function
AddRow
(InstanceName as String, Values as IpfcParamValues [optional]) as IpfcFamilyTableRow
Adds a new row to the family table.
Exceptions thrown (but not limited to):
IpfcXToolkitFound - The specified instance already exists in the family table.
IpfcXToolkitAbort - Operation of adding instance is aborted since the supplied name was already in use.
Parameters:
InstanceName
Name of the new instance.
Values
Values to add to the row (or NULL).
Returns:
New row
User Guide References:
Function
CreateColumn
(Type as IpfcFamilyColumnType, Symbol as String) as IpfcFamilyTableColumn
Creates a new family table column object given a string symbol.
The column will not be added to the family table until IpfcFamilyMember.AddColumn() is used.
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.
User Guide References:
Function
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 IpfcFamilyMember.AddColumn() .
See Also:
Parameters:
Comp
Any ComponentFeat that contains the component being added
Returns:
The new column
User Guide References:
Function
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 IpfcFamilyMember.AddColumn() .
See Also:
Parameters:
Comp
The component.
Returns:
The new column.
User Guide References:
Function
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 IpfcFamilyMember.AddColumn() is used.
See Also:
Parameters:
Dim
The dimension.
Returns:
The new column.
User Guide References:
Function
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 IpfcFamilyMember.AddColumn() is used.
See Also:
Parameters:
Feat
The feature
Returns:
The new column
User Guide References:
Function
CreateGroupColumn
Creates a group column in the family table.
The column will not be added to the family table until IpfcFamilyMember.AddColumn() is used.
See Also:
Parameters:
Group
The feature group to add to the table
Returns:
The new column
User Guide References:
Function
CreateMergePartColumn
Creates a merged-part column in the family table.
The column will not be added to the family table until IpfcFamilyMember.AddColumn() is used.
See Also:
Parameters:
Feat
The feature
Returns:
The new column
User Guide References:
Function
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 IpfcFamilyMember.AddColumn() is used.
See Also:
Parameters:
Param
The parameter
Returns:
The new column
User Guide References:
Function
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 IpfcFamilyMember.AddColumn() is used.
See Also:
Parameters:
Dim
The dimension whose tolerance will be assigned to the column.
Returns:
The created family table column.
Function
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 IpfcFamilyMember.AddColumn() is used.
See Also:
Parameters:
Dim
The dimension whose tolerance will be assigned to the column.
Returns:
The created family table column.
Function
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 IpfcFamilyMember.AddColumn() is used.
See Also:
Parameters:
Dim
The dimension whose tolerance will be assigned to the column.
Returns:
The created family table column.
Function
GetCell
(Column as IpfcFamilyTableColumn, Row as IpfcFamilyTableRow) as IpfcParamValue [optional]
Retrieves the value in the specified cell of the family table.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - The specified instance does not exist in the family table, or the specified model item is not table-driven.
See Also:
Parameters:
Column
The column in the family table
Row
The row in the family table
Returns:
The value in the specified cell
User Guide References:
Function
GetCellIsDefault
(Column as IpfcFamilyTableColumn, Row as IpfcFamilyTableRow) as Boolean
Determines if the value of the item in the specified cell is the default value.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - The specified instance does not exist in the family table, or the specified model item is not table-driven.
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.
User Guide References:
Function
GetColumn
(Symbol as String) as IpfcFamilyTableColumn [optional]
Returns a column in the family table, given its string name.
See Also:
Parameters:
Symbol
The family table column symbol.
Returns:
The column object, or null, if the column was not found.
User Guide References:
Function
GetImmediateGenericInfo
() as IpfcModelDescriptor [optional]
Gets the model descriptor of the immediate generic model.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - The specified model is not an instance -- it has no generic model.
Returns:
The model descriptor of the immediate generic model.
User Guide References:
Function
GetRow
(InstanceName as String) as IpfcFamilyTableRow [optional]
Returns the specified row of the family table.
Parameters:
InstanceName
The name of the instance to find.
Returns:
The specified instance.
User Guide References:
Function
GetTopGenericInfo
Gets the model descriptor of the top generic model.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - The specified model is not an instance -- it has no generic model.
IpfcXToolkitCantOpen - 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.
Returns:
The model descriptor of the top generic model.
User Guide References:
Function
ListColumns
() as IpfcFamilyTableColumns [optional]
Lists the columns of the family table.
Returns:
A sequence of the family table columns.
User Guide References:
Function
ListRows
() as IpfcFamilyTableRows [optional]
Lists the rows of the family table.
Returns:
A sequence of the family table rows.
User Guide References:
Sub
RemoveColumn
(Column as IpfcFamilyTableColumn)
Removes a specified column from the family table.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - The specified item was not found in the family table.
Parameters:
Column
The column to be deleted.
User Guide References:
Sub
RemoveRow
Removes a specified row from the family table.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - The specified instance does not exist in the family table.
Parameters:
Row
The row to be deleted.
User Guide References:
Sub
SetCell
Sets the value of the specified cell in the family table.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - The specified instance does not exist in the family table, or the specified model item is not table-driven.
See Also:
Parameters:
Column
The column where the cell is located.
Row
The row where the cell is located.
Value
The new cell value.
User Guide References:
Was this helpful?