CIP JavaScript documentation for class " pfcFamilyMember"

Class pfcFamilyMember

Description

This class describes a member in a family table.

Direct Parent Classes:: pfcObject

Direct Known Subclasses:: pfcSolid

Property Summary


`/* readonly / / optional */ pfcFamilyMember`	`Parent`
	The parent of the member object (the immediate generic model).

Method Summary


`pfcFamilyTableColumn`	`AddColumn (pfcFamilyTableColumn Column, /* optional */ pfcParamValues Values)`
	Adds a new column to the family table.

`pfcFamilyTableRow`	`AddRow (string InstanceName, /* optional */ pfcParamValues Values)`
	Adds a new row to the family table.

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

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

`pfcFamColComp`	`CreateComponentColumn (pfcFeature Comp)`
	Creates a single component column in the family table.

`pfcFamColDimension`	`CreateDimensionColumn (pfcDimension Dim)`
	Creates a dimension column in the family table.

`pfcFamColFeature`	`CreateFeatureColumn (pfcFeature Feat)`
	Creates a feature column in the family table.

`pfcFamColGroup`	`CreateGroupColumn (pfcFeatureGroup Group)`
	Creates a group column in the family table.

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

`pfcFamColParam`	`CreateParamColumn (pfcParameter Param)`
	Creates a parameter column in the family table.

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

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

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

`/* optional */ pfcParamValue`	`GetCell (pfcFamilyTableColumn Column, pfcFamilyTableRow Row)`
	Retrieves the value in the specified cell of the family table.

`/* readonly */ boolean`	`GetCellIsDefault (pfcFamilyTableColumn Column, pfcFamilyTableRow Row)`
	Determines if the value of the item in the specified cell is the default value.

`/* optional */ pfcFamilyTableColumn`	`GetColumn (string Symbol)`
	Returns a column in the family table, given its string name.

`/* optional */ pfcModelDescriptor`	`GetImmediateGenericInfo ()`
	Gets the model descriptor of the immediate generic model.

`/* optional */ pfcFamilyTableRow`	`GetRow (string InstanceName)`
	Returns the specified row of the family table.

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

`/* optional */ pfcFamilyTableColumns`	`ListColumns ()`
	Lists the columns of the family table.

`/* optional */ pfcFamilyTableRows`	`ListRows ()`
	Lists the rows of the family table.

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

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

`void`	`SetCell (pfcFamilyTableColumn Column, pfcFamilyTableRow Row, pfcParamValue Value)`
	Sets the value of the specified cell in the family table.

Property Detail

/* readonly */ /* optional */ pfcFamilyMember Parent

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.

Method Detail

pfcFamilyTableColumn AddColumn (pfcFamilyTableColumn Column, /* optional */ pfcParamValues 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.

Parameters:

Column: The object describing the column to add.
Values: Values to add to the new column (or NULL).

Returns:: The new column

pfcFamilyTableRow AddRow (string InstanceName, /* optional */ pfcParamValues 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.

Parameters:

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

Returns:: New row

pfcFamilyTableColumn CreateColumn (pfcFamilyColumnType 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 pfcFamilyMember.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.

pfcFamColCompModel CreateCompModelColumn (pfcFeature 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() .

See Also:: pfcFamilyMember.CreateComponentColumn(), pfcFamilyMember.AddColumn()

Parameters:

Comp: Any ComponentFeat that contains the component being added

Returns:: The new column

pfcFamColComp CreateComponentColumn (pfcFeature 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() .

See Also:: pfcFamilyMember.AddColumn()

Parameters:

Comp: The component.

Returns:: The new column.

pfcFamColDimension CreateDimensionColumn (pfcDimension 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() is used.

See Also:: pfcFamilyMember.AddColumn()

Parameters:

Dim: The dimension.

Returns:: The new column.

pfcFamColFeature CreateFeatureColumn (pfcFeature 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() is used.

See Also:: pfcFamilyMember.AddColumn()

Parameters:

Feat: The feature

Returns:: The new column

pfcFamColGroup CreateGroupColumn (pfcFeatureGroup Group)

Creates a group column in the family table.

The column will not be added to the family table until pfcFamilyMember.AddColumn() is used.

See Also:: pfcFamilyMember.AddColumn()

Parameters:

Group: The feature group to add to the table

Returns:: The new column

pfcFamColMergePart CreateMergePartColumn (pfcFeature Feat)

Creates a merged-part column in the family table.

The column will not be added to the family table until pfcFamilyMember.AddColumn() is used.

See Also:: pfcFamilyMember.AddColumn()

Parameters:

Feat: The feature

Returns:: The new column

pfcFamColParam CreateParamColumn (pfcParameter 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() is used.

See Also:: pfcFamilyMember.AddColumn()

Parameters:

Param: The parameter

Returns:: The new column

pfcFamColTolMinus CreateTolMinusColumn (pfcDimension 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() is used.

See Also:: pfcFamilyMember.CreateTolPlusColumn(), pfcFamilyMember.CreateTolPlusMinusColumn(), pfcFamilyMember.AddColumn()

Parameters:

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

Returns:: The created family table column.

pfcFamColTolPlus CreateTolPlusColumn (pfcDimension 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() is used.

See Also:: pfcFamilyMember.CreateTolMinusColumn(), pfcFamilyMember.CreateTolPlusMinusColumn(), pfcFamilyMember.AddColumn()

Parameters:

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

Returns:: The created family table column.

pfcFamColTolPlusMinus CreateTolPlusMinusColumn (pfcDimension 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() is used.

See Also:: pfcFamilyMember.CreateTolPlusColumn(), pfcFamilyMember.CreateTolMinusColumn(), pfcFamilyMember.AddColumn()

Parameters:

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

Returns:: The created family table column.

/* optional */ pfcParamValue GetCell (pfcFamilyTableColumn Column, pfcFamilyTableRow 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()

Parameters:

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

Returns:: The value in the specified cell

/* readonly */ boolean GetCellIsDefault (pfcFamilyTableColumn Column, pfcFamilyTableRow 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.

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.

/* optional */ pfcFamilyTableColumn GetColumn (string Symbol)

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

See Also:: pfcFamilyMember.ListColumns()

Parameters:

Symbol: The family table column symbol.

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

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

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

/* optional */ pfcFamilyTableRow GetRow (string InstanceName)

Returns the specified row of the family table.

Parameters:

InstanceName: The name of the instance to find.

Returns:: The specified instance.

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

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

/* optional */ pfcFamilyTableColumns ListColumns ()

Lists the columns of the family table.

Returns:: A sequence of the family table columns.

/* optional */ pfcFamilyTableRows ListRows ()

Lists the rows of the family table.

Returns:: A sequence of the family table rows.

void RemoveColumn (pfcFamilyTableColumn 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.

Parameters:

Column: The column to be deleted.

void RemoveRow (pfcFamilyTableRow 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.

Parameters:

Row: The row to be deleted.

void SetCell (pfcFamilyTableColumn Column, pfcFamilyTableRow Row, pfcParamValue 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(), MpfcModelItem.CreateIntParamValue(), MpfcModelItem.CreateDoubleParamValue(), MpfcModelItem.CreateStringParamValue(), MpfcModelItem.CreateBoolParamValue()

Parameters:

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