Class pfcFamilyMember
# include <pfcFamily.h>
class pfcFamilyMember
: public virtual pfcObject
{
xaideclare(pfcFamilyMember)
...
};
Description
This class describes a member in a family table.
Manual References:
Accessing Cell Information:pfcFamilyMember, Accessing Columns:pfcFamilyMember, Accessing Instances:pfcFamilyMember, Assembly Components:pfcFamilyMember, Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes:pfcFamilyMember, Creating Family Table Columns:pfcFamilyMember, Creating Family Table Instances:pfcFamilyMember, Model Information:pfcFamilyMember,
Direct Known Subclasses:
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. | |
Retrieves the value in the specified cell of the family table. | |
Determines if the value of the item in the specified cell is the default value. | |
Returns a column in the family table, given its string name. | |
Gets the model descriptor of the immediate generic model. | |
GetParent () | |
The parent of the member object (the immediate generic model). | |
Returns the specified row of the family table. | |
Gets the model descriptor of the top generic model. | |
ListColumns () | |
Lists the columns of the family table. | |
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 | () |
The parent of the member object (the immediate generic model).
If immediate generic model is not in session an pfcXToolkitCantOpen exception is thrown. In that case use pfcFamilyMember::GetImmediateGenericInfo() to get the model descriptor of immediate generic.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The specified model is not an instance -- it has no generic model.
pfcXToolkitCantOpen - 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.
Manual References:
GetImmediateGenericInfo | () |
Gets the model descriptor of the immediate generic model.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The specified model is not an instance -- it has no generic model.
Manual References:
Returns:
The model descriptor of the immediate generic model.
GetTopGenericInfo | () |
Gets the model descriptor of the top generic model.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The specified model is not an instance -- it has no generic model.
pfcXToolkitCantOpen - 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.
Manual References:
Returns:
The model descriptor of the top generic model.
ListColumns | () |
Lists the columns of the family table.
Manual References:
Returns:
A sequence of the family table columns.
ListRows | () |
Lists the rows of the family table.
Manual References:
Returns:
A sequence of the family table rows.
GetCell |
Retrieves the value in the specified cell of the family table.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The specified instance does not exist in the family table, or the specified model item is not table-driven.
See Also:
Manual References:
Parameters:
Column
The column in the family table
Row
The row in the family table
Returns:
The value in the specified cell
void | SetCell |
Sets the value of the specified cell in the family table.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The specified instance does not exist in the family table, or the specified model item is not table-driven.
See Also:
pfcFamilyMember::GetCell(pfcFamilyTableColumn_ptr, pfcFamilyTableRow_ptr), pfcCreateIntParamValue(xint), pfcCreateDoubleParamValue(xreal), pfcCreateStringParamValue(xrstring), pfcCreateBoolParamValue(xbool)
Manual 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 |
Determines if the value of the item in the specified cell is the default value.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The specified instance does not exist in the family table, or the specified model item is not table-driven.
Manual 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 |
Adds a new row to the family table.
Exceptions thrown (but not limited to):
pfcXToolkitFound - The specified instance already exists in the family table.
pfcXToolkitAbort - Operation of adding instance is aborted since the supplied name was already in use.
Manual References:
Parameters:
InstanceName
Name of the new instance.
Values
Values to add to the row (or NULL).
Returns:
New row
GetRow |
Returns the specified row of the family table.
Manual References:
Parameters:
InstanceName
The name of the instance to find.
Returns:
The specified instance.
void | RemoveRow |
Removes a specified row from the family table.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The specified instance does not exist in the family table.
Manual References:
Parameters:
Row
The row to be deleted.
Returns:
AddColumn |
Adds a new column to the family table.
Exceptions thrown (but not limited to):
pfcXToolkitNoChange - The specified item already exists in the family table.
Manual References:
Parameters:
Column
The object describing the column to add.
Values
Values to add to the new column (or NULL).
Returns:
The new column
void | RemoveColumn |
Removes a specified column from the family table.
Exceptions thrown (but not limited to):
pfcXToolkitNotFound - The specified item was not found in the family table.
Manual References:
Parameters:
Column
The column to be deleted.
Returns:
GetColumn |
Returns a column in the family table, given its string name.
See Also:
Manual References:
Parameters:
Symbol
The family table column symbol.
Returns:
The column object, or null, if the column was not found.
CreateColumn |
Creates a new family table column object given a string symbol.
The column will not be added to the family table until pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr) is used.
Manual 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 |
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 pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr) is used.
See Also:
Manual References:
Parameters:
Param
The parameter
Returns:
The new column
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 pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr) is used.
See Also:
Manual References:
Parameters:
Dim
The dimension.
Returns:
The new column.
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 pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr) is used.
See Also:
Manual References:
Parameters:
Feat
The feature
Returns:
The new column
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 pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr) .
See Also:
Manual References:
Parameters:
Comp
The component.
Returns:
The new column.
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 pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr) .
See Also:
pfcFamilyMember::CreateComponentColumn(pfcFeature_ptr), pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr)
Manual References:
Parameters:
Comp
Any ComponentFeat that contains the component being added
Returns:
The new column
CreateGroupColumn |
Creates a group column in the family table.
The column will not be added to the family table until pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr) is used.
See Also:
Manual References:
Parameters:
Group
The feature group to add to the table
Returns:
The new column
CreateMergePartColumn |
Creates a merged-part column in the family table.
The column will not be added to the family table until pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr) is used.
See Also:
Manual References:
Parameters:
Feat
The feature
Returns:
The new column
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 pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr) is used.
See Also:
pfcFamilyMember::CreateTolMinusColumn(pfcDimension_ptr), pfcFamilyMember::CreateTolPlusMinusColumn(pfcDimension_ptr), pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr)
Parameters:
Dim
The dimension whose tolerance will be assigned to the column.
Returns:
The created family table column.
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 pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr) is used.
See Also:
pfcFamilyMember::CreateTolPlusColumn(pfcDimension_ptr), pfcFamilyMember::CreateTolPlusMinusColumn(pfcDimension_ptr), pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr)
Parameters:
Dim
The dimension whose tolerance will be assigned to the column.
Returns:
The created family table column.
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 pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr) is used.
See Also:
pfcFamilyMember::CreateTolPlusColumn(pfcDimension_ptr), pfcFamilyMember::CreateTolMinusColumn(pfcDimension_ptr), pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr)
Parameters:
Dim
The dimension whose tolerance will be assigned to the column.
Returns:
The created family table column.