CIP C++ documentation for class "wfcCombState"

Class wfcCombState

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

Description

>Represent Combined State in solid

Method Summary


`void`	`AddAnnotations (wfcCombStateAnnotations_ptr Annotations)`


`void`	`AddItems (wfcCombStateItems_ptr Items)`


`void`	`EraseAnnotation (wfcAnnotation_ptr Annot)`


`optional wfcCombStateAnnotations_ptr`	`GetAnnotations ()`


`wfcCombStateData_ptr`	`GetCombStateData ()`
	Gets Combined State data in the combined state

`optional wfcCombStateItems_ptr`	`GetItems ()`


`xbool`	`GetStateOfAnnotations ()`


`xbool`	`GetStateOfSupplGeometry ()`
	Checks if Supplementary Geometry is controlled by layers or specified combined state.

`xbool`	`IsDefault ()`


`xbool`	`IsPublished ()`


`void`	`RedefineCombState (wfcCombStateData_ptr Data)`
	Redefines combined state

`optional xintsequence_ptr`	`RemoveAnnotations (wfcAnnotations_ptr Annotations)`


`optional xintsequence_ptr`	`RemoveItems (pfcModelItems_ptr Items)`


`void`	`SetStateOfAnnotations (xbool State)`
	Change Annotations state at combined state.

`void`	`SetStateOfSupplGeometry (xbool State)`
	Change Supplementary Geometry state at combined state.

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

wfcCombStateData_ptr GetCombStateData ()

Gets Combined State data in the combined state

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No such combined state in the specified model.

Manual References:: Solid: Combined States of a Solid, Solid: Combined States of a Solid

Returns:: CombStateData

void RedefineCombState (wfcCombStateData_ptr Data)

Redefines combined state

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - Invalid references. Possible errors: - The type of one of the references is not valid. - Reference of some type appears twice or more. - Id and type of a reference don't match.

Manual References:: Solid: Combined States of a Solid, Solid: Combined States of a Solid

Parameters:

Data: Combined State data

Returns:

void AddAnnotations (wfcCombStateAnnotations_ptr Annotations)

Exceptions thrown (but not limited to):

pfcXToolkitInvalidItem - size of status_flags' array differs from the size of annotations' array.

pfcXToolkitNotFound - This legacy combined state doesn't have annotation state. Annotations cannot be added.

pfcXToolkitNoChange - Status of some annotations wasn't changed. Some annotations existed in the combined state already and their status was same as the one in the input.