CIP Visual Basic.NET documentation for interface "IpfcModelItemOwner"

Interface IpfcModelItemOwner

Description

This is a base class for an object that has model items associated with it (such as a model).

See Also:: IpfcModel

Direct Parent Classes:: IpfcParent

Direct Known Subclasses:: IpfcModel

Method Summary


`Function`	`GetItemById (Type as IpfcModelItemType, Id as Long) as IpfcModelItem [optional]`
	Returns the specified model item, given its identifier and type.

`Function`	`GetItemByName (Type as IpfcModelItemType, Name as String) as IpfcModelItem [optional]`
	Returns a model item, given a string name and type, if it exists.

`Function`	`ListItems (Type as IpfcModelItemType [optional]) as IpfcModelItems [optional]`
	Provides a list of model items of the specified type.

Method Detail

Function GetItemById (Type as IpfcModelItemType, Id as Long) as IpfcModelItem [optional]

Returns the specified model item, given its identifier and type.

Exceptions thrown (but not limited to):

IpfcXToolkitNotExist - This means either:

Feature with such identifier does not exist, OR
Item with such id and type does not exist.

Parameters:

Type: The type of the model item (feature, edge, and so on)
Id: The integer identifier of the model item

Returns:: The model item with the specified attributes, or null if a model item withsuch attributes has not been found.

Function GetItemByName (Type as IpfcModelItemType, Name as String) as IpfcModelItem [optional]

Returns a model item, given a string name and type, if it exists.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - This means either:

The specified layer_name does not exist in owner, OR
The item was not found, OR
The function did not find simplified representation in the solid.

See Also:: IpfcModelItem.GetName(), IpfcModelItem.SetName()

Parameters:

Type: The type of the model item to locate.
Name: The name of the model item to locate.

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

Function ListItems (Type as IpfcModelItemType [optional]) as IpfcModelItems [optional]

Provides a list of model items of the specified type.

Following model item types are supported for Solid models ITEM_FEATURE ITEM_SURFACE ITEM_COORD_SYS ITEM_AXIS ITEM_QUILT ITEM_EDGE ITEM_POINT ITEM_CURVE ITEM_LAYER ITEM_SOLID_GEOMETRY ITEM_NOTE ITEM_DIMENSION ITEM_REF_DIMENSION ITEM_EXPLODED_STATE ITEM_SIMPREP
Following model item types are supported for2D models ITEM_TABLE ITEM_DIMENSION ITEM_REF_DIMENSION ITEM_DTL_ENTITY ITEM_DTL_GROUP ITEM_DTL_SYM_DEFINITION ITEM_DTL_SYM_INSTANCE ITEM_DTL_OLE_OBJECT ITEM_LAYER

Parameters:

Type: The type of model items to retrieve. If this parameter is null, then allthe model items will be listed.
Note that only those surfaces associated with solid geometry are included in the list of model items when you specify ITEM_SURFACE or null as the Type . Surfaces of Creo Parametric Surface features and Quilts are not included. To obtain a list of the quilt features with their component datum surfaces, specify ITEM_QUILT.

Returns:: The list of model items, or null if no model items of the specified type has been found.