CIP C++ documentation for class "wfcLayerState"

Class wfcLayerState

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

Description

Provides information of the layer state.

Method Summary


`void`	`ActivateLayerState ()`
	Activate specified layer state.

`void`	`AddLayer (pfcLayer_ptr Layer, pfcDisplayStatus DispStatus)`
	Add layer reference to a layer state.

`void`	`DeleteLayerState ()`
	Delete specified layer state.

`xstring`	`GetDefaultLayer (wfcDefLayerType DefLayerType)`
	Retrieves the name of the default layer of the specified type.

`wfcLayerStateData_ptr`	`GetLayerData ()`
	Get layer state reference data.

`xstring`	`GetLayerStateName ()`
	Returns the name of the layer state.

`void`	`HideLayerItem (pfcModelItem_ptr LayerItem)`
	Added an item to be hidden on the layer state.

`xbool`	`IsLayerItemHidden (pfcModelItem_ptr LayerItem)`
	Check if the item is hidden on the layer state.

`void`	`RemoveLayer (pfcLayer_ptr Layer)`
	Remove layer reference from a layer state.

`void`	`SetDefaultLayer (wfcDefLayerType DefLayerType, xrstring DefaultLayerName)`
	Sets up a default layer of the specified type.

`void`	`UnhideLayerItem (pfcModelItem_ptr LayerItem)`
	Remove the item from the layer state hidden items list.

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

Methods Inherited from Class pfcParent:: GetChild

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

Methods Inherited from Class wfcWParameterOwner:: ExportParameterTable, ApplyParameterTableset

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

Methods Inherited from Class wfcWRelationOwner:: GetRelationConstraints, UnitsUsed, UseUnits, EvaluateExpressionWithUnits

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

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

Methods Inherited from Class wfcWModelItem:: DeleteUserDefinedName, Unhide, Hide, IsHidden, IsNameReadOnly, IsZoneFeature, GetDefaultName

Method Detail

xstring GetLayerStateName ()

Returns the name of the layer state.

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

wfcLayerStateData_ptr GetLayerData ()

Get layer state reference data.

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

void AddLayer (pfcLayer_ptr Layer, pfcDisplayStatus DispStatus)

Add layer reference to a layer state.

Exceptions thrown (but not limited to):

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

pfcXToolkitNotFound - Layer state is not found.

pfcXToolkitNotExist - Layer does not exist.

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

Parameters:

Layer
DispStatus

Returns:

void RemoveLayer (pfcLayer_ptr Layer)

Remove layer reference from a layer state.

Exceptions thrown (but not limited to):

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

pfcXToolkitNotFound - Layer state or Layer is not found.

pfcXToolkitNotExist - Layer does not exist.

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

Parameters:

Layer

Returns:

void DeleteLayerState ()

Delete specified layer state.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - Layer state not found.

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

Returns:

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):

pfcXToolkitNotFound - Layer state not found.

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

Returns:

void UnhideLayerItem (pfcModelItem_ptr LayerItem)

Remove the item from the layer state hidden items list.

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - Layer state not found.

pfcXToolkitNoChange - Item is unhidden already.

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

Parameters:

LayerItem

Returns:

void HideLayerItem (pfcModelItem_ptr LayerItem)

Added an item to be hidden on the layer state.

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - Layer state not found.

pfcXToolkitNoChange - Item is already hidden on the layer state.

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

Parameters:

LayerItem

Returns:

xbool IsLayerItemHidden (pfcModelItem_ptr LayerItem)

Check if the item is hidden on the layer state.

Exceptions thrown (but not limited to):

pfcXToolkitNotExist - Layer state not found.

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

Parameters:

LayerItem

Returns:

void SetDefaultLayer (wfcDefLayerType DefLayerType, xrstring 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):

pfcXToolkitInvalidName - def_layer_name contains invalid characters.

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

Parameters:

DefLayerType
DefaultLayerName

Returns:

xstring GetDefaultLayer (wfcDefLayerType DefLayerType)

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

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

Parameters:

DefLayerType

Returns: