CIP Visual Basic.NET documentation for interface "IpfcLayer"

Interface IpfcLayer

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 Parent Classes:: IpfcModelItem

Property Summary


`Property`	`Status`	`as IpfcDisplayStatus`
	The display status

Method Summary


`Sub`	`AddItem (Item as IpfcModelItem)`
	Adds the specified item to the layer.

`Function`	`CountUnsupportedItems () as Long`


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

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

`Function`	`ListItems () as IpfcModelItems`
	This method returns only items which are supported as `IpfcModelItem` objects in PFC. To identify if the layer has any items not supported in PFC, use `IpfcLayer.HasUnsupportedItems()`.

`Sub`	`RemoveItem (Item as IpfcModelItem)`
	Removes the specified item from the layer.

Property Detail

Property Status as IpfcDisplayStatus

The display status

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The specified layer was not found.

IpfcXToolkitInvalidName - You specified an invalid layer name.

IpfcXToolkitCantModify - display status of the layer cannot be changed

Method Detail

Sub AddItem (Item as IpfcModelItem)

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 IpfcXToolkitInvalidType exception.

Exceptions thrown(but not limited to):

IpfcXToolkitInvalidName - You specified an invalid layer name.

IpfcXToolkitInvalidType - You specified an invalid layer item type.

Parameters:

Item: The item to add

Function CountUnsupportedItems () as Long

Returns:

Sub Delete ()

Deletes the layer.

Exceptions thrown (but not limited to):

IpfcXToolkitInvalidName - You specified an invalid layer name.

IpfcXToolkitNotFound - The system could not find a layer with the specified name.

Function HasUnsupportedItems () as Boolean

Returns true if the layer contains one or more item types not supported as IpfcModelItem objects in PFC. Returns false otherwise.

Returns:

Function ListItems () as IpfcModelItems

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

Exceptions thrown (but not limited to):

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

IpfcXToolkitOutOfMemory - The layer has too many items to report.

Returns:: An array of the items on the layer

Sub RemoveItem (Item as IpfcModelItem)

Removes the specified item from the layer.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The specified layer was not found.

IpfcXToolkitInvalidName - You specified an invalid layer name.

IpfcXToolkitInvalidType - You specified an invalid layer item type.

Parameters:

Item: The layer item to remove