CIP JAVA documentation for class "com.ptc.pfc.pfcModelItem.ModelItem"

Interface ModelItem

package com.ptc.pfc.pfcModelItem; public interface ModelItem extends com.ptc.pfc.pfcObject.Child, com.ptc.pfc.pfcBase.ActionSource, com.ptc.pfc.pfcModelItem.RelationOwner, com.ptc.pfc.pfcModelItem.ParameterOwner

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:: Layer, SolidGeometryLayerItem, BaseDimension, Feature, Edge, Surface, CoordSystem, Axis, Quilt, Curve, SimpRep, SolidBody, ExplodedState, Table, Note, DetailItem, WModelItem

Method Summary
`int`	`GetId ()` Get method for attribute "Id" The identifier of the model item
`/optional/ String`	`GetName ()` Gets the name of a model item.
`ModelItemType`	`GetType ()` Get method for attribute "Type" The type of model item
`void`	`SetName (String Name)` Sets the item name.

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Method Detail

GetName

/*optional*/ String GetName ()

Gets the name of a model item.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified item does not have a name.

Manual References:: ModelItem: ModelItem Information

Returns:

SetName

void SetName (String Name)

Sets the item name.

Exceptions thrown (but not limited to):

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

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

Manual References:: ModelItem: ModelItem Information

Parameters:

Name: The new item name.

Returns:

GetId

int GetId ()

The identifier of the model item

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

GetType

ModelItemType GetType ()

The type of model item

Exceptions thrown (but not limited to):

XInvalidModelItem - The model item is invalid.

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