CIP JAVA documentation for class "com.ptc.wfc.wfcLayerState.LayerState"

Interface LayerState

package com.ptc.wfc.wfcLayerState; public interface LayerState extends com.ptc.wfc.wfcModelItem.WModelItem

Description

Provides information of the layer state.

Method Summary
`void`	`ActivateLayerState ()` Activate specified layer state.
`void`	`AddLayer (Layer Layer, DisplayStatus DispStatus)` Add layer reference to a layer state.
`void`	`DeleteLayerState ()` Delete specified layer state.
`String`	`GetDefaultLayer (DefLayerType DefLayerType)` Retrieves the name of the default layer of the specified type.
`LayerStateData`	`GetLayerData ()` Get method for attribute "LayerData" Get layer state reference data.
`String`	`GetLayerStateName ()` Get method for attribute "LayerStateName" Returns the name of the layer state.
`void`	`HideLayerItem (ModelItem LayerItem)` Added an item to be hidden on the layer state.
`boolean`	`IsLayerItemHidden (ModelItem LayerItem)` Check if the item is hidden on the layer state.
`void`	`RemoveLayer (Layer Layer)` Remove layer reference from a layer state.
`void`	`SetDefaultLayer (DefLayerType DefLayerType, String DefaultLayerName)` Sets up a default layer of the specified type.
`void`	`UnhideLayerItem (ModelItem LayerItem)` Remove the item from the layer state hidden items list.

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

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`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WParameterOwner`
`ExportParameterTable`, `ApplyParameterTableset`, `MathcadParametersSet`, `MathcadInputParametersGet`

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

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WRelationOwner`
`GetRelationConstraints`, `UnitsUsed`, `UseUnits`, `EvaluateExpressionWithUnits`

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

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WModelItem`
`DeleteUserDefinedName`, `Unhide`, `Hide`, `IsHidden`, `IsNameReadOnly`, `IsZoneFeature`, `GetDefaultName`

Method Detail

GetLayerStateName

String GetLayerStateName ()

Returns the name of the layer state.

Manual References:: ModelItem: Layer State, ModelItem: Layer State

GetLayerData

LayerStateData GetLayerData ()

Get layer state reference data.

Manual References:: ModelItem: Layer State, ModelItem: Layer State

AddLayer

void AddLayer (Layer Layer, DisplayStatus DispStatus)

Add layer reference to a layer state.

Exceptions thrown (but not limited to):

XToolkitBadContext - Passed models of either layer state or the layer are not of ProSolid type.

XToolkitNotFound - Layer state is not found.

XToolkitNotExist - Layer does not exist.

Manual References:: ModelItem: Layer State, ModelItem: Layer State

Parameters:

Layer
DispStatus

Returns:

RemoveLayer

void RemoveLayer (Layer Layer)

Remove layer reference from a layer state.

Exceptions thrown (but not limited to):

XToolkitBadContext - Passed models of either layer state or the layer are not of ProSolid type.

XToolkitNotFound - Layer state or Layer is not found.

XToolkitNotExist - Layer does not exist.

Manual References:: ModelItem: Layer State, ModelItem: Layer State

Parameters:

Layer

Returns:

DeleteLayerState

void DeleteLayerState ()

Delete specified layer state.

Exceptions thrown (but not limited to):

XToolkitNotFound - Layer state not found.

Manual References:: ModelItem: Layer State, ModelItem: Layer State

Returns:

ActivateLayerState

void ActivateLayerState ()

Activate specified layer state.

Model of the layer state must be top model in window. Otherwise activate fails.

Exceptions thrown (but not limited to):

XToolkitNotFound - Layer state not found.

Manual References:: ModelItem: Layer State, ModelItem: Layer State

Returns:

UnhideLayerItem

void UnhideLayerItem (ModelItem LayerItem)

Remove the item from the layer state hidden items list.

Exceptions thrown (but not limited to):

XToolkitNotExist - Layer state not found.

XToolkitNoChange - Item is unhidden already.

Manual References:: ModelItem: Layer State, ModelItem: Layer State

Parameters:

LayerItem

Returns:

HideLayerItem

void HideLayerItem (ModelItem LayerItem)

Added an item to be hidden on the layer state.

Exceptions thrown (but not limited to):

XToolkitNotExist - Layer state not found.

XToolkitNoChange - Item is already hidden on the layer state.

Manual References:: ModelItem: Layer State, ModelItem: Layer State

Parameters:

LayerItem

Returns:

IsLayerItemHidden

boolean IsLayerItemHidden (ModelItem LayerItem)

Check if the item is hidden on the layer state.

Exceptions thrown (but not limited to):

XToolkitNotExist - Layer state not found.

Manual References:: ModelItem: Layer State, ModelItem: Layer State

Parameters:

LayerItem

Returns:

SetDefaultLayer

void SetDefaultLayer (DefLayerType DefLayerType, String DefaultLayerName)

Sets up a default layer of the specified type.

This function is equivalent to setting the default layer name for the session using the configuration option "def_layer". This does not save the status to a particular model. The default layer status does not remain on a layer if it is renamed.

Exceptions thrown (but not limited to):

XToolkitInvalidName - def_layer_name contains invalid characters.

Manual References:: ModelItem: Layer State, ModelItem: Layer State

Parameters:

DefLayerType
DefaultLayerName

Returns:

GetDefaultLayer

String GetDefaultLayer (DefLayerType DefLayerType)

Retrieves the name of the default layer of the specified type.

Manual References:: ModelItem: Layer State, ModelItem: Layer State

Parameters:

DefLayerType

Returns: