CIP JAVA documentation for class "com.ptc.pfc.pfcFamily.FamilyMember"

Interface FamilyMember

package com.ptc.pfc.pfcFamily; public interface FamilyMember extends com.ptc.pfc.pfcObject.Object

Description

This class describes a member in a family table.

Direct Known Subclasses:: Solid, WFamilyMember

Method Summary
`FamilyTableColumn`	`AddColumn (FamilyTableColumn Column, /optional/ ParamValues Values)` Adds a new column to the family table.
`FamilyTableRow`	`AddRow (String InstanceName, /optional/ ParamValues Values)` Adds a new row to the family table.
`FamilyTableColumn`	`CreateColumn (FamilyColumnType Type, String Symbol)` Creates a new family table column object given a string symbol.
`FamColCompModel`	`CreateCompModelColumn (Feature Comp)` Creates a component model column that will be added to a family table.
`FamColComp`	`CreateComponentColumn (Feature Comp)` Creates a single component column in the family table.
`FamColDimension`	`CreateDimensionColumn (Dimension Dim)` Creates a dimension column in the family table.
`FamColFeature`	`CreateFeatureColumn (Feature Feat)` Creates a feature column in the family table.
`FamColGroup`	`CreateGroupColumn (FeatureGroup Group)` Creates a group column in the family table.
`FamColMergePart`	`CreateMergePartColumn (Feature Feat)` Creates a merged-part column in the family table.
`FamColParam`	`CreateParamColumn (Parameter Param)` Creates a parameter column in the family table.
`FamColTolMinus`	`CreateTolMinusColumn (Dimension Dim)` Creates a new family table column representing a dimension tolerance minus value.
`FamColTolPlus`	`CreateTolPlusColumn (Dimension Dim)` Creates a new family table column representing a dimension tolerance plus value.
`FamColTolPlusMinus`	`CreateTolPlusMinusColumn (Dimension Dim)` Creates a new family table column representing a dimension tolerance plus/minus symmetric value.
`/optional/ ParamValue`	`GetCell (FamilyTableColumn Column, FamilyTableRow Row)` Retrieves the value in the specified cell of the family table.
`boolean`	`GetCellIsDefault (FamilyTableColumn Column, FamilyTableRow Row)` Determines if the value of the item in the specified cell is the default value.
`/optional/ FamilyTableColumn`	`GetColumn (String Symbol)` Returns a column in the family table, given its string name.
`/optional/ ModelDescriptor`	`GetImmediateGenericInfo ()` Gets the model descriptor of the immediate generic model.
`/optional/ FamilyMember`	`GetParent ()` Get method for attribute "Parent" The parent of the member object (the immediate generic model).
`/optional/ FamilyTableRow`	`GetRow (String InstanceName)` Returns the specified row of the family table.
`ModelDescriptor`	`GetTopGenericInfo ()` Gets the model descriptor of the top generic model.
`/optional/ FamilyTableColumns`	`ListColumns ()` Lists the columns of the family table.
`/optional/ FamilyTableRows`	`ListRows ()` Lists the rows of the family table.
`void`	`RemoveColumn (FamilyTableColumn Column)` Removes a specified column from the family table.
`void`	`RemoveRow (FamilyTableRow Row)` Removes a specified row from the family table.
`void`	`SetCell (FamilyTableColumn Column, FamilyTableRow Row, ParamValue Value)` Sets the value of the specified cell in the family table.

Method Detail

GetParent

/*optional*/ 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.

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

GetImmediateGenericInfo

/*optional*/ 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.

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.

GetTopGenericInfo

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

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

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

ListColumns

/*optional*/ FamilyTableColumns 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.

ListRows

/*optional*/ FamilyTableRows 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.

GetCell

/*optional*/ ParamValue GetCell (FamilyTableColumn Column, FamilyTableRow Row)

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:: FamilyMember.SetCell(FamilyTableColumn, FamilyTableRow, ParamValue)

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

SetCell

void SetCell (FamilyTableColumn Column, FamilyTableRow Row, ParamValue Value)

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)

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:

GetCellIsDefault

boolean GetCellIsDefault (FamilyTableColumn Column, FamilyTableRow Row)

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.

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.

AddRow

FamilyTableRow AddRow (String InstanceName, /*optional*/ ParamValues Values)

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.

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

GetRow

/*optional*/ FamilyTableRow GetRow (String 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.

RemoveRow

void RemoveRow (FamilyTableRow Row)

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.

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

Parameters:

Row: The row to be deleted.

Returns:

AddColumn

FamilyTableColumn AddColumn (FamilyTableColumn Column, /*optional*/ ParamValues Values)

Adds a new column to the family table.

Exceptions thrown (but not limited to):

XToolkitNoChange - 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

RemoveColumn

void RemoveColumn (FamilyTableColumn Column)

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.

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

Parameters:

Column: The column to be deleted.

Returns:

GetColumn

/*optional*/ FamilyTableColumn GetColumn (String Symbol)

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

See Also:: FamilyMember.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.

CreateColumn

FamilyTableColumn CreateColumn (FamilyColumnType Type, String Symbol)

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, /*optional*/ ParamValues) 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.

CreateParamColumn

FamColParam CreateParamColumn (Parameter 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 FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues) is used.

See Also:: FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues)

Manual References:: Family Tables: Creating Family Table Columns

Parameters:

Param: The parameter

Returns:: The new column

CreateDimensionColumn

FamColDimension CreateDimensionColumn (Dimension 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 FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues) is used.

See Also:: FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues)

Manual References:: Family Tables: Creating Family Table Columns

Parameters:

Dim: The dimension.

Returns:: The new column.

CreateFeatureColumn

FamColFeature CreateFeatureColumn (Feature 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 FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues) is used.

See Also:: FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues)

Manual References:: Family Tables: Creating Family Table Columns

Parameters:

Feat: The feature

Returns:: The new column

CreateComponentColumn

FamColComp CreateComponentColumn (Feature 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 FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues) .

See Also:: FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues)

Manual References:: Family Tables: Creating Family Table Columns

Parameters:

Comp: The component.

Returns:: The new column.

CreateCompModelColumn

FamColCompModel CreateCompModelColumn (Feature 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 FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues) .

See Also:: FamilyMember.CreateComponentColumn(Feature), FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues)

Manual References:: Family Tables: Creating Family Table Columns

Parameters:

Comp: Any ComponentFeat that contains the component being added

Returns:: The new column

CreateGroupColumn

FamColGroup CreateGroupColumn (FeatureGroup Group)

Creates a group column in the family table.

The column will not be added to the family table until FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues) is used.

See Also:: FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues)

Manual References:: Family Tables: Creating Family Table Columns

Parameters:

Group: The feature group to add to the table

Returns:: The new column

CreateMergePartColumn

FamColMergePart CreateMergePartColumn (Feature Feat)

Creates a merged-part column in the family table.

The column will not be added to the family table until FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues) is used.

See Also:: FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues)

Manual References:: Family Tables: Creating Family Table Columns

Parameters:

Feat: The feature

Returns:: The new column

CreateTolPlusColumn

FamColTolPlus CreateTolPlusColumn (Dimension 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 FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues) is used.

See Also:: FamilyMember.CreateTolMinusColumn(Dimension), FamilyMember.CreateTolPlusMinusColumn(Dimension), FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues)

Parameters:

Dim: The dimension whose tolerance will be assigned to the column.

Returns:: The created family table column.

CreateTolMinusColumn

FamColTolMinus CreateTolMinusColumn (Dimension 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 FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues) is used.

See Also:: FamilyMember.CreateTolPlusColumn(Dimension), FamilyMember.CreateTolPlusMinusColumn(Dimension), FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues)

Parameters:

Dim: The dimension whose tolerance will be assigned to the column.

Returns:: The created family table column.

CreateTolPlusMinusColumn

FamColTolPlusMinus CreateTolPlusMinusColumn (Dimension 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 FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues) is used.

See Also:: FamilyMember.CreateTolPlusColumn(Dimension), FamilyMember.CreateTolMinusColumn(Dimension), FamilyMember.AddColumn(FamilyTableColumn, /*optional*/ ParamValues)

Parameters:

Dim: The dimension whose tolerance will be assigned to the column.

Returns:: The created family table column.