CIP JAVA documentation for class "com.ptc.pfc.pfcSolid.Solid"

Interface Solid

package com.ptc.pfc.pfcSolid; public interface Solid extends com.ptc.pfc.pfcFamily.FamilyMember, com.ptc.pfc.pfcModel.Model

Description

This class defines a solid.

Direct Known Subclasses:: Assembly, Part, WSolid

Method Summary
`void`	`ActivateSimpRep (SimpRep SimpRep)` Activates the specified simplified representation.
`Unit`	`CreateCustomUnit (String Name, UnitConversionFactor ConversionFactor, Unit ReferenceUnit)` Creates a custom unit based on name, conversion factor and reference unit.
`Feature`	`CreateFeature (FeatureCreateInstructions Instructions)` Not implemented in the current release. Creates a feature, based on the instructions provided.
`Feature`	`CreateImportFeat (IntfDataSource IntfData, /optional/ CoordSystem CoordSys, /optional/ ImportFeatAttr FeatAttr)` Creates a new import feature in the solid (part). Assembly case is not supported.
`FeatureGroup`	`CreateLocalGroup (Features Members, String Name)` Creates a local group out of the specified set of features.
`ModelItem`	`CreateNote (stringseq Lines, /optional/ ModelItem Owner)`
`SimpRep`	`CreateSimpRep (CreateNewSimpRepInstructions Instructions)` Creates a simplified representation based on the supplied instructions.
`FeatureGroup`	`CreateUDFGroup (UDFGroupCreateInstructions Instructions)` Creates a FeatureGroup, based on the instructions provided.
`UnitSystem`	`CreateUnitSystem (String Name, UnitSystemType Type, Units Units)` Creates a new unit system in the model.
`void`	`DeleteSimpRep (SimpRep SimpRep)` Deletes the specified simplified representation from its owner model.
`Outline3D`	`EvalOutline ( /optional/ Transform3D Trf, /optional/ ModelItemTypes ExcludeTypes)` Computes the outline of a solid.
`void`	`ExecuteFeatureOps (FeatureOperations Ops, /optional/ RegenInstructions Instrs)` Performs the specified feature operations.
`void`	`ExportShrinkwrap (ShrinkwrapExportInstructions Instructions)` Exports a solid model to shrinkwrap format.
`/optional/ Double`	`GetAbsoluteAccuracy ()` Get method for attribute "AbsoluteAccuracy" The absolute accuracy of the solid or `null`, if relative accuracy is used
`SimpRep`	`GetActiveSimpRep ()` Returns the current active simplified representation.
`/optional/ XSection`	`GetCrossSection (String Name)` Returns a cross-section object, given its name.
`SolidBody`	`GetDefaultBody ()` Returns the default body of the solid.
`SolidBody`	`GetEdgeSolidBody (Edge thisEdge)` Returns the body to which the edge belongs.
`/optional/ Feature`	`GetFeatureById (int Id)` Retrieves the specified feature, given its identifier.
`/optional/ Feature`	`GetFeatureByName (String Name)` Locates the feature object, given its name.
`Outline3D`	`GetGeomOutline ()` Get method for attribute "GeomOutline" The outline of the solid with respect to the base coordinate system orientation
`SimpRep`	`GetGeomRep ()` Returns the object representing the solid model's Geometry Rep.
`SimpRep`	`GetGraphicsRep ()` Returns the object representing the solid model's Grpahics Rep.
`boolean`	`GetIsSkeleton ()` Get method for attribute "IsSkeleton" `true` if the model is a skeleton model, `false` otherwise.
`MassProperty`	`GetMassProperty ( /optional/ String CoordSysName)` Gets the mass properties for the solid.
`MassProperty`	`GetMassPropertyWithDensity ( /optional/ String CoordSysName, MPDensityUse DensityOpt, /optional/ Double density)`
`SimpRep`	`GetMasterRep ()` Returns the object representing the solid model's Master Rep.
`UnitSystem`	`GetPrincipalUnits ()` Gets the system of units assigned to the solid model.
`/optional/ Double`	`GetRelativeAccuracy ()` Get method for attribute "RelativeAccuracy" The relative accuracy of the solid or `null`, if absolute accuracy is used
`SimpRep`	`GetSimpRep (String SimpRepName)` Returns the handle to the specified simplified representation.
`SolidBody`	`GetSurfaceSolidBody (Surface thisSurf)` Returns the body to which the surface belongs.
`/optional/ Unit`	`GetUnit (String Name, /optional/ Boolean ByExpression)` Get the handle to a particular unit based on name or expression.
`boolean`	`HasRetrievalErrors ()` Identifies if a previous call to retrieve the model resulted in errors.
`/optional/ XSections`	`ListCrossSections ()` Lists the cross-sections in the solid model.
`/optional/ Features`	`ListFailedFeatures ()` Retrieves the list of failed features in the part or assembly.
`/optional/ Features`	`ListFeaturesByType ( /optional/ Boolean VisibleOnly, /optional/ FeatureType Type)` Lists the features according to type.
`FeatureGroups`	`ListGroups ()` Collect groups (including UDFs) in the solid.
`Units`	`ListUnits ( /optional/ UnitType Type)` Lists the units available in the model.
`UnitSystems`	`ListUnitSystems ()` Lists the unit systems available in the model.
`void`	`Regenerate ( /optional/ RegenInstructions Instrs)` Regenerates the solid.
`SimpRep`	`SelectSimpRep ()` Enables the user to select a simplified representation.
`void`	`SetAbsoluteAccuracy ( /optional/ Double value)` Set method for attribute "AbsoluteAccuracy" The absolute accuracy of the solid or `null`, if relative accuracy is used
`void`	`SetPrincipalUnits (UnitSystem Units, UnitConversionOptions Options)` Sets the system of units for the solid.
`void`	`SetRelativeAccuracy ( /optional/ Double value)` Set method for attribute "RelativeAccuracy" The relative accuracy of the solid or `null`, if absolute accuracy is used

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

Method Detail

GetDefaultBody

SolidBody GetDefaultBody ()

Returns the default body of the solid.

Manual References:: Solid Bodies: Solid Body Information, Solid Bodies: Solid Body Information

Returns:: The default solid body object.

GetSurfaceSolidBody

SolidBody GetSurfaceSolidBody (Surface thisSurf)

Returns the body to which the surface belongs.

Manual References:: Solid: Solid Operations, Solid: Solid Operations

Parameters:

thisSurf: The surface whose solid body is sought.

Returns:: The solid body object.

GetEdgeSolidBody

SolidBody GetEdgeSolidBody (Edge thisEdge)

Returns the body to which the edge belongs.

Manual References:: Solid: Solid Operations, Solid: Solid Operations

Parameters:

thisEdge: The edge whose solid body is sought.

Returns:: The solid body object.

GetGeomOutline

Outline3D GetGeomOutline ()

The outline of the solid with respect to the base coordinate system orientation

Manual References:: Solid: Solid Operations, Solid: Solid Operations

GetRelativeAccuracy/SetRelativeAccuracy

`/optional/ Double`	`GetRelativeAccuracy`	`()`
`void`	`SetRelativeAccuracy`	`( /optional/ Double value)`

The relative accuracy of the solid or null, if absolute accuracy is used

Manual References:: Solid: Solid Information, Solid: Solid Information

GetAbsoluteAccuracy/SetAbsoluteAccuracy

`/optional/ Double`	`GetAbsoluteAccuracy`	`()`
`void`	`SetAbsoluteAccuracy`	`( /optional/ Double value)`

The absolute accuracy of the solid or null, if relative accuracy is used

Manual References:: Solid: Solid Information, Solid: Solid Information

Regenerate

void Regenerate ( /*optional*/ RegenInstructions Instrs)

Regenerates the solid.

Regeneration in No-Resolve mode (default mode in Creo Elements/Pro) is not supported. This method will throw XToolkitBadContext, if Creo Parametric is running in No-Resolve mode. To continue with the Pro/ENGINEER Wildfire 4.0 behavior in Resolve mode, set the configuration option 'regen_failure_handling' to 'resolve_mode'.

Exceptions thrown (but not limited to):

XToolkitUnattachedFeats - Unattached features were detected, but there was no regeneration failure

XToolkitRegenerateAgain - The model is too complex to regenerate the first time

XToolkitBadContext - Invalid regen flags and/or combination of regeneration flags if mixed with pfcRegenInstructions::SetForceRegen as true.

Manual References:: Solid: Regenerating a Solid, Solid: Regenerating a Solid

Parameters:

Instrs: The regeneration instructions. This parameter can be null, in which case the Creo Parametric's Fix Model interface is not displayed after a failure.

Returns:

ExecuteFeatureOps

void ExecuteFeatureOps (FeatureOperations Ops, /*optional*/ RegenInstructions Instrs)

Performs the specified feature operations.

This method is not supported in No-Resolve mode (default regeneration mode in Creo Elements/Pro). It will throw XToolkitBadContext, if Creo Parametric is running in No-Resolve mode. To continue with the Pro/ENGINEER Wildfire 4.0 behavior in Resolve mode, set the configuration option 'regen_failure_handling' to 'resolve_mode'.

Exceptions thrown (but not limited to):

XToolkitNotValid - One or more input features is not permitted to be suppressed.

XToolkitSuppressedParents - Suppressed parents were found.

<reference 6 to unknown entity pfcExceptions::pfcXToolkitInvalidPtr> - Feature operation is invalid

Manual References:: Features: Feature Operations, Features: Feature Operations, Assemblies and Components: Assembly Components

Parameters:

Ops: The feature operations (suppress, delete, resume, and so on)
Instrs: The regeneration instructions. This parameter can be null, in which case the Creo Parametric's Fix Model interface is not displayed after a failure.

Returns:

EvalOutline

Outline3D EvalOutline ( /*optional*/ Transform3D Trf, /*optional*/ ModelItemTypes ExcludeTypes)

Computes the outline of a solid.

Manual References:: Solid: Solid Operations, Solid: Solid Operations

Parameters:

Trf: The orientation matrix (with respect to the base coordinatesystem) to which the outline is to be computed
ExcludeTypes: An array of model-item types to exclude from the outline computation. The types that can be excluded are ITEM_COORD_SYS, ITEM_AXIS, and ITEM_POINT.

Returns:: An Outline3D object which contains two points that define the boundaries of the solid in the specified orientation

CreateLocalGroup

FeatureGroup CreateLocalGroup (Features Members, String Name)

Creates a local group out of the specified set of features.

The supplied features must represent a contiguous set of features in the part or assembly.

Manual References:: Features: Feature Groups and Patterns, Features: Feature Groups and Patterns

Parameters:

Members: The features to be grouped
Name: The name to be assigned to the created local group

Returns:: The local group that was created

CreateNote

ModelItem CreateNote (stringseq Lines, /*optional*/ ModelItem Owner)

Parameters:

Lines
Owner

Returns:

ListFailedFeatures

/*optional*/ Features ListFailedFeatures ()

Retrieves the list of failed features in the part or assembly.

Manual References:: Features: Access to Features, Features: Access to Features

Returns:: The list of failed features, or null if no failed features has been found

ListFeaturesByType

/*optional*/ Features ListFeaturesByType ( /*optional*/ Boolean VisibleOnly, /*optional*/ FeatureType Type)

Lists the features according to type.

Exceptions thrown (but not limited to):

XToolkitNotFound - No failed feature was found.

Manual References:: Features: Access to Features, Features: Access to Features

Parameters:

VisibleOnly: If this is true, the function lists public features only. If this is false, the function lists both public and internal features. Internal features are 'invisible' features and used internally for construction purposes. (If the argument is null, true will be used.)
Type: The feature type or null, if all the solid features are to be listed

Returns:: The list of features or null, if no features of the specified type has been found

ListCrossSections

/*optional*/ XSections ListCrossSections ()

Lists the cross-sections in the solid model.

Exceptions thrown (but not limited to):

XToolkitNotFound - Model doesn't have cross-sections.

Manual References:: Cross Sections: Listing Cross Sections, Cross Sections: Listing Cross Sections

Returns:: Sequence of cross-section objects.

GetCrossSection

/*optional*/ XSection GetCrossSection (String Name)

Returns a cross-section object, given its name.

Exceptions thrown (but not limited to):

XToolkitNotFound - Model doesn't have cross-sections.

Manual References:: Cross Sections: Listing Cross Sections, Cross Sections: Listing Cross Sections

Parameters:

Name: The name of the cross-section.

Returns:: The cross-section object, or null, if the cross-section with that name does not exist.

GetIsSkeleton

boolean GetIsSkeleton ()

true if the model is a skeleton model, false otherwise.

Exceptions thrown (but not limited to):

XToolkitNotValid - Required license not found.

Manual References:: Solid: Solid Operations, Solid: Solid Operations, Assemblies and Components: Skeleton Models

HasRetrievalErrors

boolean HasRetrievalErrors ()

Identifies if a previous call to retrieve the model resulted in errors.

Models may be retrieved even if some component models are missing. The missing components will be suppressed, and geometry referencing these models will be frozen. The retrieval methods will not give an indication that this error occurred. Call this method after retrieval to see if any such errors occurred.

Exceptions thrown (but not limited to):

XToolkitNotFound - Errors were not found for this model.

See Also:: BaseSession.RetrieveModel(ModelDescriptor), BaseSession.RetrieveModelWithOpts(ModelDescriptor, RetrieveModelOptions), BaseSession.OpenFile(ModelDescriptor), BaseSession.RetrieveAssemSimpRep(String, /*optional*/ SimpRepInstructions)

Manual References:: Models: Retrieving Models

Returns:: true if errors occurred during retrieval, false if there was no error.

GetFeatureByName

/*optional*/ Feature GetFeatureByName (String Name)

Locates the feature object, given its name.

Exceptions thrown (but not limited to):

XToolkitNotFound - The item was not found.

Parameters:

Name: The name of the feature to locate.

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

GetFeatureById

/*optional*/ Feature GetFeatureById (int Id)

Retrieves the specified feature, given its identifier.

Exceptions thrown (but not limited to):

XToolkitNotExist - Item with such id and type does not exist.

Manual References:: Features: Access to Features, Features: Access to Features

Parameters:

Id: The feature identifier

Returns:: The requested feature or null, if the solid does not contain a featurewith the specified identifier.

CreateImportFeat

Feature CreateImportFeat (IntfDataSource IntfData, /*optional*/ CoordSystem CoordSys, /*optional*/ ImportFeatAttr FeatAttr)

Creates a new import feature in the solid (part). Assembly case is not supported.

Exceptions thrown (but not limited to):

XToolkitUnsupported - Creo Parametric does not support import of the indicated file.

XToolkitNotExist - No profile found.

XToolkitInvalidFile - profile is not readable.

Manual References:: Interface: Solid Operations, Interface: Solid Operations

Parameters:

IntfData: The source of data (that is, the file) from which to create the import feature.
CoordSys: A reference coordinate system. If NULL, the method uses the default coordinate system.
FeatAttr: The attributes for creation of the new import feature. If NULL, the method uses the default attributes.

Returns:: The handle to the new import feature.

ActivateSimpRep

void ActivateSimpRep (SimpRep SimpRep)

Activates the specified simplified representation.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified simplified representation was not found in the model.

Manual References:: Simplified Representations: Simplified Representation Utilities, Simplified Representations: Simplified Representation Utilities

Parameters:

SimpRep: The simplified representation to activate.

Returns:

GetActiveSimpRep

SimpRep GetActiveSimpRep ()

Returns the current active simplified representation.

Manual References:: Simplified Representations: Simplified Representation Utilities

Returns:: The current active simplified representation

CreateSimpRep

SimpRep CreateSimpRep (CreateNewSimpRepInstructions Instructions)

Creates a simplified representation based on the supplied instructions.

Manual References:: Simplified Representations: Creating and Deleting Simplified Representations, Simplified Representations: Creating and Deleting Simplified Representations

Parameters:

Instructions: The Instructions (data) for the simplified representation.

Returns:: The handle to the new simplified representation.

SelectSimpRep

SimpRep SelectSimpRep ()

Enables the user to select a simplified representation.

Exceptions thrown (but not limited to):

XToolkitUserAbort - The user aborted simplified representation selection.

Manual References:: Simplified Representations: Simplified Representation Utilities, Simplified Representations: Simplified Representation Utilities

Returns:: The selected simplified representation.

GetSimpRep

SimpRep GetSimpRep (String SimpRepName)

Returns the handle to the specified simplified representation.

Exceptions thrown (but not limited to):

XToolkitNotFound - The function did not find the simplified representation in the solid.

Manual References:: Simplified Representations: Simplified Representation Utilities, Simplified Representations: Simplified Representation Utilities

Parameters:

SimpRepName: The name of the simplified representation in the solid.

Returns:

GetMasterRep

SimpRep GetMasterRep ()

Returns the object representing the solid model's Master Rep.

Exceptions thrown (but not limited to):

XToolkitNotFound - The function did not find the simplified representation in the solid.

See Also:: Solid.GetSimpRep(String), Solid.GetGraphicsRep(), Solid.GetGeomRep(), SimpRep.GetSimpRepType()

Returns:: An object representing the Master Rep.

GetGraphicsRep

SimpRep GetGraphicsRep ()

Returns the object representing the solid model's Grpahics Rep.

Exceptions thrown (but not limited to):

XToolkitNotFound - The function did not find the simplified representation in the solid.

See Also:: Solid.GetSimpRep(String), Solid.GetGeomRep(), Solid.GetMasterRep(), SimpRep.GetSimpRepType()

Returns:: An object representing the Graphics Rep.

GetGeomRep

SimpRep GetGeomRep ()

Returns the object representing the solid model's Geometry Rep.

Exceptions thrown (but not limited to):

XToolkitNotFound - The function did not find the simplified representation in the solid.

See Also:: Solid.GetSimpRep(String), Solid.GetGraphicsRep(), Solid.GetMasterRep(), SimpRep.GetSimpRepType()

Returns:: An object representing the Geometry Rep.

DeleteSimpRep

void DeleteSimpRep (SimpRep SimpRep)

Deletes the specified simplified representation from its owner model.

Manual References:: Simplified Representations: Creating and Deleting Simplified Representations

Parameters:

SimpRep: The simplified representation to delete.

Returns:

GetMassProperty

MassProperty GetMassProperty ( /*optional*/ String CoordSysName)

Gets the mass properties for the solid.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified coordinate system was not found.

Manual References:: Solid: Mass Properties, Solid: Mass Properties

Parameters:

CoordSysName: The coordinate system name used to compute the mass property.If null, uses the default coordinate system.

Returns:

GetMassPropertyWithDensity

MassProperty GetMassPropertyWithDensity ( /*optional*/ String CoordSysName, MPDensityUse DensityOpt, /*optional*/ Double density)

Manual References:: Solid: Mass Properties

Parameters:

CoordSysName
DensityOpt
density

Returns:

ListGroups

FeatureGroups ListGroups ()

Collect groups (including UDFs) in the solid.

Exceptions thrown (but not limited to):

XToolkitNotFound - No groups exist in the solid

Manual References:: Solid: Solid Operations, Solid: Solid Operations

Returns:: The list of groups.

CreateFeature

Feature CreateFeature (FeatureCreateInstructions Instructions)

Not implemented in the current release. Creates a feature, based on the instructions provided.

Object Toolkit users can use WCreateFeature

Parameters:

Instructions: Descriptions of the type of feature to create.

Returns:: pfcFeature object

CreateUDFGroup

FeatureGroup CreateUDFGroup (UDFGroupCreateInstructions Instructions)

Creates a FeatureGroup, based on the instructions provided.

Exceptions thrown (but not limited to):

XToolkitUnsupported - The input model is Multi-CAD model.

Manual References:: Features: Read Access to Groups and User Defined Features, Features: Creating Features from UDFs, Features: Creating a Custom UDF, Features: Creating a Custom UDF, Solid: Getting a Solid Object

Parameters:

Instructions: Data objects containing parameters for the type of feature group to create.

Returns:: The created UDF group.

ExportShrinkwrap

void ExportShrinkwrap (ShrinkwrapExportInstructions Instructions)

Exports a solid model to shrinkwrap format.

Exceptions thrown (but not limited to):

XToolkitBadContext - Invalid combination of input arguments.

XToolkitLineTooLong - Name length of the output file is more than 31 chars.

Manual References:: Interface: Shrinkwrap Export

Parameters:

Instructions: Instructions describing the type and contents of the shrinkwrap model.

Returns:

GetPrincipalUnits

UnitSystem GetPrincipalUnits ()

Gets the system of units assigned to the solid model.

Manual References:: Solid: Accessing Systems of Units, Solid: Accessing Systems of Units

Returns:: The unit system.

SetPrincipalUnits

void SetPrincipalUnits (UnitSystem Units, UnitConversionOptions Options)

Sets the system of units for the solid.

This will regenerate the model.

Manual References:: Solid: Conversion to a New Unit System, Solid: Conversion to a New Unit System

Parameters:

Units: The new unit system.
Options: Information about the data conversion should take place.

Returns:

ListUnits

Units ListUnits ( /*optional*/ UnitType Type)

Lists the units available in the model.

Manual References:: Solid: Accessing Individual Units, Solid: Accessing Individual Units

Parameters:

Type: The type of units to list. If this is null, this will list all unit types.

Returns:: The list of units found.

ListUnitSystems

UnitSystems ListUnitSystems ()

Lists the unit systems available in the model.

Manual References:: Solid: Accessing Systems of Units, Solid: Accessing Systems of Units

Returns:: The list of unit systems.

GetUnit

/*optional*/ Unit GetUnit (String Name, /*optional*/ Boolean ByExpression)

Get the handle to a particular unit based on name or expression.

Exceptions thrown (but not limited to):

XToolkitNotFound - The indicated unit name does not exist in the model.

Manual References:: Solid: Accessing Individual Units, Solid: Accessing Individual Units

Parameters:

Name: The name, or expression, for the unit.
ByExpression: Specifies whether name is to be treated as an expression (value true) or not (value false).

Returns:: The initialized Unit

CreateCustomUnit

Unit CreateCustomUnit (String Name, UnitConversionFactor ConversionFactor, Unit ReferenceUnit)

Creates a custom unit based on name, conversion factor and reference unit.

Exceptions thrown (but not limited to):

XToolkitNotFound - The reference unit was not found in the model.

Manual References:: Solid: Creating a New Unit, Solid: Creating a New Unit

Parameters:

Name: The name of the unit
ConversionFactor: Information relating the new unit to its reference unit.
ReferenceUnit: The unit upon which the new unit is based.

Returns:: The created Unit

CreateUnitSystem

UnitSystem CreateUnitSystem (String Name, UnitSystemType Type, Units Units)

Creates a new unit system in the model.

Units should include at most one occurrence of each basic unit type. If a unit of a basic type is missing then a corresponding one is taken from the standard system 'Creo Parametric Default'.

Exceptions thrown (but not limited to):

XToolkitAmbiguous - The units argument contains multiple units for a type.

Manual References:: Solid: Creating a New System of Units

Parameters:

Name: The name of the new unit system.
Type: The type of unit system to create (Mass/Length/Time) or (Force/Length/Time).
Units: Sequence of units that makes up the new unit system.

Returns:: The created UnitSystem