CIP JAVA documentation for class "com.ptc.pfc.pfcModel.ModelDescriptor"

Interface ModelDescriptor

package com.ptc.pfc.pfcModel; public interface ModelDescriptor extends jxobject

Description

This class includes the information that identifies a Creo Parametric model or file.

Model descriptors can be used to represent models that are not currently in session.

The possible model types are as follows:

MDL_ASSEMBLY
MDL_PART
MDL_DRAWING
MDL_2D_SECTION
MDL_LAYOUT
MDL_DWG_FORMAT
MDL_MFG
MDL_REPORT
MDL_MARKUP
MDL_DIAGRAM

This descriptor does not support the Multi-CAD concept. Refer to Object Toolkit for Multi-CAD support.

See Also:: Model.Backup(ModelDescriptor), BaseSession.OpenFile(ModelDescriptor), BaseSession.RetrieveModel(ModelDescriptor), BaseSession.GetModelFromDescr(ModelDescriptor)

Method Summary
`String`	`GetDevice ()` Get method for attribute "Device" The device. On UNIX systems, this field contains an empty string. If you change this value on a UNIX system, Creo Parametric may experience problems when reading or writing the file.
`String`	`GetExtension ()` Retrieves the extension of the model identified by the model descriptor.
`String`	`GetFileName ()` Returns the file name for the object represented by the model descriptor.
`/optional/ Integer`	`GetFileVersion ()` Get method for attribute "FileVersion" The version of the file
`String`	`GetFullName ()` Retrieves the full name of the model identified by the model descriptor.
`/optional/ String`	`GetGenericName ()` Get method for attribute "GenericName" The name of the generic model. If the model is not an instance, this attribute must be `null` or an empty string.
`String`	`GetHost ()` Get method for attribute "Host" This is Obsoleted. The host. If the model resides on the local Windows or UNIX host, this field contains an empty string. If you change this value, Creo Parametric may experience problems when reading or writing the file.
`String`	`GetInstanceName ()` Get method for attribute "InstanceName" The name of the model, or, if the model is an instance, the instance name. This string can be neither `null` nor empty.
`String`	`GetPath ()` Get method for attribute "Path" The path to the file. Note that this argument is ignored by the RetrieveModel method.
`ModelType`	`GetType ()` Get method for attribute "Type" The model type. If the model descriptor represents a Creo Parametric related file that is not a true model type, a `XUnusedValue` exception will result if you try to access this value.
`void`	`SetDevice (String value)` Set method for attribute "Device" The device. On UNIX systems, this field contains an empty string. If you change this value on a UNIX system, Creo Parametric may experience problems when reading or writing the file.
`void`	`SetFileVersion ( /optional/ Integer value)` Set method for attribute "FileVersion" The version of the file
`void`	`SetGenericName ( /optional/ String value)` Set method for attribute "GenericName" The name of the generic model. If the model is not an instance, this attribute must be `null` or an empty string.
`void`	`SetHost (String value)` Set method for attribute "Host" This is Obsoleted. The host. If the model resides on the local Windows or UNIX host, this field contains an empty string. If you change this value, Creo Parametric may experience problems when reading or writing the file.
`void`	`SetInstanceName (String value)` Set method for attribute "InstanceName" The name of the model, or, if the model is an instance, the instance name. This string can be neither `null` nor empty.
`void`	`SetPath (String value)` Set method for attribute "Path" The path to the file. Note that this argument is ignored by the RetrieveModel method.
`void`	`SetType (ModelType value)` Set method for attribute "Type" The model type. If the model descriptor represents a Creo Parametric related file that is not a true model type, a `XUnusedValue` exception will result if you try to access this value.

Method Detail

GetType/SetType

`ModelType`	`GetType`	`()`
`void`	`SetType`	`(ModelType value)`

The model type. If the model descriptor represents a Creo Parametric related file that is not a true model type, a XUnusedValue exception will result if you try to access this value.

Manual References:: Models: Model Descriptors

GetInstanceName/SetInstanceName

`String`	`GetInstanceName`	`()`
`void`	`SetInstanceName`	`(String value)`

The name of the model, or, if the model is an instance, the instance name. This string can be neither null nor empty.

Manual References:: Models: Model Descriptors

GetGenericName/SetGenericName

`/optional/ String`	`GetGenericName`	`()`
`void`	`SetGenericName`	`( /optional/ String value)`

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

Manual References:: Models: Model Descriptors

GetHost/SetHost

`String`	`GetHost`	`()`
`void`	`SetHost`	`(String value)`

This is Obsoleted. The host. If the model resides on the local Windows or UNIX host, this field contains an empty string. If you change this value, Creo Parametric may experience problems when reading or writing the file.

GetDevice/SetDevice

`String`	`GetDevice`	`()`
`void`	`SetDevice`	`(String value)`

The device. On UNIX systems, this field contains an empty string. If you change this value on a UNIX system, Creo Parametric may experience problems when reading or writing the file.

Manual References:: Models: Model Descriptors

GetPath/SetPath

`String`	`GetPath`	`()`
`void`	`SetPath`	`(String value)`

The path to the file. Note that this argument is ignored by the RetrieveModel method.

Manual References:: Models: Model Descriptors

GetFileVersion/SetFileVersion

`/optional/ Integer`	`GetFileVersion`	`()`
`void`	`SetFileVersion`	`( /optional/ Integer value)`

The version of the file

Manual References:: Models: Model Descriptors, Models: Retrieving Models

GetFullName

String GetFullName ()

Retrieves the full name of the model identified by the model descriptor.

Manual References:: Models: Model Descriptors

Returns:: The name of the model. If the model is an instance, its full name has the formInstanceName<GenericName>

GetExtension

String GetExtension ()

Retrieves the extension of the model identified by the model descriptor.

Model extension gives an extension of the file which stores the model information. Models of the same type have the same extension. The following model extensions are used:

"asm" - for MDL_ASSEMBLY
"prt" - for MDL_PART
"drw" - for MDL_DRAWING
"sec" - for MDL_2D_SECTION and for MDL_3D_SECTION
"lay" - for MDL_LAYOUT
"frm" - for MDL_DWG_FORMAT
"mfg" - for MDL_MFG
"rep" - for MDL_REPORT
"mrk" - for MDL_MARKUP
"dgm" - for MDL_DIAGRAM

Other extensions may be returned for a model descriptor that represents a Creo Parametric file that does not match one of the above types.

Returns:: The model extension

GetFileName

String GetFileName ()

Returns the file name for the object represented by the model descriptor.

See Also:: pfcModel.ModelDescriptor_CreateFromFileName(String), pfcModel.ModelDescriptor_Create(ModelType, String, /*optional*/ String), BaseSession.GetModelFromFileName(String), BaseSession.RetrieveModel(ModelDescriptor)

Returns:: The file name, of the form "<name>.<extension>".