CIP JAVA documentation for class "com.ptc.wfc.wfcCombState.CombState"

Interface CombState

package com.ptc.wfc.wfcCombState; public interface CombState extends com.ptc.wfc.wfcModelItem.WModelItem

Description

>Represent Combined State in solid

Method Summary
`void`	`AddAnnotations (CombStateAnnotations Annotations)`
`void`	`AddItems (CombStateItems Items)`
`void`	`EraseAnnotation (Annotation Annot)`
`/optional/ CombStateAnnotations`	`GetAnnotations ()`
`CombStateData`	`GetCombStateData ()` Gets Combined State data in the combined state
`/optional/ CombStateItems`	`GetItems ()`
`boolean`	`GetStateOfAnnotations ()`
`boolean`	`GetStateOfSupplGeometry ()` Checks if Supplementary Geometry is controlled by layers or specified combined state.
`boolean`	`IsDefault ()`
`boolean`	`IsPublished ()`
`void`	`RedefineCombState (CombStateData Data)` Redefines combined state
`/optional/ intseq`	`RemoveAnnotations (Annotations Annotations)`
`/optional/ intseq`	`RemoveItems (ModelItems Items)`
`void`	`SetStateOfAnnotations (boolean State)` Change Annotations state at combined state.
`void`	`SetStateOfSupplGeometry (boolean State)` Change Supplementary Geometry state at combined state.

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

GetCombStateData

CombStateData GetCombStateData ()

Gets Combined State data in the combined state

Exceptions thrown (but not limited to):

XToolkitNotFound - No such combined state in the specified model.

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

Returns:: CombStateData

RedefineCombState

void RedefineCombState (CombStateData Data)

Redefines combined state

Exceptions thrown (but not limited to):

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

AddAnnotations

void AddAnnotations (CombStateAnnotations Annotations)

Exceptions thrown (but not limited to):

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

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

XToolkitNoChange - 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.

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

Parameters:

Annotations

Returns:

AddItems

void AddItems (CombStateItems Items)

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

Parameters:

Items

Returns:

GetAnnotations

/*optional*/ CombStateAnnotations GetAnnotations ()

Exceptions thrown (but not limited to):

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

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

Returns:

GetItems

/*optional*/ CombStateItems GetItems ()

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

Returns:

RemoveAnnotations

/*optional*/ intseq RemoveAnnotations (Annotations Annotations)

Exceptions thrown (but not limited to):

XToolkitNotFound - This legacy combined state doesn't have annotation state. Annotations cannot be Removed.

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

Parameters:

Annotations

Returns:

RemoveItems

/*optional*/ intseq RemoveItems (ModelItems Items)

Manual References:: Solid: Combined States of a Solid

Parameters:

Items

Returns:

EraseAnnotation

void EraseAnnotation (Annotation Annot)

Exceptions thrown (but not limited to):

XToolkitNoChange - The annotation is not shown in the target model.

XToolkitNoLicense - License check failure.

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

Parameters:

Annot

Returns:

GetStateOfAnnotations

boolean GetStateOfAnnotations ()

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

Returns:

GetStateOfSupplGeometry

boolean GetStateOfSupplGeometry ()

Checks if Supplementary Geometry is controlled by layers or specified combined state.

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

Returns:: Flag to determine whether the given combined state's Supplementary Geometry is controlled by layers or combined state

IsDefault

boolean IsDefault ()

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

Returns:

IsPublished

boolean IsPublished ()

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

Returns:

SetStateOfAnnotations

void SetStateOfAnnotations (boolean State)

Change Annotations state at combined state.

Exceptions thrown (but not limited to):

XToolkitBadContext - The operation can't be done. (Model should be top)

XToolkitNoChange - Combined state's current annotations states is same as the requested state.

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

Parameters:

State: Flag to set the given combined state's Annotations state.

Returns:

SetStateOfSupplGeometry

void SetStateOfSupplGeometry (boolean State)

Change Supplementary Geometry state at combined state.

Exceptions thrown (but not limited to):

XToolkitBadContext - The operation can't be done. (Model should be top)

XToolkitNoChange - Combined state's current supplementary geometry states is same as the requested state.

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

Parameters:

State: Flag to set the given combined state's Supplementary Geometry state.

Returns: