CIP C++ documentation for class "pfcPart"

Class pfcPart

# include <pfcPart.h> class pfcPart : public virtual pfcSolid { xaideclare(pfcPart) ... };

Description

This class defines the material data for a part.

Direct Known Subclasses:: wfcWPart

Method Summary


`pfcMaterial_ptr`	`CreateMaterial (xrstring Name)`
	Creates a material of the specified name (with default values) in the part.

`optional pfcMaterial_ptr`	`GetCurrentMaterial ()`
`void`	`SetCurrentMaterial (optional pfcMaterial_ptr value)`
	This method is enabled for Creo Direct. The part material

`optional pfcMaterial_ptr`	`GetMaterial (xrstring Name)`
	Locates a material by name.

`pfcMaterials_ptr`	`ListMaterials ()`
	Lists the materials that exist in the part.

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

	This method is enabled for Creo Direct.

Methods Inherited from Class pfcFamilyMember:: 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 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

Methods Inherited from Class pfcModel:: 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, ListDependencies, ListDeclaredModels, CreateLayer, Export, Import, AccessExternalData, TerminateExternalData, CheckIsSaveAllowed, CheckIsModifiable, GetOrigin, GetPostRegenerationRelations, SetPostRegenerationRelations, RegeneratePostRegenerationRelations, DeletePostRegenerationRelations, CleanupDependencies, IsNativeModel, ExportIntf3D

Methods Inherited from Class pfcSolid:: 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, ListGroups, CreateFeature, CreateUDFGroup, ExportShrinkwrap, GetPrincipalUnits, SetPrincipalUnits, ListUnits, ListUnitSystems, GetUnit, CreateCustomUnit, CreateUnitSystem

Method Detail

`optional pfcMaterial_ptr`	`GetCurrentMaterial`	`()`
`void`	`SetCurrentMaterial`	`(optional pfcMaterial_ptr value)`

This method is enabled for Creo Direct.

The part material

By default, assigning a material to a sheetmetal part through pfcPart::SetCurrentMaterial(optional pfcMaterial_ptr) 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

pfcMaterials_ptr ListMaterials ()

Lists the materials that exist in the part.

Manual References:: Solid: Materials, Solid: Materials

Returns:: The list of materials

pfcMaterial_ptr CreateMaterial (xrstring Name)

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

Exceptions thrown (but not limited to):

pfcXToolkitFound - The material name already exists.

Manual References:: Solid: Materials, Solid: Materials

Parameters:

Name: The material name

Returns:: The new material

pfcMaterial_ptr RetrieveMaterial (xrstring 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):

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

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

Manual References:: 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

optional pfcMaterial_ptr GetMaterial (xrstring Name)

Locates a material by name.

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

See Also:: pfcPart::RetrieveMaterial(xrstring), pfcPart::ListMaterials()

Parameters:

Name: The name of the material to find.

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