CIP Visual Basic.NET documentation for interface "IpfcFamilyMember"

Interface IpfcFamilyMember

Description

This class describes a member in a family table.

Direct Parent Classes:: IpfcObject

Direct Known Subclasses:: IpfcSolid

Property Summary


`Property`	`Parent`	`as IpfcFamilyMember [readonly, optional]`
	The parent of the member object (the immediate generic model).

Method Summary


`Function`	`AddColumn (Column as IpfcFamilyTableColumn, Values as IpfcParamValues [optional]) as IpfcFamilyTableColumn`
	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`	`CreateColumn (Type as IpfcFamilyColumnType, Symbol as String) as IpfcFamilyTableColumn`
	Creates a new family table column object given a string symbol.

`Function`	`CreateCompModelColumn (Comp as IpfcFeature) as IpfcFamColCompModel`
	Creates a component model column that will be added to a family table.

`Function`	`CreateComponentColumn (Comp as IpfcFeature) as IpfcFamColComp`
	Creates a single component column in the family table.

`Function`	`CreateDimensionColumn (Dim as IpfcDimension) as IpfcFamColDimension`
	Creates a dimension column in the family table.

`Function`	`CreateFeatureColumn (Feat as IpfcFeature) as IpfcFamColFeature`
	Creates a feature column in the family table.

`Function`	`CreateGroupColumn (Group as IpfcFeatureGroup) as IpfcFamColGroup`
	Creates a group column in the family table.

`Function`	`CreateMergePartColumn (Feat as IpfcFeature) as IpfcFamColMergePart`
	Creates a merged-part column in the family table.

`Function`	`CreateParamColumn (Param as IpfcParameter) as IpfcFamColParam`
	Creates a parameter column in the family table.

`Function`	`CreateTolMinusColumn (Dim as IpfcDimension) as IpfcFamColTolMinus`
	Creates a new family table column representing a dimension tolerance minus value.

`Function`	`CreateTolPlusColumn (Dim as IpfcDimension) as IpfcFamColTolPlus`
	Creates a new family table column representing a dimension tolerance plus value.

`Function`	`CreateTolPlusMinusColumn (Dim as IpfcDimension) as IpfcFamColTolPlusMinus`
	Creates a new family table column representing a dimension tolerance plus/minus symmetric value.

`Function`	`GetCell (Column as IpfcFamilyTableColumn, Row as IpfcFamilyTableRow) as IpfcParamValue [optional]`
	Retrieves the value in the specified cell of the family table.

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

`Function`	`GetColumn (Symbol as String) as IpfcFamilyTableColumn [optional]`
	Returns a column in the family table, given its string name.

`Function`	`GetImmediateGenericInfo () as IpfcModelDescriptor [optional]`
	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`	`GetTopGenericInfo () as IpfcModelDescriptor`
	Gets the model descriptor of the top generic model.

`Function`	`ListColumns () as IpfcFamilyTableColumns [optional]`
	Lists the columns of the family table.

`Function`	`ListRows () as IpfcFamilyTableRows [optional]`
	Lists the rows of the family table.

`Sub`	`RemoveColumn (Column as IpfcFamilyTableColumn)`
	Removes a specified column from the family table.

`Sub`	`RemoveRow (Row as IpfcFamilyTableRow)`
	Removes a specified row from the family table.

`Sub`	`SetCell (Column as IpfcFamilyTableColumn, Row as IpfcFamilyTableRow, Value as IpfcParamValue)`
	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

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

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.

Function CreateCompModelColumn (Comp as IpfcFeature) as IpfcFamColCompModel

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:: IpfcFamilyMember.CreateComponentColumn(), IpfcFamilyMember.AddColumn()

Parameters:

Comp: Any ComponentFeat that contains the component being added

Returns:: The new column

Function CreateComponentColumn (Comp as IpfcFeature) as IpfcFamColComp

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:: IpfcFamilyMember.AddColumn()

Parameters:

Comp: The component.

Returns:: The new column.

Function CreateDimensionColumn (Dim as IpfcDimension) as IpfcFamColDimension

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:: IpfcFamilyMember.AddColumn()

Parameters:

Dim: The dimension.

Returns:: The new column.

Function CreateFeatureColumn (Feat as IpfcFeature) as IpfcFamColFeature

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:: IpfcFamilyMember.AddColumn()

Parameters:

Feat: The feature

Returns:: The new column

Function CreateGroupColumn (Group as IpfcFeatureGroup) as IpfcFamColGroup

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:: IpfcFamilyMember.AddColumn()

Parameters:

Group: The feature group to add to the table

Returns:: The new column

Function CreateMergePartColumn (Feat as IpfcFeature) as IpfcFamColMergePart

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:: IpfcFamilyMember.AddColumn()

Parameters:

Feat: The feature

Returns:: The new column

Function CreateParamColumn (Param as IpfcParameter) as IpfcFamColParam

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:: IpfcFamilyMember.AddColumn()

Parameters:

Param: The parameter

Returns:: The new column

Function CreateTolMinusColumn (Dim as IpfcDimension) as IpfcFamColTolMinus

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:: IpfcFamilyMember.CreateTolPlusColumn(), IpfcFamilyMember.CreateTolPlusMinusColumn(), IpfcFamilyMember.AddColumn()

Parameters:

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

Returns:: The created family table column.

Function CreateTolPlusColumn (Dim as IpfcDimension) as IpfcFamColTolPlus

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:: IpfcFamilyMember.CreateTolMinusColumn(), IpfcFamilyMember.CreateTolPlusMinusColumn(), IpfcFamilyMember.AddColumn()

Parameters:

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

Returns:: The created family table column.

Function CreateTolPlusMinusColumn (Dim as IpfcDimension) as IpfcFamColTolPlusMinus

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:: IpfcFamilyMember.CreateTolPlusColumn(), IpfcFamilyMember.CreateTolMinusColumn(), IpfcFamilyMember.AddColumn()

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:: IpfcFamilyMember.SetCell()

Parameters:

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

Returns:: The value in the specified cell

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.

Function GetColumn (Symbol as String) as IpfcFamilyTableColumn [optional]

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

See Also:: IpfcFamilyMember.ListColumns()

Parameters:

Symbol: The family table column symbol.

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

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.

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.

Function GetTopGenericInfo () as IpfcModelDescriptor

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.

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

Function ListColumns () as IpfcFamilyTableColumns [optional]

Lists the columns of the family table.

Returns:: A sequence of the family table columns.

Function ListRows () as IpfcFamilyTableRows [optional]

Lists the rows of the family table.

Returns:: A sequence of the family table rows.

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.

Sub RemoveRow (Row as IpfcFamilyTableRow)

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.

Sub SetCell (Column as IpfcFamilyTableColumn, Row as IpfcFamilyTableRow, Value as IpfcParamValue)

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:: IpfcFamilyMember.GetCell(), CMpfcModelItem.CreateIntParamValue(), CMpfcModelItem.CreateDoubleParamValue(), CMpfcModelItem.CreateStringParamValue(), CMpfcModelItem.CreateBoolParamValue()

Parameters:

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