CIP Visual Basic.NET documentation for interface "IpfcModelItem"

Interface IpfcModelItem

Description

This class defines a model item.

A model item is an object associated with a model (such as feature, surface, dimension, etc.) that is identified by an integer.

The possible types of model item are as follows:

ITEM_FEATURE
ITEM_SURFACE
ITEM_EDGE
ITEM_COORD_SYS
ITEM_AXIS
ITEM_POINT
ITEM_QUILT
ITEM_CURVE
ITEM_LAYER
ITEM_NOTE
ITEM_DIMENSION
ITEM_REF_DIMENSION

Direct Parent Classes:: IpfcChild, IpfcActionSource, IpfcRelationOwner, IpfcParameterOwner

Direct Known Subclasses:: IpfcLayer, IpfcSolidGeometryLayerItem, IpfcBaseDimension, IpfcFeature, IpfcEdge, IpfcSurface, IpfcCoordSystem, IpfcAxis, IpfcQuilt, IpfcCurve, IpfcSimpRep, IpfcSolidBody, IpfcExplodedState, IpfcTable, IpfcNote, IpfcDetailItem

Property Summary


`Property`	`Id`	`as Long`
	The identifier of the model item

`Property`	`Type`	`as IpfcModelItemType`
	The type of model item

Method Summary


`Function`	`GetName () as String [optional]`
	Gets the name of a model item.

`Sub`	`SetName (Name as String)`
	Sets the item name.

Property Detail

Property Id as Long

The identifier of the model item

Property Type as IpfcModelItemType

The type of model item

Exceptions thrown (but not limited to):

IpfcXInvalidModelItem - The model item is invalid.

Method Detail

Function GetName () as String [optional]

Gets the name of a model item.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The specified item does not have a name.

Returns:

Sub SetName (Name as String)

Sets the item name.

Exceptions thrown (but not limited to):

IpfcXToolkitLineTooLong - The string passed has exceeded the maximum size, that is, PRO_NAME_SIZE.

IpfcXToolkitInvalidName - The name specified is not a valid name for a model item in Creo Parametric.

Parameters:

Name: The new item name.