CIP JAVA documentation for class "com.ptc.pfc.pfcPart.Part"

Interface Part

package com.ptc.pfc.pfcPart; public interface Part extends com.ptc.pfc.pfcSolid.Solid

Description

This class defines the material data for a part.

Direct Known Subclasses:: WPart

Method Summary
`Material`	`CreateMaterial (String Name)` Creates a material of the specified name (with default values) in the part.
`/optional/ Material`	`GetCurrentMaterial ()` Get method for attribute "CurrentMaterial" The part material
`/optional/ Material`	`GetMaterial (String Name)` Locates a material by name.
`Materials`	`ListMaterials ()` Lists the materials that exist in the part.
`Material`	`RetrieveMaterial (String FileName)` Reads the named material properties from file and adds (or updates) the specified material name to the part's database.
`void`	`SetCurrentMaterial ( /optional/ Material value)` Set method for attribute "CurrentMaterial" The part material

Methods Inherited from Interface `com.ptc.pfc.pfcFamily.FamilyMember`
`GetParent`, `GetImmediateGenericInfo`, `GetTopGenericInfo`, `ListColumns`, `ListRows`, `GetCell`, `SetCell`, `GetCellIsDefault`, `AddRow`, `GetRow`, `RemoveRow`, `AddColumn`, `RemoveColumn`, `GetColumn`, `CreateColumn`, `CreateParamColumn`, `CreateDimensionColumn`, `CreateFeatureColumn`, `CreateComponentColumn`, `CreateCompModelColumn`, `CreateGroupColumn`, `CreateMergePartColumn`, `CreateTolPlusColumn`, `CreateTolMinusColumn`, `CreateTolPlusMinusColumn`

Methods Inherited from Interface com.ptc.pfc.pfcFamily.FamilyMember

GetParent, GetImmediateGenericInfo, GetTopGenericInfo, ListColumns, ListRows, GetCell, SetCell, GetCellIsDefault, AddRow, GetRow, RemoveRow, AddColumn, RemoveColumn, GetColumn, CreateColumn, CreateParamColumn, CreateDimensionColumn, CreateFeatureColumn, CreateComponentColumn, CreateCompModelColumn, CreateGroupColumn, CreateMergePartColumn, CreateTolPlusColumn, CreateTolMinusColumn, CreateTolPlusMinusColumn

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

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.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

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

Methods Inherited from Interface `com.ptc.pfc.pfcSolid.Solid`
`GetDefaultBody`, `GetSurfaceSolidBody`, `GetEdgeSolidBody`, `GetGeomOutline`, `GetRelativeAccuracy`, `SetRelativeAccuracy`, `GetAbsoluteAccuracy`, `SetAbsoluteAccuracy`, `Regenerate`, `ExecuteFeatureOps`, `EvalOutline`, `CreateLocalGroup`, `CreateNote`, `ListFailedFeatures`, `ListFeaturesByType`, `ListCrossSections`, `GetCrossSection`, `GetIsSkeleton`, `HasRetrievalErrors`, `GetFeatureByName`, `GetFeatureById`, `CreateImportFeat`, `ActivateSimpRep`, `GetActiveSimpRep`, `CreateSimpRep`, `SelectSimpRep`, `GetSimpRep`, `GetMasterRep`, `GetGraphicsRep`, `GetGeomRep`, `DeleteSimpRep`, `GetMassProperty`, `GetMassPropertyWithDensity`, `ListGroups`, `CreateFeature`, `CreateUDFGroup`, `ExportShrinkwrap`, `GetPrincipalUnits`, `SetPrincipalUnits`, `ListUnits`, `ListUnitSystems`, `GetUnit`, `CreateCustomUnit`, `CreateUnitSystem`

Methods Inherited from Interface com.ptc.pfc.pfcSolid.Solid

GetDefaultBody, GetSurfaceSolidBody, GetEdgeSolidBody, GetGeomOutline, GetRelativeAccuracy, SetRelativeAccuracy, GetAbsoluteAccuracy, SetAbsoluteAccuracy, Regenerate, ExecuteFeatureOps, EvalOutline, CreateLocalGroup, CreateNote, ListFailedFeatures, ListFeaturesByType, ListCrossSections, GetCrossSection, GetIsSkeleton, HasRetrievalErrors, GetFeatureByName, GetFeatureById, CreateImportFeat, ActivateSimpRep, GetActiveSimpRep, CreateSimpRep, SelectSimpRep, GetSimpRep, GetMasterRep, GetGraphicsRep, GetGeomRep, DeleteSimpRep, GetMassProperty, GetMassPropertyWithDensity, ListGroups, CreateFeature, CreateUDFGroup, ExportShrinkwrap, GetPrincipalUnits, SetPrincipalUnits, ListUnits, ListUnitSystems, GetUnit, CreateCustomUnit, CreateUnitSystem

Method Detail

GetCurrentMaterial/SetCurrentMaterial

`/optional/ Material`	`GetCurrentMaterial`	`()`
`void`	`SetCurrentMaterial`	`( /optional/ Material value)`

The part material

By default, assigning a material to a sheetmetal part through Part.SetCurrentMaterial(/*optional*/ Material) modifies the values of the sheetmetal properties such as Y factor and/or bend table as per the material file definition. This triggers a regeneration and a modification of the developed length calculations of the sheetmetal part. However, you can avoid this behavior by setting the value of the config option "material_update_smt_bend_table" to "never_replace".

Manual References:: Solid: Materials, Solid: Materials, Solid: Materials, Solid: Materials

ListMaterials

Materials ListMaterials ()

Lists the materials that exist in the part.

Manual References:: Solid: Materials, Solid: Materials

Returns:: The list of materials

CreateMaterial

Material CreateMaterial (String Name)

Creates a material of the specified name (with default values) in the part.

Exceptions thrown (but not limited to):

XToolkitFound - The material name already exists.

Manual References:: Solid: Materials, Solid: Materials

Parameters:

Name: The material name

Returns:: The new material

RetrieveMaterial

Material RetrieveMaterial (String FileName)

Reads the named material properties from file and adds (or updates) the specified material name to the part's database.

Exceptions thrown (but not limited to):

XToolkitInvalidType - The model handle you passed to the function is not a part.

XToolkitNotFound - The specifed file was not found on the drive.

Manual References:: Solid: Materials, Solid: Materials

Parameters:

FileName: The name of the material file. The method will look for'matl_name'.mtl (a modern material file) first, and then 'matl_name'.mat.

Returns:: The material properties

GetMaterial

/*optional*/ Material GetMaterial (String Name)

Locates a material by name.

The material must be stored in the part and not stored in an external file.

See Also:: Part.RetrieveMaterial(String), Part.ListMaterials()

Parameters:

Name: The name of the material to find.

Returns:: The material object, or null, if the material was not found.