CIP Visual Basic.NET documentation for interface "IpfcSolid"

Interface IpfcSolid

Description

This class defines a solid.

Direct Parent Classes:: IpfcFamilyMember, IpfcModel

Direct Known Subclasses:: IpfcAssembly, IpfcPart

Property Summary


`Property`	`AbsoluteAccuracy`	`as Double [optional]`
	The absolute accuracy of the solid or `null`, if relative accuracy is used

`Property`	`GeomOutline`	`as IpfcOutline3D`
	The outline of the solid with respect to the base coordinate system orientation

`Property`	`IsSkeleton`	`as Boolean`
	`true` if the model is a skeleton model, `false` otherwise.

`Property`	`RelativeAccuracy`	`as Double [optional]`
	The relative accuracy of the solid or `null`, if absolute accuracy is used

Method Summary


`Sub`	`ActivateSimpRep (SimpRep as IpfcSimpRep)`
	Activates the specified simplified representation.

`Function`	`CreateCustomUnit (Name as String, ConversionFactor as IpfcUnitConversionFactor, ReferenceUnit as IpfcUnit) as IpfcUnit`
	Creates a custom unit based on name, conversion factor and reference unit.

`Function`	`CreateFeature (Instructions as IpfcFeatureCreateInstructions) as IpfcFeature`
	Not implemented in the current release. Creates a feature, based on the instructions provided.

`Function`	`CreateImportFeat (IntfData as IpfcIntfDataSource, CoordSys as IpfcCoordSystem [optional], FeatAttr as IpfcImportFeatAttr [optional]) as IpfcFeature`
	Creates a new import feature in the solid (part). Assembly case is not supported.

`Function`	`CreateLocalGroup (Members as IpfcFeatures, Name as String) as IpfcFeatureGroup`
	Creates a local group out of the specified set of features.

`Function`	`CreateNote (Lines as Istringseq, Owner as IpfcModelItem [optional]) as IpfcModelItem`


`Function`	`CreateSimpRep (Instructions as IpfcCreateNewSimpRepInstructions) as IpfcSimpRep`
	Creates a simplified representation based on the supplied instructions.

`Function`	`CreateUDFGroup (Instructions as IpfcUDFGroupCreateInstructions) as IpfcFeatureGroup`
	Creates a FeatureGroup, based on the instructions provided.

`Function`	`CreateUnitSystem (Name as String, Type as IpfcUnitSystemType, Units as IpfcUnits) as IpfcUnitSystem`
	Creates a new unit system in the model.

`Sub`	`DeleteSimpRep (SimpRep as IpfcSimpRep)`
	Deletes the specified simplified representation from its owner model.

`Function`	`EvalOutline (Trf as IpfcTransform3D [optional], ExcludeTypes as IpfcModelItemTypes [optional]) as IpfcOutline3D`
	Computes the outline of a solid.

`Sub`	`ExecuteFeatureOps (Ops as IpfcFeatureOperations, Instrs as IpfcRegenInstructions [optional])`
	Performs the specified feature operations.

`Sub`	`ExportShrinkwrap (Instructions as IpfcShrinkwrapExportInstructions)`
	Exports a solid model to shrinkwrap format.

`Function`	`GetActiveSimpRep () as IpfcSimpRep`
	Returns the current active simplified representation.

`Function`	`GetCrossSection (Name as String) as IpfcXSection [optional]`
	Returns a cross-section object, given its name.

`Function`	`GetDefaultBody () as IpfcSolidBody`
	Returns the default body of the solid.

`Function`	`GetEdgeSolidBody (thisEdge as IpfcEdge) as IpfcSolidBody`
	Returns the body to which the edge belongs.

`Function`	`GetFeatureById (Id as Long) as IpfcFeature [optional]`
	Retrieves the specified feature, given its identifier.

`Function`	`GetFeatureByName (Name as String) as IpfcFeature [optional]`
	Locates the feature object, given its name.

`Function`	`GetGeomRep () as IpfcSimpRep`
	Returns the object representing the solid model's Geometry Rep.

`Function`	`GetGraphicsRep () as IpfcSimpRep`
	Returns the object representing the solid model's Grpahics Rep.

`Function`	`GetMassProperty (CoordSysName as String [optional]) as IpfcMassProperty`
	Gets the mass properties for the solid.

`Function`	`GetMassPropertyWithDensity (CoordSysName as String [optional], DensityOpt as IpfcMPDensityUse, density as Double [optional]) as IpfcMassProperty`


`Function`	`GetMasterRep () as IpfcSimpRep`
	Returns the object representing the solid model's Master Rep.

`Function`	`GetPrincipalUnits () as IpfcUnitSystem`
	Gets the system of units assigned to the solid model.

`Function`	`GetSimpRep (SimpRepName as String) as IpfcSimpRep`
	Returns the handle to the specified simplified representation.

`Function`	`GetSurfaceSolidBody (thisSurf as IpfcSurface) as IpfcSolidBody`
	Returns the body to which the surface belongs.

`Function`	`GetUnit (Name as String, ByExpression as Boolean [optional]) as IpfcUnit [optional]`
	Get the handle to a particular unit based on name or expression.

`Function`	`HasRetrievalErrors () as Boolean`
	Identifies if a previous call to retrieve the model resulted in errors.

`Function`	`ListCrossSections () as IpfcXSections [optional]`
	Lists the cross-sections in the solid model.

`Function`	`ListFailedFeatures () as IpfcFeatures [optional]`
	Retrieves the list of failed features in the part or assembly.

`Function`	`ListFeaturesByType (VisibleOnly as Boolean [optional], Type as IpfcFeatureType [optional]) as IpfcFeatures [optional]`
	Lists the features according to type.

`Function`	`ListGroups () as IpfcFeatureGroups`
	Collect groups (including UDFs) in the solid.

`Function`	`ListUnits (Type as IpfcUnitType [optional]) as IpfcUnits`
	Lists the units available in the model.

`Function`	`ListUnitSystems () as IpfcUnitSystems`
	Lists the unit systems available in the model.

`Sub`	`Regenerate (Instrs as IpfcRegenInstructions [optional])`
	Regenerates the solid.

`Function`	`SelectSimpRep () as IpfcSimpRep`
	Enables the user to select a simplified representation.

`Sub`	`SetPrincipalUnits (Units as IpfcUnitSystem, Options as IpfcUnitConversionOptions)`
	Sets the system of units for the solid.

Property Detail

Property AbsoluteAccuracy as Double [optional]

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

Property GeomOutline as IpfcOutline3D

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

Property IsSkeleton as Boolean

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

Exceptions thrown (but not limited to):

IpfcXToolkitNotValid - Required license not found.

Property RelativeAccuracy as Double [optional]

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

Method Detail

Sub ActivateSimpRep (SimpRep as IpfcSimpRep)

Activates the specified simplified representation.

Exceptions thrown (but not limited to):

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

Parameters:

SimpRep: The simplified representation to activate.

Function CreateCustomUnit (Name as String, ConversionFactor as IpfcUnitConversionFactor, ReferenceUnit as IpfcUnit) as IpfcUnit

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

Exceptions thrown (but not limited to):

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

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 IpfcUnit

Function CreateFeature (Instructions as IpfcFeatureCreateInstructions) as IpfcFeature

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

Function CreateImportFeat (IntfData as IpfcIntfDataSource, CoordSys as IpfcCoordSystem [optional], FeatAttr as IpfcImportFeatAttr [optional]) as IpfcFeature

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

Exceptions thrown (but not limited to):

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

IpfcXToolkitNotExist - No profile found.

IpfcXToolkitInvalidFile - profile is not readable.

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.

Function CreateLocalGroup (Members as IpfcFeatures, Name as String) as IpfcFeatureGroup

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.

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

Function CreateNote (Lines as Istringseq, Owner as IpfcModelItem [optional]) as IpfcModelItem

Parameters:

Lines
Owner

Returns:

Function CreateSimpRep (Instructions as IpfcCreateNewSimpRepInstructions) as IpfcSimpRep

Creates a simplified representation based on the supplied instructions.

Parameters:

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

Returns:: The handle to the new simplified representation.

Function CreateUDFGroup (Instructions as IpfcUDFGroupCreateInstructions) as IpfcFeatureGroup

Creates a FeatureGroup, based on the instructions provided.

Exceptions thrown (but not limited to):

IpfcXToolkitUnsupported - The input model is Multi-CAD model.

Parameters:

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

Returns:: The created UDF group.

Function CreateUnitSystem (Name as String, Type as IpfcUnitSystemType, Units as IpfcUnits) as IpfcUnitSystem

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):

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

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 IpfcUnitSystem

Sub DeleteSimpRep (SimpRep as IpfcSimpRep)

Deletes the specified simplified representation from its owner model.

Parameters:

SimpRep: The simplified representation to delete.

Function EvalOutline (Trf as IpfcTransform3D [optional], ExcludeTypes as IpfcModelItemTypes [optional]) as IpfcOutline3D

Computes the outline of a solid.

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

Sub ExecuteFeatureOps (Ops as IpfcFeatureOperations, Instrs as IpfcRegenInstructions [optional])

Performs the specified feature operations.

This method is not supported in No-Resolve mode (default regeneration mode in Creo Elements/Pro). It will throw IpfcXToolkitBadContext, 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):

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

IpfcXToolkitSuppressedParents - Suppressed parents were found.

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

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.

Sub ExportShrinkwrap (Instructions as IpfcShrinkwrapExportInstructions)

Exports a solid model to shrinkwrap format.

Exceptions thrown (but not limited to):

IpfcXToolkitBadContext - Invalid combination of input arguments.

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

Parameters:

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

Function GetActiveSimpRep () as IpfcSimpRep

Returns the current active simplified representation.

Returns:: The current active simplified representation

Function GetCrossSection (Name as String) as IpfcXSection [optional]

Returns a cross-section object, given its name.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - Model doesn't have 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.

Function GetDefaultBody () as IpfcSolidBody

Returns the default body of the solid.

Returns:: The default solid body object.

Function GetEdgeSolidBody (thisEdge as IpfcEdge) as IpfcSolidBody

Returns the body to which the edge belongs.

Parameters:

thisEdge: The edge whose solid body is sought.

Returns:: The solid body object.

Function GetFeatureById (Id as Long) as IpfcFeature [optional]

Retrieves the specified feature, given its identifier.

Exceptions thrown (but not limited to):

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

Parameters:

Id: The feature identifier

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

Function GetFeatureByName (Name as String) as IpfcFeature [optional]

Locates the feature object, given its name.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - 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.

Function GetGeomRep () as IpfcSimpRep

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

Exceptions thrown (but not limited to):

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

See Also:: IpfcSolid.GetSimpRep(), IpfcSolid.GetGraphicsRep(), IpfcSolid.GetMasterRep(), IpfcSimpRep.GetSimpRepType()

Returns:: An object representing the Geometry Rep.

Function GetGraphicsRep () as IpfcSimpRep

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

Exceptions thrown (but not limited to):

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

See Also:: IpfcSolid.GetSimpRep(), IpfcSolid.GetGeomRep(), IpfcSolid.GetMasterRep(), IpfcSimpRep.GetSimpRepType()

Returns:: An object representing the Graphics Rep.

Function GetMassProperty (CoordSysName as String [optional]) as IpfcMassProperty

Gets the mass properties for the solid.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The specified coordinate system was not found.

Parameters:

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

Returns:

Function GetMassPropertyWithDensity (CoordSysName as String [optional], DensityOpt as IpfcMPDensityUse, density as Double [optional]) as IpfcMassProperty

Parameters:

CoordSysName
DensityOpt
density

Returns:

Function GetMasterRep () as IpfcSimpRep

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

Exceptions thrown (but not limited to):

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

See Also:: IpfcSolid.GetSimpRep(), IpfcSolid.GetGraphicsRep(), IpfcSolid.GetGeomRep(), IpfcSimpRep.GetSimpRepType()

Returns:: An object representing the Master Rep.

Function GetPrincipalUnits () as IpfcUnitSystem

Gets the system of units assigned to the solid model.

Returns:: The unit system.

Function GetSimpRep (SimpRepName as String) as IpfcSimpRep

Returns the handle to the specified simplified representation.

Exceptions thrown (but not limited to):

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

Parameters:

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

Returns:

Function GetSurfaceSolidBody (thisSurf as IpfcSurface) as IpfcSolidBody

Returns the body to which the surface belongs.

Parameters:

thisSurf: The surface whose solid body is sought.

Returns:: The solid body object.

Function GetUnit (Name as String, ByExpression as Boolean [optional]) as IpfcUnit [optional]

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

Exceptions thrown (but not limited to):

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

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 IpfcUnit

Function HasRetrievalErrors () as Boolean

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):

IpfcXToolkitNotFound - Errors were not found for this model.

See Also:: IpfcBaseSession.RetrieveModel(), IpfcBaseSession.RetrieveModelWithOpts(), IpfcBaseSession.OpenFile(), IpfcBaseSession.RetrieveAssemSimpRep()

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

Function ListCrossSections () as IpfcXSections [optional]

Lists the cross-sections in the solid model.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - Model doesn't have cross-sections.

Returns:: Sequence of cross-section objects.

Function ListFailedFeatures () as IpfcFeatures [optional]

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

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

Function ListFeaturesByType (VisibleOnly as Boolean [optional], Type as IpfcFeatureType [optional]) as IpfcFeatures [optional]

Lists the features according to type.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - No failed feature was found.

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

Function ListGroups () as IpfcFeatureGroups

Collect groups (including UDFs) in the solid.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - No groups exist in the solid

Returns:: The list of groups.

Function ListUnits (Type as IpfcUnitType [optional]) as IpfcUnits

Lists the units available in the model.

Parameters:

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

Returns:: The list of units found.

Function ListUnitSystems () as IpfcUnitSystems

Lists the unit systems available in the model.

Returns:: The list of unit systems.

Sub Regenerate (Instrs as IpfcRegenInstructions [optional])

Regenerates the solid.

Regeneration in No-Resolve mode (default mode in Creo Elements/Pro) is not supported. This method will throw IpfcXToolkitBadContext, 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):

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

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

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

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.

Function SelectSimpRep () as IpfcSimpRep

Enables the user to select a simplified representation.

Exceptions thrown (but not limited to):

IpfcXToolkitUserAbort - The user aborted simplified representation selection.

Returns:: The selected simplified representation.

Sub SetPrincipalUnits (Units as IpfcUnitSystem, Options as IpfcUnitConversionOptions)

Sets the system of units for the solid.

This will regenerate the model.

Parameters:

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