CIP JAVA documentation for class "com.ptc.wfc.wfcModel.WModel"

Interface WModel

package com.ptc.wfc.wfcModel; public interface WModel extends com.ptc.wfc.wfcModelItem.WParameterOwner, com.ptc.wfc.wfcModelItem.WRelationOwner, com.ptc.pfc.pfcModel.Model

Description

Adds more functionality to Model.

Direct Known Subclasses:: WDiagram, WMFG, WMarkup, WModel2D, Section, WDrawingFormat, WSolid

Method Summary
`void`	`AddAnnotationPlaneToGallery (String AnnotPlaneName)` Add annotation plane with specified name to gallery.
`boolean`	`CanCreateSectionFeature ()` Determines if Cross Section can be created as feature in specified model
`ParamTablesets`	`CollectParamTablesets ()` Obtains all table sets that are available for use in the given model. This includes all sets that are loaded from files setup in this session, and any sets that were previously stored in the model.
`Selections`	`ComputeRayIntersections (double ApertureRadius, Ray Ray)` Returns a list of ray intersections with a model. The function computes the intersection points of both the original ray and its "negative" with the geometry of the model. The output array is sorted in order of increasing signed distance.
`void`	`ConvertOldXSectionsToNew ()` Convert all legacy cross sections to features
`void`	`CopyLayerRules (String LayerName, Model RefModel)` Copy the rules of a layer LayerName in ReferenceModel into a layer LayerName in CurrentModel, overwriting any rules <p><b>Note: </b>This function copies both the rules definitions and the rules options set interactively (including option "Associative")
`GTol`	`CreateGTol (GTolType Type, GTolAttach GtolAttach, String Value)` Creates new Gtol with specified placement and value string
`SetDatumTag`	`CreateSetDatumTag (Selection Selection, String Label, /optional/ AnnotationPlane Plane)` `LICENSE: 222` Create a new datum feature symbol annotation.
`SurfaceFinish`	`CreateSurfaceFinish (DetailSymbolInstInstructions SymbolInstructions, AnnotationPlane AnnotPlane)` `LICENSE: 222` Create a surface finish in the specified model. wfcSurfaceFinish::Show() should be called after creating the surface finish in order for the surface finish to be displayed.
`Unit`	`CreateUnitByExpression (String UnitName, String UnitExpression)` Creates a derived unit.
`void`	`DesignateSymbol (String SymbolName)`
`void`	`ExecuteLayerRules ()` Execute the layer rules on the CurrentModel if rules are enabled.
`/optional/ Selections`	`GenerateSelectionsFromCollection (Collection Collection)` Generates selections based on instructions and rules insided the specified collection object
`AnnotationPlane`	`GetActiveAnnotationPlane ()` Get last used Annotation plane in the specified model.
`/optional/ AnnotationPlane`	`GetAnnotationPlaneByName (String AnnotPlaneName)` Get Annotation plane from specified name.
`/optional/ stringseq`	`GetAnnotationPlanes ()` Collect the names of all the named annotation planes in the model.
`/optional/ stringseq`	`GetAnnotationPlanesFromGallery ()` Collect the names of all annotation planes in gallery.
`String`	`GetDefaultName ()` Returns the next available default name for given object type.
`LayerItem`	`GetLayerItem (LayerType LayerType, int LayerId)` Initializes the layer item structure.
`MdlfileDescriptor`	`GetMdlfileDescriptor ()` Creates a filetype descriptor from the model and returns it.
`ModelSubType`	`GetSubType ()` Returns the subtype of a model.
`TIMInfo`	`GetTIMInfo ()` Gets the TIM related information of the model
`boolean`	`IsDesignatedSymbol (String SymbolName)`
`boolean`	`IsStandardLocation ()` Returns true if the model was loaded from a local folder.
`boolean`	`IsVariantFeatModel ()` Identifies if a model pointer is from an inheritance feature or flexible component.
`Layers`	`ListLayers ()` Collects an array containing the layers in the model.
`void`	`MarkATBModelAsOutOfDate ( /optional/ intseq FeatIds)` Mark the ATB model/feature as out of date.
`void`	`MarkForSaving (String marker)`
`boolean`	`MatchLayerRules (String LayerName, Model RefModel)` Compare the rules of a layer LayerName in ReferenceModel to the rules in layer LayerName in CurrentModel.
`void`	`RefreshMdlTree ()` Refreshes the display of the model tree.
`void`	`RelinkATB (String MasterModelPath, /optional/ Integer FeatId)` Relink the model/feature that have lost the link to the master model. Relinking a model here will represent searching for the master model (using the master model name) in the location specified in the 'MasterModelPath' argument. If the master model with the same name is found, the Creo Parametric TIM model is linked to that master model.
`void`	`RemoveAnnotationPlaneFromGallery (String AnnotPlaneName)` Remove annotation plane with specified name from gallery.
`void`	`SaveLayerDisplayStatus ()` Permanently saves all the changes to the display status of all layers in the owner, and all its submodels (and views, for drawings).
`void`	`UndesignateSymbol (String SymbolName)`
`void`	`UpdateATB ( /optional/ intseq FeatIds, /optional/ stringseq SearchPaths)` Update the ATB model(s)/feature(s).
`ATBVerificationResults`	`VerifyATB ( /optional/ intseq FeatIds, /optional/ stringseq SearchPaths)` To Verify if the ATB models are out of date. This function will first check to see if the model specified is a TIM (of some master model). If model is not a TIM, it will check to see if the model contains one or more features which are TIM representations.
`Status`	`VisitDetailItems (VisitingClient visitingClient, DetailType detailType, int Sheet)`
`Status`	`VisitItems (VisitingClient visitingClient, ModelItemType itemType)`

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.pfcModelItem.ModelItemOwner`
`GetItemByName`, `GetItemById`, `ListItems`

Methods Inherited from Interface `com.ptc.pfc.pfcView.ViewOwner`
`RetrieveView`, `GetView`, `SaveView`, `GetCurrentViewTransform`, `SetCurrentViewTransform`, `CurrentViewRotate`, `ListViews`, `GetCurrentView`

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

Methods Inherited from Interface `com.ptc.pfc.pfcModel.Model`
`GetDescr`, `GetRelationId`, `GetIsModified`, `GetVersionStamp`, `GetRevision`, `GetVersion`, `GetBranch`, `GetReleaseLevel`, `GetCommonName`, `SetCommonName`, `IsCommonNameModifiable`, `GetFullName`, `GetInstanceName`, `GetGenericName`, `GetType`, `GetFileName`, `Backup`, `Copy`, `CopyAndRetrieve`, `Rename`, `Save`, `Erase`, `EraseWithDependencies`, `Delete`, `Display`, `DisplayInNewWindow`, `ListDependencies`, `ListDeclaredModels`, `CreateLayer`, `Export`, `Import`, `AccessExternalData`, `TerminateExternalData`, `CheckIsSaveAllowed`, `CheckIsModifiable`, `GetOrigin`, `GetPostRegenerationRelations`, `SetPostRegenerationRelations`, `RegeneratePostRegenerationRelations`, `DeletePostRegenerationRelations`, `CleanupDependencies`, `IsNativeModel`, `ExportIntf3D`, `SetIntf3DLayerSetupFile`, `IsIntf3DLayerSetupFileIgnored`, `IsIntf3DCsysIgnored`, `ClearIntf3DModelData`

Methods Inherited from Interface com.ptc.pfc.pfcModel.Model

GetDescr, GetRelationId, GetIsModified, GetVersionStamp, GetRevision, GetVersion, GetBranch, GetReleaseLevel, GetCommonName, SetCommonName, IsCommonNameModifiable, GetFullName, GetInstanceName, GetGenericName, GetType, GetFileName, Backup, Copy, CopyAndRetrieve, Rename, Save, Erase, EraseWithDependencies, Delete, Display, DisplayInNewWindow, ListDependencies, ListDeclaredModels, CreateLayer, Export, Import, AccessExternalData, TerminateExternalData, CheckIsSaveAllowed, CheckIsModifiable, GetOrigin, GetPostRegenerationRelations, SetPostRegenerationRelations, RegeneratePostRegenerationRelations, DeletePostRegenerationRelations, CleanupDependencies, IsNativeModel, ExportIntf3D, SetIntf3DLayerSetupFile, IsIntf3DLayerSetupFileIgnored, IsIntf3DCsysIgnored, ClearIntf3DModelData

Method Detail

VerifyATB

ATBVerificationResults VerifyATB ( /*optional*/ intseq FeatIds, /*optional*/ stringseq SearchPaths)

To Verify if the ATB models are out of date. This function will first check to see if the model specified is a TIM (of some master model). If model is not a TIM, it will check to see if the model contains one or more features which are TIM representations.

Exceptions thrown (but not limited to):

XToolkitNoChange - The function successfully verified the model and didn't find any ATB models out of date nor any models of old version nor any models with broken link.

XToolkitNotValid - The function successfully verified the model, found ONE or more models of older version and found no ATB models out of date.

XToolkitBadContext - The function successfully verified the model, found ONE or more models with broken link and found no ATB models out of date and no ATB models of older version

XToolkitUnsupported - The input model is Multi-CAD model.

Manual References:: Interface: Associative Topology Bus Enabled Models and Features, Interface: Associative Topology Bus Enabled Models and Features

Parameters:

FeatIds
SearchPaths

Returns:: ATB verification results object

MarkATBModelAsOutOfDate

void MarkATBModelAsOutOfDate ( /*optional*/ intseq FeatIds)

Mark the ATB model/feature as out of date.

Exceptions thrown (but not limited to):

XToolkitUnsupported - The input model is Multi-CAD model.

Manual References:: Interface: Associative Topology Bus Enabled Models and Features, Interface: Associative Topology Bus Enabled Models and Features

Parameters:

FeatIds

Returns:

UpdateATB

void UpdateATB ( /*optional*/ intseq FeatIds, /*optional*/ stringseq SearchPaths)

Update the ATB model(s)/feature(s).

Exceptions thrown (but not limited to):

XToolkitNoChange - The function runs successfully and found no ATB models out of date.

XToolkitCantModify - During ATB update the regeneration failed.

XToolkitBadContext - There are non-displayed models in the session.

XToolkitNotDisplayed - The input model is not displayed.

XToolkitAmbiguous - Both: there are non-displayed models in the session AND the input model is not displayed.

XToolkitUnsupported - The input model is Multi-CAD model.

Manual References:: Interface: Associative Topology Bus Enabled Models and Features, Interface: Associative Topology Bus Enabled Models and Features

Parameters:

FeatIds
SearchPaths

Returns:

RelinkATB

void RelinkATB (String MasterModelPath, /*optional*/ Integer FeatId)

Relink the model/feature that have lost the link to the master model. Relinking a model here will represent searching for the master model (using the master model name) in the location specified in the 'MasterModelPath' argument. If the master model with the same name is found, the Creo Parametric TIM model is linked to that master model.

Exceptions thrown (but not limited to):

XToolkitUnsupported - The input model is Multi-CAD model.

Manual References:: Interface: Associative Topology Bus Enabled Models and Features

Parameters:

MasterModelPath
FeatId

Returns:

GetAnnotationPlanesFromGallery

/*optional*/ stringseq GetAnnotationPlanesFromGallery ()

Collect the names of all annotation planes in gallery.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Orientation, Annotations: Annotation Features and Annotations: Annotation Orientation

Returns:: Names of annotation planes in the gallery

GetAnnotationPlanes

/*optional*/ stringseq GetAnnotationPlanes ()

Collect the names of all the named annotation planes in the model.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Orientation, Annotations: Annotation Features and Annotations: Annotation Orientation

Returns:: Names of annotation planes in the model

GetAnnotationPlaneByName

/*optional*/ AnnotationPlane GetAnnotationPlaneByName (String AnnotPlaneName)

Get Annotation plane from specified name.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Orientation, Annotations: Annotation Features and Annotations: Annotation Orientation

Parameters:

AnnotPlaneName: Name of wanted Annotation Plane

Returns:: Annotation plane with specified name.

AddAnnotationPlaneToGallery

void AddAnnotationPlaneToGallery (String AnnotPlaneName)

Add annotation plane with specified name to gallery.

Exceptions thrown (but not limited to):

<reference 6 to unknown entity pfcExceptions::pfcXToolkitNotFound> - No annotation plane exists with specified name.

<reference 6 to unknown entity pfcExceptions::pfcXToolkitFound> - Annotation plane with same name already exist in the gallery.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Orientation, Annotations: Annotation Features and Annotations: Annotation Orientation

Parameters:

AnnotPlaneName: Name of the valid annotation plane

Returns:

RemoveAnnotationPlaneFromGallery

void RemoveAnnotationPlaneFromGallery (String AnnotPlaneName)

Remove annotation plane with specified name from gallery.

Exceptions thrown (but not limited to):

<reference 6 to unknown entity pfcExceptions::pfcXToolkitNotFound> - No annotation plane exists with specified name.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Orientation, Annotations: Annotation Features and Annotations: Annotation Orientation

Parameters:

AnnotPlaneName: Name of the valid annotation plane

Returns:

GetActiveAnnotationPlane

AnnotationPlane GetActiveAnnotationPlane ()

Get last used Annotation plane in the specified model.

Manual References:: Annotations: Annotation Features and Annotations: Annotation Orientation

Returns:: Returns wfcAnnotationPlane_ptr

GetTIMInfo

TIMInfo GetTIMInfo ()

Gets the TIM related information of the model

Manual References:: Interface: Associative Topology Bus Enabled Models and Features, Interface: Associative Topology Bus Enabled Models and Features

Returns:: The TIM information object

ConvertOldXSectionsToNew

void ConvertOldXSectionsToNew ()

Convert all legacy cross sections to features

Manual References:: Cross Sections: Creating and Modifying Cross Sections, Cross Sections: Creating and Modifying Cross Sections

Returns:

CanCreateSectionFeature

boolean CanCreateSectionFeature ()

Determines if Cross Section can be created as feature in specified model

Manual References:: Cross Sections: Creating and Modifying Cross Sections, Cross Sections: Creating and Modifying Cross Sections

Returns:: true if Cross Section can be created as feature in specified model

ListLayers

Layers ListLayers ()

Collects an array containing the layers in the model.

Exceptions thrown (but not limited to):

XToolkitNotFound - No layers were found and collected.

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

Returns:

SaveLayerDisplayStatus

void SaveLayerDisplayStatus ()

Permanently saves all the changes to the display status of all layers in the owner, and all its submodels (and views, for drawings).

Exceptions thrown (but not limited to):

XToolkitNoChange - No layers have been changed since the last save.

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

Returns:

GetLayerItem

LayerItem GetLayerItem (LayerType LayerType, int LayerId)

Initializes the layer item structure.

Exceptions thrown (but not limited to):

XToolkitNotExist - Item with such identifier and type does not exist.

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

Parameters:

LayerType
LayerId

Returns:

GetSubType

ModelSubType GetSubType ()

Returns the subtype of a model.

Exceptions thrown (but not limited to):

XToolkitBadContext - The model has no subtype.

Manual References:: Models: Model Information

Returns:: subtype of the model

GetDefaultName

String GetDefaultName ()

Returns the next available default name for given object type.

Exceptions thrown (but not limited to):

XToolkitUnsupported - the type is not supported.

Manual References:: Models: Model Information, Models: Model Information

Returns:: The default Name.

IsVariantFeatModel

boolean IsVariantFeatModel ()

Identifies if a model pointer is from an inheritance feature or flexible component.

Manual References:: Assemblies and Components: Variant Feature Model

Returns:: xtrue if model pointer is inheritance feature otherwise false.

CreateUnitByExpression

Unit CreateUnitByExpression (String UnitName, String UnitExpression)

Creates a derived unit.

Exceptions thrown (but not limited to):

XToolkitNotFound - The reference unit was not found in the model.

Manual References:: Solid: Accessing Individual Units, Solid: Accessing Individual Units

Parameters:

UnitName: The unit name.
UnitExpression: The unit expression.

Returns:

ComputeRayIntersections

Selections ComputeRayIntersections (double ApertureRadius, Ray Ray)

Returns a list of ray intersections with a model. The function computes the intersection points of both the original ray and its "negative" with the geometry of the model. The output array is sorted in order of increasing signed distance.

Exceptions thrown (but not limited to):

XToolkitNotFound - No objects were found in the workspace.

Manual References:: Geometry Evaluation: Tracing a Ray, Geometry Evaluation: Tracing a Ray

Parameters:

ApertureRadius: The value of aperture_radius.
Ray: The starting point of the ray.

Returns:

CollectParamTablesets

ParamTablesets CollectParamTablesets ()

Obtains all table sets that are available for use in the given model. This includes all sets that are loaded from files setup in this session, and any sets that were previously stored in the model.

Exceptions thrown (but not limited to):

XToolkitNotFound - No parameter table sets are available for this model.

Returns:: The wfcModelItem::ParamTablesets object

GenerateSelectionsFromCollection

/*optional*/ Selections GenerateSelectionsFromCollection (Collection Collection)

Generates selections based on instructions and rules insided the specified collection object

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - There was a memory error.

XToolkitAmbiguous - The curve collection chain cannot be regenerated because there is an ambiguity which could not be resolved.

XToolkitNotFound - The curve collection chain cannot be regenerated because a reference could not be found while collecting edges/curves/points.

XToolkitNotValid - The checking of the curve collection failed.

Manual References:: Curve and Surface Collection: The wfcCollection Interface

Parameters:

Collection

Returns:: A sequence of selection objects

MarkForSaving

void MarkForSaving (String marker)

Exceptions thrown (but not limited to):

XExternalDataTKError - The function failed.

XExternalDataInvalidObject - The specified model or class name is invalid.

XExternalDataClassOrSlotExists - The specified class name already exists.

XExternalDataNamesTooLong - The specified class name exceeds the length 32 Chars.

Parameters:

marker

Returns:

RefreshMdlTree

void RefreshMdlTree ()

Refreshes the display of the model tree.

Exceptions thrown (but not limited to):

XToolkitNotFound - The model tree is not present.

Returns:

GetMdlfileDescriptor

MdlfileDescriptor GetMdlfileDescriptor ()

Creates a filetype descriptor from the model and returns it.

The created descriptor has no information about the initial descriptor used to create this model. It contains the model name stripped of its extension, version and location.

Exceptions thrown (but not limited to):

XToolkitInvalidPtr - the model argument does not represent a correct model.

Returns:

IsStandardLocation

boolean IsStandardLocation ()

Returns true if the model was loaded from a local folder.

Exceptions thrown (but not limited to):

XBadArgument - the model is null.

Manual References:: Models: Model Operations

Returns:

DesignateSymbol

void DesignateSymbol (String SymbolName)

Exceptions thrown (but not limited to):

XToolkitNoChange - The symbol is already designated.

Manual References:: Annotations: Annotation Features and Annotations: Designating Dimensions and Symbols, Annotations: Annotation Features and Annotations: Designating Dimensions and Symbols

Parameters:

SymbolName

Returns:

UndesignateSymbol

void UndesignateSymbol (String SymbolName)

Exceptions thrown (but not limited to):

XToolkitNoChange - The symbol is not currently designated.

Manual References:: Annotations: Annotation Features and Annotations: Designating Dimensions and Symbols

Parameters:

SymbolName

Returns:

IsDesignatedSymbol

boolean IsDesignatedSymbol (String SymbolName)

Manual References:: Annotations: Annotation Features and Annotations: Designating Dimensions and Symbols, Annotations: Annotation Features and Annotations: Designating Dimensions and Symbols

Parameters:

SymbolName

Returns:

VisitItems

Status VisitItems (VisitingClient visitingClient, ModelItemType itemType)

Exceptions thrown (but not limited to):

XToolkitNotFound - Either no supported items exist, or they were all filtered out by the filter function.

Manual References:: Overview of Creo Object TOOLKIT Java: Visit Methods, Overview of Creo Object TOOLKIT Java: Visit Methods

Parameters:

visitingClient
itemType

Returns:

VisitDetailItems

Status VisitDetailItems (VisitingClient visitingClient, DetailType detailType, int Sheet)

Exceptions thrown (but not limited to):

XToolkitNotFound - Either no supported items exist, or they were all filtered out by the filter function.

Manual References:: Overview of Creo Object TOOLKIT Java: Visit Methods

Parameters:

visitingClient
detailType
Sheet

Returns:

CreateSurfaceFinish

SurfaceFinish CreateSurfaceFinish (DetailSymbolInstInstructions SymbolInstructions, AnnotationPlane AnnotPlane)

LICENSE: 222

Create a surface finish in the specified model. wfcSurfaceFinish::Show() should be called after creating the surface finish in order for the surface finish to be displayed.

Exceptions thrown (but not limited to):

XToolkitInvalidType - Invalid type of leader or attachment for creation of a surface finish.

XToolkitFound - Leader or attachment to surface which already has a surface finish.

XToolkitNoLicense - License check failure

Manual References:: Annotations: Annotation Features and Annotations: Surface Finish Annotations

Parameters:

SymbolInstructions

The symbol instance instructions. This data must contain:

Zero or more leaders pointing to model surfaces, or, a model surface used for the attachment point.

An annotation plane (for solid owned surface finishes).

Optionally, variant texts for the surface finish.

Consult the Creo Parametric TOOLKIT user's guide for information about how to find the standard surface finish symbols in order to use them during creation.

AnnotPlane

Returns:: The created surface finish.

CreateGTol

GTol CreateGTol (GTolType Type, GTolAttach GtolAttach, String Value)

Creates new Gtol with specified placement and value string

Parameters:

Type: Type of GTol to create
GtolAttach: The GTol Attachment
Value: The GTol value text

Returns:: The Created GTol

CreateSetDatumTag

SetDatumTag CreateSetDatumTag (Selection Selection, String Label, /*optional*/ AnnotationPlane Plane)

LICENSE: 222

Create a new datum feature symbol annotation.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Set Datum Tags, Annotations: Annotation Features and Annotations: Accessing Set Datum Tags

Parameters:

Selection
Label
Plane

Returns:: Returns wfcSetDatumTag_ptr

MatchLayerRules

boolean MatchLayerRules (String LayerName, Model RefModel)

Compare the rules of a layer LayerName in ReferenceModel to the rules in layer LayerName in CurrentModel.

Manual References:: ModelItem: Layer Operations

Parameters:

LayerName: Layer Name
RefModel: Reference Model with which rule will be matched

Returns:: return description

CopyLayerRules

void CopyLayerRules (String LayerName, Model RefModel)

Copy the rules of a layer LayerName in ReferenceModel into a layer LayerName in CurrentModel, overwriting any rules <p><b>Note: </b>This function copies both the rules definitions and the rules options set interactively (including option "Associative")

Manual References:: ModelItem: Layer Operations, ModelItem: Layer Operations

Parameters:

LayerName: Layer Name
RefModel: Reference Model from which rule will be copied

Returns:

ExecuteLayerRules

void ExecuteLayerRules ()

Execute the layer rules on the CurrentModel if rules are enabled.

Manual References:: ModelItem: Layer Operations, ModelItem: Layer Operations

Returns: