Interface CombState
package com.ptc.wfc.wfcCombState;
public interface CombState
extends com.ptc.wfc.wfcModelItem.WModelItem
Description
>Represent Combined State in solid
User Guide References:
Solid Operations:CombState, Combined States of a Solid:CombState, Extracting Information About Simplified Representations:CombState, Modifying Simplified Representations:CombState, Adding Items to and Deleting Items from a Simplified Representation:CombState
Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WParameterOwner :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.RelationOwner :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WRelationOwner :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Child :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ModelItem :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WModelItem :
Method Summary
void | |
void | |
void | |
/*optional*/ CombStateAnnotations | |
Gets Combined State data in the combined state | |
/*optional*/ CombStateItems | GetItems () |
boolean | |
boolean | |
Checks if Supplementary Geometry is controlled by layers or specified combined state. | |
boolean | IsDefault () |
boolean | IsPublished () |
void | |
Redefines combined state | |
/*optional*/ intseq | |
/*optional*/ intseq | |
void | SetStateOfAnnotations (boolean State) |
Change Annotations state at combined state. | |
void | SetStateOfSupplGeometry (boolean State) |
Change Supplementary Geometry state at combined state. |
Method Detail
GetCombStateData | ||
GetCombStateData | () |
Gets Combined State data in the combined state
Exceptions thrown (but not limited to):
XToolkitNotFound - No such combined state in the specified model.
User Guide References:
Returns:
CombStateData
RedefineCombState | ||
void | RedefineCombState |
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.
User Guide References:
Parameters:
Data
Combined State data
Returns:
AddAnnotations | ||
void | AddAnnotations |
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.
User Guide References:
Parameters:
Annotations
Returns:
AddItems | ||
void | AddItems |
User Guide References:
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.
User Guide References:
Returns:
GetItems | ||
/*optional*/ CombStateItems | GetItems | () |
User Guide References:
Returns:
RemoveAnnotations | ||
/*optional*/ intseq | RemoveAnnotations |
Exceptions thrown (but not limited to):
XToolkitNotFound - This legacy combined state doesn't have annotation state. Annotations cannot be Removed.
User Guide References:
Parameters:
Annotations
Returns:
RemoveItems | ||
/*optional*/ intseq | RemoveItems |
User Guide References:
Parameters:
Items
Returns:
EraseAnnotation | ||
void | EraseAnnotation |
Exceptions thrown (but not limited to):
XToolkitNoChange - The annotation is not shown in the target model.
XToolkitNoLicense - License check failure.
User Guide References:
Parameters:
Annot
Returns:
GetStateOfAnnotations | ||
boolean | GetStateOfAnnotations | () |
User Guide References:
Returns:
GetStateOfSupplGeometry | ||
boolean | GetStateOfSupplGeometry | () |
Checks if Supplementary Geometry is controlled by layers or specified combined state.
User Guide References:
Returns:
Flag to determine whether the given combined state's Supplementary Geometry is controlled by layers or combined state
IsDefault | ||
boolean | IsDefault | () |
User Guide References:
Returns:
IsPublished | ||
boolean | IsPublished | () |
User Guide References:
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.
User Guide References:
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.
User Guide References:
Parameters:
State
Flag to set the given combined state's Supplementary Geometry state.
Returns: