CIP C++ documentation for class "wfcAssemblyItemInstructions"

Class wfcAssemblyItemInstructions

# include <wfcComponentFeat.h> class wfcAssemblyItemInstructions : public virtual xobject { xdeclare(wfcAssemblyItemInstructions) ... }; This is a COMPACT class.

Description

The instructions to create an variant item for Flexible component definition.

Method Summary


`static wfcAssemblyItemInstructions_ptr`	`Create (pfcModel_ptr ItemOwner, optional pfcModelItemType ItemType, xint ItemId)`
	Creates the AssemblyItemInstructions object.

`optional wfcWComponentPath_ptr`	`GetItemCompPath ()`
`void`	`SetItemCompPath (optional wfcWComponentPath_ptr value)`
	The item component path.

`xint`	`GetItemId ()`
`void`	`SetItemId (xint value)`
	The item identifier

`optional xstring`	`GetItemName ()`
`void`	`SetItemName (optional xrstring value)`
	Parameter Name

`pfcModel_ptr`	`GetItemOwner ()`
`void`	`SetItemOwner (pfcModel_ptr value)`
	The model owner of the item or parameter.

`pfcModelItemType`	`GetItemType ()`
`void`	`SetItemType (pfcModelItemType value)`
	The item type. In case of parameter pass type of owner modelitem. For model Parameter pass this as pfcModelItemType_nil.

Method Detail

`pfcModel_ptr`	`GetItemOwner`	`()`
`void`	`SetItemOwner`	`(pfcModel_ptr value)`

The model owner of the item or parameter.

Manual References:: Assemblies and Components: Variant Items for Flexible Components, Assemblies and Components: Variant Items for Flexible Components, Assemblies and Components: Variant Items for Flexible Components

`pfcModelItemType`	`GetItemType`	`()`
`void`	`SetItemType`	`(pfcModelItemType value)`

The item type. In case of parameter pass type of owner modelitem. For model Parameter pass this as pfcModelItemType_nil.

Manual References:: Assemblies and Components: Variant Items for Flexible Components, Assemblies and Components: Variant Items for Flexible Components, Assemblies and Components: Variant Items for Flexible Components, Assemblies and Components: Variant Items for Flexible Components

`xint`	`GetItemId`	`()`
`void`	`SetItemId`	`(xint value)`

The item identifier

Manual References:: Assemblies and Components: Variant Items for Flexible Components, Assemblies and Components: Variant Items for Flexible Components, Assemblies and Components: Variant Items for Flexible Components, Assemblies and Components: Variant Items for Flexible Components

`optional xstring`	`GetItemName`	`()`
`void`	`SetItemName`	`(optional xrstring value)`

Parameter Name

Manual References:: Assemblies and Components: Variant Items for Flexible Components, Assemblies and Components: Variant Items for Flexible Components, Assemblies and Components: Variant Items for Flexible Components, Assemblies and Components: Variant Items for Flexible Components

`optional wfcWComponentPath_ptr`	`GetItemCompPath`	`()`
`void`	`SetItemCompPath`	`(optional wfcWComponentPath_ptr value)`

The item component path.

To set a component as flexible, the path of this 'assembly item' should not contain the ID of a component which is: a) out of flexible context, b) to be made flexible.

Manual References:: Assemblies and Components: Variant Items for Flexible Components, Assemblies and Components: Variant Items for Flexible Components, Assemblies and Components: Variant Items for Flexible Components

static wfcAssemblyItemInstructions_ptr Create (pfcModel_ptr ItemOwner, optional pfcModelItemType ItemType, xint ItemId)

Creates the AssemblyItemInstructions object.

Manual References:: Assemblies and Components: Variant Items for Flexible Components, Assemblies and Components: Variant Items for Flexible Components

Parameters:

ItemOwner: The model owner of the item
ItemType: The item type
ItemId: The item identifier

Returns:: The AssemblyItemInstructions object.