CIP C++ documentation for class "pfcModel"

Class pfcModel

# include <pfcModel.h> class pfcModel : public virtual pfcModelItemOwner, : public virtual pfcViewOwner, : public virtual pfcChild, : public virtual pfcActionSource, : public virtual pfcRelationOwner, : public virtual pfcParameterOwner { xaideclare(pfcModel) ... };

Description

This class specifies the information about a model which is currently in session.

Attributes Revision, Version, Branch and ReleaseLevel are used for data management applications. Attributes FullName, GenericName, InstanceName and Type have the same values as the corresponding attributes of the model descriptor Descr.

See Also:: pfcSolid, pfcModel2D, pfcBaseSession::ListModels(), pfcBaseSession::RetrieveModel(pfcModelDescriptor_ptr), pfcBaseSession::GetModel(xrstring, pfcModelType), pfcBaseSession::GetModelFromDescr(pfcModelDescriptor_ptr), pfcBaseSession::GetByRelationId(xint), pfcBaseSession::CreateModelWindow(pfcModel_ptr), pfcBaseSession::ImportNewModel(xrstring, pfcNewModelImportType, pfcModelType, xrstring, optional pfcLayerImportFilter_ptr)

Manual References:: Overview of Creo Object TOOLKIT C++: Utilities

Direct Known Subclasses:: pfcSolid, pfcDrawingFormat, pfcModel2D, pfcMFG, pfcSection2D, pfcDiagram, pfcMarkup, wfcWModel

Method Summary


`pfcExternalDataAccess_ptr`	`AccessExternalData ()`
	This method is enabled for Creo Direct. Initializes External Data access

`void`	`Backup (pfcModelDescriptor_ptr WhereTo)`
	This method is enabled for Creo Direct. Backs up the model to a specified directory.

`xbool`	`CheckIsModifiable (xbool ShowUI)`
	This method is enabled for Creo Direct. Check if given model is modifiable, indicating that the model could be saved (without checking for any subordinate models).

`xbool`	`CheckIsSaveAllowed (xbool ShowUI)`
	This method is enabled for Creo Direct. Check if given model can be saved along with all its subordinate models that are to be saved together with it according to their modification status and the configuration option 'save_objects'.

`void`	`CleanupDependencies ()`
	This method is enabled for Creo Direct. Forces cleaning up dependencies database of an object in the Creo Parametric workspace. This function should not be called during reference altering operations like feature create, edit definition or restructure.

`void`	`Copy (xrstring NewName, optional pfcCopyInstructions_ptr Instructions)`
	This method is enabled for Creo Direct. Copies the disk file for the model to another named file. The model copy is not retrieved into the session.

`pfcModel_ptr`	`CopyAndRetrieve (xrstring NewName, optional pfcCopyInstructions_ptr Instructions)`
	This method is enabled for Creo Direct. Copies the model to a new one, and retrieves the new model into memory.

`pfcLayer_ptr`	`CreateLayer (xrstring Name)`
	Creates a new layer in the object.

`void`	`Delete ()`
	This method is enabled for Creo Direct. Deletes the model from memory and disk.

`void`	`DeletePostRegenerationRelations ()`
	Deletes the post-regeneration relations in the model.

`void`	`Display ()`
	Displays the model in its window.

`void`	`Erase ()`
	This method is enabled for Creo Direct. Erases the model from the session. This method does not delete the model file from the disk.

`void`	`EraseWithDependencies ()`
	This method is enabled for Creo Direct. Erases the model and its dependencies from the session.

`void`	`Export (xrstring FileName, pfcExportInstructions_ptr ExportData)`
	This method is enabled for Creo Direct. Exports model data to a file or creates a plot. NOTE: In future, interface `pfcExport3DInstructions` will be deprecated. Use superseding method `<reference 4 to unknown entity pfcModel::ExportIntf3D>` to export these type of objects.

`void`	`ExportIntf3D (xrstring NewFileName, pfcExportType ExpType, optional xrstring ProfileFile)`
	This method is enabled for Creo Direct. Exports a Creo Parametric model using default export profile.

`optional xstring`	`GetBranch ()`
	This method is enabled for Creo Direct. The branch. This attribute can be `null`.

`xstring`	`GetCommonName ()`
`void`	`SetCommonName (xrstring value)`
	This method is enabled for Creo Direct. The common name for the model. This is the name that will shown for the model in Windchill PDM. It can be modified for models which are not owned by PDM.

`pfcModelDescriptor_ptr`	`GetDescr ()`
	This method is enabled for Creo Direct. The model descriptor.

`xstring`	`GetFileName ()`
	This method is enabled for Creo Direct. The model file name in "name"."type" format.

`xstring`	`GetFullName ()`
	This method is enabled for Creo Direct. The full name of the model in instance<generic> format.

`optional xstring`	`GetGenericName ()`
	This method is enabled for Creo Direct. The name of the generic model. If the model is not an instance, this attribute must be `null` or an empty string.

`xstring`	`GetInstanceName ()`
	This method is enabled for Creo Direct. The name of the model, or, if the model is an instance, the instance name.

`xbool`	`GetIsModified ()`
	This method is enabled for Creo Direct. A Boolean flag that specifies whether the model has been modified since the last save.

`xstring`	`GetOrigin ()`
	This method is enabled for Creo Direct. The location of the origin of the model.

`optional xstringsequence_ptr`	`GetPostRegenerationRelations ()`
`void`	`SetPostRegenerationRelations (optional xstringsequence_ptr value)`
	The list of the post-regeneration relations assigned to the model. This attribute can be `null`.

`optional xint`	`GetRelationId ()`
	The relation identifier. This attribute can be `null`.

`optional xstring`	`GetReleaseLevel ()`
	This method is enabled for Creo Direct. The release level. This attribute can be `null`.

`optional xstring`	`GetRevision ()`
	This method is enabled for Creo Direct. The revision number. This attribute can be `null`.

`pfcModelType`	`GetType ()`
	This method is enabled for Creo Direct. The model type.

`optional xstring`	`GetVersion ()`
	This method is enabled for Creo Direct. The version. This attribute can be `null`.

`xstring`	`GetVersionStamp ()`
	This method is enabled for Creo Direct. The version stamp.

`void`	`Import (xrstring FilePath, pfcImportInstructions_ptr ImportData)`
	This method is enabled for Creo Direct. Reads a file into Creo Parametric. The format must be the same as if these files were created by Creo Parametric.

`xbool`	`IsCommonNameModifiable ()`
	This method is enabled for Creo Direct. Identifies if the model common name (`pfcModel::GetCommonName(xrstring)`) can be modified.

`xbool`	`IsNativeModel ()`
	Returns true if the origin of the model is Creo; false otherwise.

`optional pfcModelDescriptors_ptr`	`ListDeclaredModels ()`
	Finds all the first-level objects declared for the model.

`optional pfcDependencies_ptr`	`ListDependencies ()`
	Finds the first-level dependencies for the model in the Creo Parametric workspace.

`void`	`RegeneratePostRegenerationRelations ()`
	Regenerates the post-regeneration relations in the model.

`void`	`Rename (xrstring NewName, optional xbool RenameFilesToo)`
	Renames the model.

`void`	`Save ()`
	This method is enabled for Creo Direct. Writes the model to disk.

	This method is enabled for Creo Direct.



`void`	`TerminateExternalData ()`
	This method is enabled for Creo Direct. Cleans up the setup required for the generic application data operations for the specified model.

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcModelItemOwner:: GetItemByName, GetItemById, ListItems

Methods Inherited from Class pfcViewOwner:: RetrieveView, GetView, SaveView, GetCurrentViewTransform, SetCurrentViewTransform, CurrentViewRotate, ListViews, GetCurrentView

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Method Detail

pfcModelDescriptor_ptr GetDescr ()

This method is enabled for Creo Direct.

The model descriptor.

Exceptions thrown (but not limited to):

pfcXToolkitUnsupported - Unsupported model. For instance, models which come from Multi-CAD model approach, are not supported in this release.

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

optional xint GetRelationId ()

The relation identifier. This attribute can be null.

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

xbool GetIsModified ()

This method is enabled for Creo Direct.

A Boolean flag that specifies whether the model has been modified since the last save.

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

xstring GetVersionStamp ()

This method is enabled for Creo Direct.

The version stamp.

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

optional xstring GetRevision ()

This method is enabled for Creo Direct.

The revision number. This attribute can be null.

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

optional xstring GetVersion ()

This method is enabled for Creo Direct.

The version. This attribute can be null.

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

optional xstring GetBranch ()

This method is enabled for Creo Direct.

The branch. This attribute can be null.

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

optional xstring GetReleaseLevel ()

This method is enabled for Creo Direct.

The release level. This attribute can be null.

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

`xstring`	`GetCommonName`	`()`
`void`	`SetCommonName`	`(xrstring value)`

This method is enabled for Creo Direct.

The common name for the model. This is the name that will shown for the model in Windchill PDM. It can be modified for models which are not owned by PDM.

Exceptions thrown (but not limited to):

pfcXToolkitCantModify - The common name for the given model has been locked by PDM and cannot be modified.

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

xbool IsCommonNameModifiable ()

This method is enabled for Creo Direct.

Identifies if the model common name (pfcModel::GetCommonName(xrstring)) can be modified.

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

Returns:

xstring GetFullName ()

This method is enabled for Creo Direct.

The full name of the model in instance<generic> format.

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

xstring GetInstanceName ()

This method is enabled for Creo Direct.

The name of the model, or, if the model is an instance, the instance name.

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

optional xstring GetGenericName ()

This method is enabled for Creo Direct.

The name of the generic model. If the model is not an instance, this attribute must be null or an empty string.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The specified model is not an instance -- it has no generic model.

pfcXToolkitCantOpen - The immediate generic is not in session ('immediate' is set to TRUE).

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

pfcModelType GetType ()

This method is enabled for Creo Direct.

The model type.

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

xstring GetFileName ()

This method is enabled for Creo Direct.

The model file name in "name"."type" format.

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

void Backup (pfcModelDescriptor_ptr WhereTo)

This method is enabled for Creo Direct.

Backs up the model to a specified directory.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidPtr - The handle is not correct, or the name and type are invalid (for example, the object is not in memory).

pfcXToolkitInvalidType - The specified type is invalid.

pfcXToolkitCantWrite - The system could not write to the specified directory.

pfcXToolkitInvalidDir - The specified directory (path) is invalid.

pfcXToolkitNoPermission - The function does not have permission to operate on this model.

pfcXToolkitBadContext - The function is not available in Design Test Mode.

See Also:: pfcModel::Save(), pfcModel::Copy(xrstring, optional pfcCopyInstructions_ptr)

Manual References:: Models: Model Operations, Models: Model Operations

Parameters:

WhereTo: The path to the directory where the backup copy is created. (The backup has the same file name as the original.)

Returns:

void Copy (xrstring NewName, optional pfcCopyInstructions_ptr Instructions)

This method is enabled for Creo Direct.

Copies the disk file for the model to another named file. The model copy is not retrieved into the session.

Exceptions thrown (but not limited to):

pfcXToolkitNoPermission - The function does not have permission to operate on this model.

pfcXToolkitUnsupported - Unsupported model. For instance, models which come from Multi-CAD model approach, are not supported in this release.

See Also:: pfcModel::CopyAndRetrieve(xrstring, optional pfcCopyInstructions_ptr)

Manual References:: Models: Model Operations, Models: Model Operations, Geometry Evaluation: Geometry of Quilts, Annotations: Annotation Features and Annotations: Overview of Annotation Features, Annotations: Annotation Features and Annotations: Automatic Propagation of Annotation Elements, Windchill Connectivity APIs: File Copy, Session Objects: Macros, Session Objects: File Dialogs

Parameters:

NewName: The new name of the model
Instructions: Reserved for the future. Pass null.

Returns:

pfcModel_ptr CopyAndRetrieve (xrstring NewName, optional pfcCopyInstructions_ptr Instructions)

This method is enabled for Creo Direct.

Copies the model to a new one, and retrieves the new model into memory.

Exceptions thrown (but not limited to):

pfcXToolkitNoPermission - The function does not have permission to operate on this model.

pfcXToolkitUnsupported - Unsupported model. For instance, models which come from Multi-CAD model approach, are not supported in this release.

See Also:: pfcModel::Copy(xrstring, optional pfcCopyInstructions_ptr)

Manual References:: Models: Model Operations, Models: Model Operations

Parameters:

NewName: The new name of the model
Instructions: Reserved for the future. Pass null.

Returns:: The copied model

void Rename (xrstring NewName, optional xbool RenameFilesToo)

Renames the model.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The function is not available in Design Test Mode.

pfcXToolkitUnsupported - Unsupported model. For instance, models which come from Multi-CAD model approach, are not supported in this release.

Manual References:: Models: Model Operations, Models: Model Operations

Parameters:

NewName: The new name for the model.
RenameFilesToo: Ignored: by default, this is false.

Returns:

void Save ()

This method is enabled for Creo Direct.

Writes the model to disk.

Exceptions thrown (but not limited to):

pfcXToolkitCantWrite - Failed to save the model or at least one of its subordinate models due to unresolved non-overridable conflicts in the target location.

pfcXToolkitNoPermission - The function does not have permission to operate on this model.

pfcXToolkitBadContext - The function is not available in Design Test Mode.

See Also:: pfcModel::Backup(pfcModelDescriptor_ptr)

Manual References:: Models: Model Operations, Models: Model Operations, Windchill Connectivity APIs: Save, Windchill Connectivity APIs: Upload, Windchill Connectivity APIs: CheckIn

Returns:

void Erase ()

This method is enabled for Creo Direct.

Erases the model from the session. This method does not delete the model file from the disk.

If the model is displayed in a window, the model is marked to be erased when control returns the Creo Parametric UI from the application. It is not erased immediately.

Models used by other models cannot be erased until the models dependent upon them are erased. pfcModel::Model::EraseWithDependencies

pfcSession::BaseSession::EraseUndisplayedModels

Exceptions thrown (but not limited to):

pfcXToolkitDeadLock - The Creo Parametric user interface is not prepared to handle this request (because it is blocked by another process such as an OLE container activation).

Manual References:: Models: Model Operations, Models: Model Operations

Returns:

void EraseWithDependencies ()

This method is enabled for Creo Direct.

Erases the model and its dependencies from the session.

This method also erases all of the models that this model depdends on from disk, so long as the dependencies are not needed by other items in session.

If the model is displayed in a window, the model is marked to be erased when control returns the Creo Parametric UI from the application. It is not erased immediately. pfcModel::Model::Erase

pfcSession::BaseSession::EraseUndisplayedModels

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - Current User Interface context does not allow erasure of models (for example, when the Erase button is grayed out).

pfcXToolkitInUse - The model could not be erased because it is in use, for example by another model in the session.

Manual References:: Models: Model Operations, Models: Model Operations

Returns:

void Delete ()

This method is enabled for Creo Direct.

Deletes the model from memory and disk.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The function is not available in Design Test Mode.

See Also:: pfcModel::Erase()

Manual References:: Models: Model Operations, Models: Model Operations

Returns:

void Display ()

Displays the model in its window.

Does not support display of 2D section models.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The model is NULL, and there is no current object.

pfcXToolkitInvalidPtr - The specified model is not in memory.

pfcXToolkitInvalidType - You specified an invalid model type.

Manual References:: Models: Model Operations, Models: Model Operations, Simplified Representations: Simplified Representation Utilities, Windows and Views: Getting a Window Object, Windows and Views: Getting a Window Object, Interface: Exporting to Faceted Formats

Returns:

optional pfcDependencies_ptr ListDependencies ()

Finds the first-level dependencies for the model in the Creo Parametric workspace.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No dependencies were found.

pfcXToolkitBadContext - Some dependencies could not be processed and were skipped.

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

Returns:: The list of dependencies, or null, if no dependencies found.

optional pfcModelDescriptors_ptr ListDeclaredModels ()

Finds all the first-level objects declared for the model.

If layout A is declared in layout B and layout B is declared in part P, only layout B will be returned. The list of model descriptors, or null, if no objects declared for the model have been found.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - No objects were found.

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

Returns:

pfcLayer_ptr CreateLayer (xrstring Name)

Creates a new layer in the object.

Exceptions thrown (but not limited to):

pfcXToolkitInvalidName - You specified an invalid layer name.

pfcXToolkitFound - A layer with the specified name already exists.

Manual References:: ModelItem: Getting Layer Objects

Parameters:

Name: The name of the new layer

Returns:: The created layer

void Export (xrstring FileName, pfcExportInstructions_ptr ExportData)

This method is enabled for Creo Direct.

Exports model data to a file or creates a plot. NOTE: In future, interface pfcExport3DInstructions will be deprecated. Use superseding method <reference 4 to unknown entity pfcModel::ExportIntf3D> to export these type of objects.

The exported file(s) will be typically be placed in the current Creo Parametric working directory.

For DMA, the following types are supported:

STEP

VDA

IGES

NEUTRAL

pfcWindow::Window::ExportRasterImage

pfcModel::RelationExportInstructions

pfcModel::IGESFileExportInstructions

pfcModel::ModelInfoExportInstructions

pfcModel::ProgramExportInstructions

pfcModel::DXFExportInstructions

pfcModel::DWGSetupExportInstructions

pfcModel::FeatIdExportInstructions

pfcModel::FeatInfoExportInstructions

pfcModel::MFGFeatCLExportInstructions

pfcModel::MFGOperCLExportInstructions

pfcModel::CATIAFacetsExportInstructions

pfcModel::RenderExportInstructions

pfcModel::STLASCIIExportInstructions

pfcModel::STLBinaryExportInstructions

pfcModel::InventorExportInstructions

pfcModel::IGES3DExportInstructions

pfcModel::STEPExportInstructions

pfcModel::VDAExportInstructions

pfcModel::FIATExportInstructions

pfcModel::BOMExportInstructions

pfcModel::MaterialExportInstructions

pfcModel::ConnectorParamExportInstructions

pfcModel::CGMFILEExportInstructions

pfcModel::VRMLModelExportInstructions

pfcModel::PlotInstructions

pfcExport::STEP3DExportInstructions

pfcExport::VDA3DExportInstructions

pfcExport::IGES3DNewExportInstructions

pfcExport::CATIAModel3DExportInstructions

pfcExport::ACIS3DExportInstructions

pfcExport::CATIASession3DExportInstructions

pfcExport::CADDSExportInstructions

pfcExport::NEUTRALFileExportInstructions

pfcExport::ProductViewExportInstructions

pfcModel::STEP2DExportInstructions

pfcModel::CableParamsFileInstructions

The name of the export file.

When ExportData is a pfcVRMLExportInstructions object, Name specifies the directory where the VRML files will be created. An export-instructions object that controls the exporting or plotting operation.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - This means either:

pro2prod_view.dll is not found, OR
Some entity from source model required for export does not exist.

pfcXToolkitObsoleteFunc - The file format selected is no longer supported on this platform.

pfcXToolkitBadContext - This means either:

pro2prod_view.dll could not be loaded, OR
Design Test Mode is active - the function is not available in this mode.

pfcXToolkitNoPermission - The function does not have permission to operate on this model.

pfcXToolkitNoLicense - You do not have a license.

pfcXToolkitNotDisplayed - Model not displayed in any window.

pfcXToolkitUnsupported - Export type is not Supported

pfcXInAMethod - Call pfcBaseSession_tk::ExportDirectVRML method instead

Manual References:: Technical Summary of Changes for Creo 4.0 M030: Exporting to Other File Formats Using the Export Profile Option, Windchill Connectivity APIs: Import and Export, Dimensions and Parameters: Creating and Accessing Parameters, Technical Summary of Changes for Creo 4.0 F000: Export Options, Technical Summary of Changes for Creo 4.0 F000: Configuration Flag to Include Annotations During Export of Creo Models, Interface: Exporting Files and 2D Models, Interface: Export Instructions, Interface: Export Instructions, Interface: Exporting to Faceted Formats, Interface: Exporting to PDF and U3D, Interface: Exporting 3D Geometry, Interface: Export Instructions, Interface: Export Instructions, Interface: Export Utilities, Interface: Export Utilities, Interface: Shrinkwrap Export, Interface: Faceted Solid Options, Interface: Faceted Solid Options, Interface: Printer Options

Parameters:

FileName
ExportData

Returns:

void Import (xrstring FilePath, pfcImportInstructions_ptr ImportData)

This method is enabled for Creo Direct.

Reads a file into Creo Parametric. The format must be the same as if these files were created by Creo Parametric.

Exceptions thrown (but not limited to):

pfcXToolkitLineTooLong - The input filename length is too long for this import file type.

pfcXToolkitObsoleteFunc - The file format selected is no longer supported on this platform.

pfcXToolkitInvalidFile - The input file could not be found, or contained unrecoverable errors.

pfcXToolkitNoLicense - There is no license for this import option.

pfcXInAMethod - Call pfcBaseSession_tk::LoadConfigFile for pfcIMPORT_CONFIG

See Also:: pfcImport2DInstructions, pfcSTEPImport2DInstructions, pfcIGESImport2DInstructions, pfcDXFImport2DInstructions, pfcDWGImport2DInstructions, pfcRelationImportInstructions, pfcIGESSectionImportInstructions, pfcProgramImportInstructions, pfcConfigImportInstructions, pfcDWGSetupImportInstructions, pfcSpoolImportInstructions, pfcConnectorParamsImportInstructions, pfcCableParamsImportInstructions, pfcASSEMTreeCFGImportInstructions, pfcWireListImportInstructions

Manual References:: Windchill Connectivity APIs: Import and Export, Technical Summary of Changes for Creo 4.0 F000: Import Feature, Interface: Importing Files, Interface: Import Instructions, Interface: Import Instructions, Interface: Import Feature Properties, Interface: Import Feature Attributes, Interface: Redefining the Import Feature, Interface: Associative Topology Bus Enabled Models and Features, Interface: Associative Topology Bus Enabled Models and Features

Parameters:

FilePath
ImportData: An import instructions object that controls the import operation.

Returns:

pfcExternalDataAccess_ptr AccessExternalData ()

This method is enabled for Creo Direct.

Initializes External Data access

Exceptions thrown (but not limited to):

pfcXExternalDataTKError - The function failed.

pfcXExternalDataInvalidObject - The specified model is invalid.

Manual References:: External Data: Accessing External Data, External Data: Accessing External Data

Returns:: ExternalDataAccess object used to access model's external dara

void TerminateExternalData ()

This method is enabled for Creo Direct.

Cleans up the setup required for the generic application data operations for the specified model.

If you need to preserve the external data created in session you must save the model before calling this method. Otherwise your data will be lost.

Exceptions thrown (but not limited to):

pfcXExternalDataTKError - The function failed.

pfcXExternalDataInvalidObject - The specified model is invalid.

Manual References:: External Data: Accessing External Data, External Data: Accessing External Data

Returns:

xbool CheckIsSaveAllowed (xbool ShowUI)

This method is enabled for Creo Direct.

Check if given model can be saved along with all its subordinate models that are to be saved together with it according to their modification status and the configuration option 'save_objects'.

This will also check the current UI context to see if it is currently safe to save the model, and so calling this function at different times might return different results.

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

Parameters:

ShowUI: Indicates whether the Conflicts dialog should be shown to user to resolve conflicts (if they are detected); when set to false no UI is enabled and the model is considered as modifiable if there are no conflicts that could not be overridden or resolved by default resolution actions.

Returns:: The boolean save access status. If it is true, the check is successful. If it is false, the model or at least one of its subordinate models can not be saved due to remaining unresolved non-overridable conflicts. Conflicts will not be shown if the model currently cannot be saved due to UI restrictions; the function will return false regardless of this flag.

xbool CheckIsModifiable (xbool ShowUI)

This method is enabled for Creo Direct.

Check if given model is modifiable, indicating that the model could be saved (without checking for any subordinate models).

For a generic model, if ShowUI is true, all its instances are also checked.

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

Parameters:

ShowUI: Indicates whether the Conflicts dialog should be shown to user to resolve conflicts (if they are detected); when set to false no UI is enabled and the model is considered as modifiable if there are no conflicts that could not be overridden or resolved by default resolution actions.

Returns:: The access status. If it is true, the model is modifiable.

xstring GetOrigin ()

This method is enabled for Creo Direct.

The location of the origin of the model.

This method supports Multi-CAD approach only for Object Toolkit (OTK) users. Outside of OTK (for instance in J-Link), this method will throw the XToolkitUnsupported exception if called on models originated through Multi-CAD.

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

`optional xstringsequence_ptr`	`GetPostRegenerationRelations`	`()`
`void`	`SetPostRegenerationRelations`	`(optional xstringsequence_ptr value)`

The list of the post-regeneration relations assigned to the model. This attribute can be null.

This attribute is a complement of pfcModelItem::RelationOwner::Relations which does not contain post regeneration relations. The obtained post regeneration relations attribute can be used in pfcModelItem::RelationOwner::SetRelations(/*optional*/ stringseq value), pfcRelationOwner::RegenerateRelations() and pfcRelationOwner::DeleteRelations().

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The post regeneration relation set was not found.

Manual References:: Relations: Accessing Post Regeneration Relations, Relations: Accessing Post Regeneration Relations

void RegeneratePostRegenerationRelations ()

Regenerates the post-regeneration relations in the model.

Manual References:: Relations: Accessing Post Regeneration Relations, Relations: Accessing Post Regeneration Relations

Returns:

void DeletePostRegenerationRelations ()

Deletes the post-regeneration relations in the model.

Manual References:: Relations: Accessing Post Regeneration Relations

Returns:

void CleanupDependencies ()

This method is enabled for Creo Direct.

Forces cleaning up dependencies database of an object in the Creo Parametric workspace. This function should not be called during reference altering operations like feature create, edit definition or restructure.

Exceptions thrown (but not limited to):

pfcXToolkitNotValid - The supplied solid is in the state, not allowing to cleanup dependencies i.e. inside feature creation.

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

Returns:

xbool IsNativeModel ()

Returns true if the origin of the model is Creo; false otherwise.

Use this method to indetify models created through the Multi-CAD approach. For such models it will return false. Multi-CAD models are supported only through Object Toolkit.

Manual References:: Models: Model Information, Models: Model Information, Technical Summary of Changes for Creo 4.0 F000: Models

Returns:

void ExportIntf3D (xrstring NewFileName, pfcExportType ExpType, optional xrstring ProfileFile)

This method is enabled for Creo Direct.

Exports a Creo Parametric model using default export profile.

Manual References:: Technical Summary of Changes for Creo 4.0 M030: Exporting to Other File Formats Using the Export Profile Option, Technical Summary of Changes for Creo 4.0 M030: Data Exchange, Interface: Export Instructions, Interface: Export Instructions

Parameters:

NewFileName: The output file name to produce. Optionally, this includes the path for the file location. The filename should not include the file extension, this will be added automatically by Creo Parametric.
ExpType: The type of output file to produce.
ProfileFile: Reserved for the future.

Returns: