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:
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.pfcModelItem.ModelItemOwner :
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 :
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 Summary
void | AddAnnotationPlaneToGallery (String AnnotPlaneName) |
Add annotation plane with specified name to gallery. | |
boolean | |
Determines if Cross Section can be created as feature in specified model | |
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. | |
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 | |
Convert all legacy cross sections to features | |
void | |
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") | |
Creates new Gtol with specified placement and value string | |
LICENSE: 222 Create a new datum feature symbol annotation. | |
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. | |
CreateUnitByExpression (String UnitName, String UnitExpression) | |
Creates a derived unit. | |
void | DesignateSymbol (String SymbolName) |
void | |
Execute the layer rules on the CurrentModel if rules are enabled. | |
/*optional*/ Selections | |
Generates selections based on instructions and rules insided the specified collection object | |
Get last used Annotation plane in the specified model. | |
/*optional*/ AnnotationPlane | GetAnnotationPlaneByName (String AnnotPlaneName) |
Get Annotation plane from specified name. | |
/*optional*/ stringseq | |
Collect the names of all the named annotation planes in the model. | |
/*optional*/ stringseq | |
Collect the names of all annotation planes in gallery. | |
String | |
Returns the next available default name for given object type. | |
Initializes the layer item structure. | |
Creates a filetype descriptor from the model and returns it. | |
GetSubType () | |
Returns the subtype of a model. | |
GetTIMInfo () | |
Gets the TIM related information of the model | |
boolean | IsDesignatedSymbol (String SymbolName) |
boolean | |
Returns true if the model was loaded from a local folder. | |
boolean | |
Identifies if a model pointer is from an inheritance feature or flexible component. | |
ListLayers () | |
Collects an array containing the layers in the model. | |
void | |
Mark the ATB model/feature as out of date. | |
void | MarkForSaving (String marker) |
boolean | |
Compare the rules of a layer LayerName in ReferenceModel to the rules in layer LayerName in CurrentModel. | |
void | |
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 | |
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 | |
Update the ATB model(s)/feature(s). | |
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. | |
Method Detail
VerifyATB | ||
VerifyATB |
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.
User Guide References:
Parameters:
FeatIds
SearchPaths
Returns:
ATB verification results object
MarkATBModelAsOutOfDate | ||
void | MarkATBModelAsOutOfDate |
Mark the ATB model/feature as out of date.
Exceptions thrown (but not limited to):
XToolkitUnsupported - The input model is Multi-CAD model.
User Guide References:
Parameters:
FeatIds
Returns:
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.
User Guide References:
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.
User Guide References:
Parameters:
MasterModelPath
FeatId
Returns:
GetAnnotationPlanesFromGallery | ||
/*optional*/ stringseq | GetAnnotationPlanesFromGallery | () |
Collect the names of all annotation planes in gallery.
User Guide References:
Returns:
Names of annotation planes in the gallery
GetAnnotationPlanes | ||
/*optional*/ stringseq | GetAnnotationPlanes | () |
Collect the names of all the named annotation planes in the model.
User Guide References:
Returns:
Names of annotation planes in the model
GetAnnotationPlaneByName | ||
/*optional*/ AnnotationPlane | GetAnnotationPlaneByName | (String AnnotPlaneName) |
Get Annotation plane from specified name.
User Guide References:
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.
User Guide References:
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.
User Guide References:
Parameters:
AnnotPlaneName
Name of the valid annotation plane
Returns:
GetActiveAnnotationPlane | ||
GetActiveAnnotationPlane | () |
Get last used Annotation plane in the specified model.
User Guide References:
Returns:
Returns wfcAnnotationPlane_ptr
GetTIMInfo | ||
GetTIMInfo | () |
Gets the TIM related information of the model
User Guide References:
Returns:
The TIM information object
ConvertOldXSectionsToNew | ||
void | ConvertOldXSectionsToNew | () |
Convert all legacy cross sections to features
User Guide References:
Returns:
CanCreateSectionFeature | ||
boolean | CanCreateSectionFeature | () |
Determines if Cross Section can be created as feature in specified model
User Guide References:
Returns:
true if Cross Section can be created as feature in specified model
ListLayers | ||
ListLayers | () |
Collects an array containing the layers in the model.
Exceptions thrown (but not limited to):
XToolkitNotFound - No layers were found and collected.
User Guide References:
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.
User Guide References:
Returns:
Initializes the layer item structure.
Exceptions thrown (but not limited to):
XToolkitNotExist - Item with such identifier and type does not exist.
User Guide References:
Parameters:
LayerType
LayerId
Returns:
GetSubType | ||
GetSubType | () |
Returns the subtype of a model.
Exceptions thrown (but not limited to):
XToolkitBadContext - The model has no subtype.
User Guide References:
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.
User Guide References:
Returns:
The default Name.
IsVariantFeatModel | ||
boolean | IsVariantFeatModel | () |
Identifies if a model pointer is from an inheritance feature or flexible component.
User Guide References:
Returns:
xtrue if model pointer is inheritance feature otherwise false.
CreateUnitByExpression | ||
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.
User Guide References:
Parameters:
UnitName
The unit name.
UnitExpression
The unit expression.
Returns:
ComputeRayIntersections | ||
ComputeRayIntersections |
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.
User Guide References:
Parameters:
ApertureRadius
The value of aperture_radius.
Ray
The starting point of the ray.
Returns:
CollectParamTablesets | ||
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 |
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.
User Guide References:
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 | ||
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.
User Guide References:
Returns:
DesignateSymbol | ||
void | DesignateSymbol | (String SymbolName) |
Exceptions thrown (but not limited to):
XToolkitNoChange - The symbol is already designated.
User Guide References:
Parameters:
SymbolName
Returns:
UndesignateSymbol | ||
void | UndesignateSymbol | (String SymbolName) |
Exceptions thrown (but not limited to):
XToolkitNoChange - The symbol is not currently designated.
User Guide References:
Parameters:
SymbolName
Returns:
IsDesignatedSymbol | ||
boolean | IsDesignatedSymbol | (String SymbolName) |
User Guide References:
Parameters:
SymbolName
Returns:
VisitItems | ||
VisitItems |
Exceptions thrown (but not limited to):
XToolkitNotFound - Either no supported items exist, or they were all filtered out by the filter function.
User Guide References:
Parameters:
visitingClient
itemType
Returns:
VisitDetailItems | ||
VisitDetailItems |
Exceptions thrown (but not limited to):
XToolkitNotFound - Either no supported items exist, or they were all filtered out by the filter function.
User Guide References:
Parameters:
visitingClient
detailType
Sheet
Returns:
CreateSurfaceFinish | ||
CreateSurfaceFinish |
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
User Guide References:
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 | ||
CreateGTol |
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 | ||
CreateSetDatumTag |
Create a new datum feature symbol annotation.
User Guide References:
Parameters:
Selection
Label
Plane
Returns:
Returns wfcSetDatumTag_ptr
MatchLayerRules | ||
boolean | MatchLayerRules |
Compare the rules of a layer LayerName in ReferenceModel to the rules in layer LayerName in CurrentModel.
User Guide References:
Parameters:
LayerName
Layer Name
RefModel
Reference Model with which rule will be matched
Returns:
return description
CopyLayerRules | ||
void | CopyLayerRules |
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")
User Guide References:
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.
User Guide References:
Returns: