CIP C++ documentation for class "pfcModelItem"

Class pfcModelItem

# include <pfcModelItem.h> class pfcModelItem : public virtual pfcChild, : public virtual pfcActionSource, : public virtual pfcRelationOwner, : public virtual pfcParameterOwner { xaideclare(pfcModelItem) ... };

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 Known Subclasses:: pfcLayer, pfcSolidGeometryLayerItem, pfcBaseDimension, pfcFeature, pfcEdge, pfcSurface, pfcCoordSystem, pfcAxis, pfcQuilt, pfcCurve, pfcSimpRep, pfcSolidBody, pfcExplodedState, pfcTable, pfcNote, pfcDetailItem, wfcWModelItem

Method Summary


`xint`	`GetId ()`
	The identifier of the model item

`optional xstring`	`GetName ()`
	Gets the name of a model item.

`pfcModelItemType`	`GetType ()`
	The type of model item

`void`	`SetName (xrstring Name)`
	Sets the item name.

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Method Detail

optional xstring GetName ()

Gets the name of a model item.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified item does not have a name.

Manual References:: ModelItem: ModelItem Information, ModelItem: ModelItem Information

Returns:

void SetName (xrstring Name)

Sets the item name.

Exceptions thrown (but not limited to):

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

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

Manual References:: ModelItem: ModelItem Information, ModelItem: ModelItem Information

Parameters:

Name: The new item name.

Returns:

xint GetId ()

The identifier of the model item

Manual References:: ModelItem: ModelItem Information

pfcModelItemType GetType ()

The type of model item

Exceptions thrown (but not limited to):

pfcXInvalidModelItem - The model item is invalid.

Manual References:: ModelItem: ModelItem Information, ModelItem: ModelItem Information