CIP C++ documentation for class "pfcLayer"

Class pfcLayer

# include <pfcLayer.h> class pfcLayer : public virtual pfcModelItem { xaideclare(pfcLayer) ... };

Description

This class describes a layer.

The possible values for the display status are as follows:

LAYER_NORMAL
LAYER_DISPLAY
LAYER_BLANK
LAYER_HIDDEN

Direct Known Subclasses:: wfcWLayer

Method Summary


`void`	`AddItem (pfcModelItem_ptr Item)`
	Adds the specified item to the layer.

`xint`	`CountUnsupportedItems ()`


`void`	`Delete ()`
	Deletes the layer.

`pfcDisplayStatus`	`GetStatus ()`
`void`	`SetStatus (pfcDisplayStatus value)`
	The display status

`xbool`	`HasUnsupportedItems ()`
	Returns `true` if the layer contains one or more item types not supported as `pfcModelItem` objects in PFC. Returns `false` otherwise.

`pfcModelItems_ptr`	`ListItems ()`
	This method returns only items which are supported as `pfcModelItem` objects in PFC. To identify if the layer has any items not supported in PFC, use `pfcLayer::HasUnsupportedItems()`.

`void`	`RemoveItem (pfcModelItem_ptr Item)`
	Removes the specified item from the layer.

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

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Method Detail

pfcModelItems_ptr ListItems ()

This method returns only items which are supported as pfcModelItem objects in PFC. To identify if the layer has any items not supported in PFC, use pfcLayer::HasUnsupportedItems().

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - A layer with the specified name was not found.

pfcXToolkitOutOfMemory - The layer has too many items to report.

Manual References:: ModelItem: Getting ModelItem Objects, ModelItem: Getting ModelItem Objects, ModelItem: Layer Operations, ModelItem: Layer Operations

Returns:: An array of the items on the layer

`pfcDisplayStatus`	`GetStatus`	`()`
`void`	`SetStatus`	`(pfcDisplayStatus value)`

The display status

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified layer was not found.

pfcXToolkitInvalidName - You specified an invalid layer name.

pfcXToolkitCantModify - display status of the layer cannot be changed

Manual References:: ModelItem: Layer Operations, ModelItem: Layer Operations, ModelItem: Layer Operations, ModelItem: Layer Operations

void AddItem (pfcModelItem_ptr Item)

Adds the specified item to the layer.

The following items cannot be added to a layer: ITEM_SURFACE, ITEM_EDGE, ITEM_COORD_SYS, ITEM_AXIS, ITEM_SIMPREP, ITEM_DTL_SYM_DEFINITION, ITEM_DTL_OLE_OBJECT, ITEM_EXPLODED_STATE. For these items the method will throw pfcXToolkitInvalidType exception.

Exceptions thrown(but not limited to):

pfcXToolkitInvalidName - You specified an invalid layer name.

pfcXToolkitInvalidType - You specified an invalid layer item type.