CIP C++ documentation for class "pfcFamilyMember"

Class pfcFamilyMember

# include <pfcFamily.h> class pfcFamilyMember : public virtual pfcObject { xaideclare(pfcFamilyMember) ... };

Description

This class describes a member in a family table.

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Direct Known Subclasses:: pfcSolid, wfcWFamilyMember

Method Summary


`pfcFamilyTableColumn_ptr`	`AddColumn (pfcFamilyTableColumn_ptr Column, optional pfcParamValues_ptr Values)`
	Adds a new column to the family table.

`pfcFamilyTableRow_ptr`	`AddRow (xrstring InstanceName, optional pfcParamValues_ptr Values)`
	Adds a new row to the family table.

`pfcFamilyTableColumn_ptr`	`CreateColumn (pfcFamilyColumnType Type, xrstring Symbol)`
	Creates a new family table column object given a string symbol.

`pfcFamColCompModel_ptr`	`CreateCompModelColumn (pfcFeature_ptr Comp)`
	Creates a component model column that will be added to a family table.

`pfcFamColComp_ptr`	`CreateComponentColumn (pfcFeature_ptr Comp)`
	Creates a single component column in the family table.

`pfcFamColDimension_ptr`	`CreateDimensionColumn (pfcDimension_ptr Dim)`
	Creates a dimension column in the family table.

`pfcFamColFeature_ptr`	`CreateFeatureColumn (pfcFeature_ptr Feat)`
	Creates a feature column in the family table.

`pfcFamColGroup_ptr`	`CreateGroupColumn (pfcFeatureGroup_ptr Group)`
	Creates a group column in the family table.

`pfcFamColMergePart_ptr`	`CreateMergePartColumn (pfcFeature_ptr Feat)`
	Creates a merged-part column in the family table.

`pfcFamColParam_ptr`	`CreateParamColumn (pfcParameter_ptr Param)`
	Creates a parameter column in the family table.

`pfcFamColTolMinus_ptr`	`CreateTolMinusColumn (pfcDimension_ptr Dim)`
	Creates a new family table column representing a dimension tolerance minus value.

`pfcFamColTolPlus_ptr`	`CreateTolPlusColumn (pfcDimension_ptr Dim)`
	Creates a new family table column representing a dimension tolerance plus value.

`pfcFamColTolPlusMinus_ptr`	`CreateTolPlusMinusColumn (pfcDimension_ptr Dim)`
	Creates a new family table column representing a dimension tolerance plus/minus symmetric value.

`optional pfcParamValue_ptr`	`GetCell (pfcFamilyTableColumn_ptr Column, pfcFamilyTableRow_ptr Row)`
	Retrieves the value in the specified cell of the family table.

`xbool`	`GetCellIsDefault (pfcFamilyTableColumn_ptr Column, pfcFamilyTableRow_ptr Row)`
	Determines if the value of the item in the specified cell is the default value.

`optional pfcFamilyTableColumn_ptr`	`GetColumn (xrstring Symbol)`
	Returns a column in the family table, given its string name.

`optional pfcModelDescriptor_ptr`	`GetImmediateGenericInfo ()`
	Gets the model descriptor of the immediate generic model.

`optional pfcFamilyMember_ptr`	`GetParent ()`
	The parent of the member object (the immediate generic model).

`optional pfcFamilyTableRow_ptr`	`GetRow (xrstring InstanceName)`
	Returns the specified row of the family table.

`pfcModelDescriptor_ptr`	`GetTopGenericInfo ()`
	Gets the model descriptor of the top generic model.

`optional pfcFamilyTableColumns_ptr`	`ListColumns ()`
	Lists the columns of the family table.

`optional pfcFamilyTableRows_ptr`	`ListRows ()`
	Lists the rows of the family table.

`void`	`RemoveColumn (pfcFamilyTableColumn_ptr Column)`
	Removes a specified column from the family table.

`void`	`RemoveRow (pfcFamilyTableRow_ptr Row)`
	Removes a specified row from the family table.

`void`	`SetCell (pfcFamilyTableColumn_ptr Column, pfcFamilyTableRow_ptr Row, pfcParamValue_ptr Value)`
	Sets the value of the specified cell in the family table.

Method Detail

optional pfcFamilyMember_ptr 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:: Family Tables: Accessing Instances, Family Tables: Accessing Instances

optional pfcModelDescriptor_ptr 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:: Family Tables: Accessing Instances, Family Tables: Accessing Instances, Models: Model Information, Assemblies and Components: Assembly Components

Returns:: The model descriptor of the immediate generic model.

pfcModelDescriptor_ptr 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.

Manual References:: Family Tables: Accessing Instances, Family Tables: Accessing Instances

Returns:: The model descriptor of the top generic model.

optional pfcFamilyTableColumns_ptr ListColumns ()

Lists the columns of the family table.

Manual References:: Family Tables: Accessing Columns, Family Tables: Accessing Columns

Returns:: A sequence of the family table columns.

optional pfcFamilyTableRows_ptr ListRows ()

Lists the rows of the family table.

Manual References:: Family Tables: Accessing Instances, Family Tables: Accessing Instances

Returns:: A sequence of the family table rows.

optional pfcParamValue_ptr GetCell (pfcFamilyTableColumn_ptr Column, pfcFamilyTableRow_ptr Row)

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:: pfcFamilyMember::SetCell(pfcFamilyTableColumn_ptr, pfcFamilyTableRow_ptr, pfcParamValue_ptr)

Manual References:: Family Tables: Accessing Cell Information, Family Tables: Accessing Cell Information

Parameters:

Column: The column in the family table
Row: The row in the family table

Returns:: The value in the specified cell

void SetCell (pfcFamilyTableColumn_ptr Column, pfcFamilyTableRow_ptr Row, pfcParamValue_ptr Value)

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:: Family Tables: Accessing Cell Information, Family Tables: Accessing Cell Information

Parameters:

Column: The column where the cell is located.
Row: The row where the cell is located.
Value: The new cell value.

Returns:

xbool GetCellIsDefault (pfcFamilyTableColumn_ptr Column, pfcFamilyTableRow_ptr Row)

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:: Family Tables: Accessing Cell Information, Family Tables: Accessing Cell Information

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.

pfcFamilyTableRow_ptr AddRow (xrstring InstanceName, optional pfcParamValues_ptr Values)

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:: Family Tables: Creating Family Table Instances, Family Tables: Creating Family Table Instances

Parameters:

InstanceName: Name of the new instance.
Values: Values to add to the row (or NULL).

Returns:: New row

optional pfcFamilyTableRow_ptr GetRow (xrstring InstanceName)

Returns the specified row of the family table.

Manual References:: Family Tables: Accessing Instances, Family Tables: Accessing Instances

Parameters:

InstanceName: The name of the instance to find.

Returns:: The specified instance.

void RemoveRow (pfcFamilyTableRow_ptr Row)

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:: Family Tables: Accessing Instances, Family Tables: Accessing Instances

Parameters:

Row: The row to be deleted.

Returns:

pfcFamilyTableColumn_ptr AddColumn (pfcFamilyTableColumn_ptr Column, optional pfcParamValues_ptr Values)

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:: Family Tables: Creating Family Table Columns, Family Tables: Creating Family Table Columns

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 (pfcFamilyTableColumn_ptr Column)

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:: Family Tables: Accessing Columns, Family Tables: Accessing Columns

Parameters:

Column: The column to be deleted.

Returns:

optional pfcFamilyTableColumn_ptr GetColumn (xrstring Symbol)

Returns a column in the family table, given its string name.

See Also:: pfcFamilyMember::ListColumns()

Manual References:: Family Tables: Accessing Columns, Family Tables: Accessing Columns

Parameters:

Symbol: The family table column symbol.

Returns:: The column object, or null, if the column was not found.

pfcFamilyTableColumn_ptr CreateColumn (pfcFamilyColumnType Type, xrstring Symbol)

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:: Family Tables: Creating Family Table Columns, Family Tables: Creating Family Table Columns

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.

pfcFamColParam_ptr CreateParamColumn (pfcParameter_ptr Param)

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:: pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr)

Manual References:: Family Tables: Creating Family Table Columns

Parameters:

Param: The parameter

Returns:: The new column

pfcFamColDimension_ptr CreateDimensionColumn (pfcDimension_ptr Dim)

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:: pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr)

Manual References:: Family Tables: Creating Family Table Columns

Parameters:

Dim: The dimension.

Returns:: The new column.

pfcFamColFeature_ptr CreateFeatureColumn (pfcFeature_ptr Feat)

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:: pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr)

Manual References:: Family Tables: Creating Family Table Columns

Parameters:

Feat: The feature

Returns:: The new column

pfcFamColComp_ptr CreateComponentColumn (pfcFeature_ptr Comp)

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:: pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr)

Manual References:: Family Tables: Creating Family Table Columns

Parameters:

Comp: The component.

Returns:: The new column.

pfcFamColCompModel_ptr CreateCompModelColumn (pfcFeature_ptr Comp)

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:: Family Tables: Creating Family Table Columns

Parameters:

Comp: Any ComponentFeat that contains the component being added

Returns:: The new column

pfcFamColGroup_ptr CreateGroupColumn (pfcFeatureGroup_ptr Group)

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:: pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr)

Manual References:: Family Tables: Creating Family Table Columns

Parameters:

Group: The feature group to add to the table

Returns:: The new column

pfcFamColMergePart_ptr CreateMergePartColumn (pfcFeature_ptr Feat)

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:: pfcFamilyMember::AddColumn(pfcFamilyTableColumn_ptr, optional pfcParamValues_ptr)

Manual References:: Family Tables: Creating Family Table Columns

Parameters:

Feat: The feature

Returns:: The new column

pfcFamColTolPlus_ptr CreateTolPlusColumn (pfcDimension_ptr Dim)

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.

pfcFamColTolMinus_ptr CreateTolMinusColumn (pfcDimension_ptr Dim)

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.

pfcFamColTolPlusMinus_ptr CreateTolPlusMinusColumn (pfcDimension_ptr Dim)

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.