CIP C++ documentation for class "pfcRegenInstructions"

Class pfcRegenInstructions

# include <pfcSolid.h> class pfcRegenInstructions : public virtual xobject { xdeclare(pfcRegenInstructions) ... }; This is a COMPACT class.

Description

This class describes the instructions for regenerating the solid.

Manual References:: Features: Feature Operations, Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Direct Known Subclasses:: wfcWRegenInstructions

Method Summary


`static pfcRegenInstructions_ptr`	`Create (optional xbool AllowFixUI, optional xbool ForceRegen, optional pfcFeature_ptr FromFeat)`
	Creates a new RegenInstructions object.

`xbool`	`GetAllowFixUI ()`
`void`	`SetAllowFixUI (xbool value)`
	If this is `true`, the Fix Model interface is displayed if there is an error.

`xbool`	`GetForceRegen ()`
`void`	`SetForceRegen (xbool value)`
	Forces the solid to fully regenerate. This will regenerate every feature in the solid. If not set, Creo Parametric uses its internal algorithm to determine which features to regenerate.

`optional pfcFeature_ptr`	`GetFromFeat ()`
`void`	`SetFromFeat (optional pfcFeature_ptr value)`
	Not used. Reserved for the future.

`xbool`	`GetRefreshModelTree ()`
`void`	`SetRefreshModelTree (xbool value)`
	If this is `true`, refresh the Creo Parametric Model Tree after the regeneration. If this is `false` (the default) the tree is not refreshed. A model must be active to use this attribute.

`xbool`	`GetResolveModeRegen ()`
`void`	`SetResolveModeRegen (xbool value)`
	Regenerate in resolve mode

`xbool`	`GetResumeExcludedComponents ()`
`void`	`SetResumeExcludedComponents (xbool value)`
	Enables Creo Parametric to resume available excluded components of the simplified representation during regeneration. This can result in a more accurate update of the simplified representation.

`xbool`	`GetUpdateAssemblyOnly ()`
`void`	`SetUpdateAssemblyOnly (xbool value)`
	Updates assembly and sub-assembly placements and regenerates assembly features and intersected parts. If the affected assembly is retrieved as a simplified representation, this flag will update the locations of the components.If the flag is not set, the component locations are not updated by default when the simplified representation is retrieved.

`xbool`	`GetUpdateInstances ()`
`void`	`SetUpdateInstances (xbool value)`
	Updates instances of the solid in memory. This may slow down the regeneration process.

Method Detail

`xbool`	`GetAllowFixUI`	`()`
`void`	`SetAllowFixUI`	`(xbool value)`

If this is true, the Fix Model interface is displayed if there is an error.

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

`xbool`	`GetForceRegen`	`()`
`void`	`SetForceRegen`	`(xbool value)`

Forces the solid to fully regenerate. This will regenerate every feature in the solid. If not set, Creo Parametric uses its internal algorithm to determine which features to regenerate.

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

`xbool`	`GetResumeExcludedComponents`	`()`
`void`	`SetResumeExcludedComponents`	`(xbool value)`

Enables Creo Parametric to resume available excluded components of the simplified representation during regeneration. This can result in a more accurate update of the simplified representation.

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

`xbool`	`GetUpdateAssemblyOnly`	`()`
`void`	`SetUpdateAssemblyOnly`	`(xbool value)`

Updates assembly and sub-assembly placements and regenerates assembly features and intersected parts. If the affected assembly is retrieved as a simplified representation, this flag will update the locations of the components.If the flag is not set, the component locations are not updated by default when the simplified representation is retrieved.

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

`xbool`	`GetUpdateInstances`	`()`
`void`	`SetUpdateInstances`	`(xbool value)`

Updates instances of the solid in memory. This may slow down the regeneration process.

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

`xbool`	`GetResolveModeRegen`	`()`
`void`	`SetResolveModeRegen`	`(xbool value)`

Regenerate in resolve mode

Allows temporary override of default settings controlling regeneration behavior.

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

`optional pfcFeature_ptr`	`GetFromFeat`	`()`
`void`	`SetFromFeat`	`(optional pfcFeature_ptr value)`

Not used. Reserved for the future.

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

`xbool`	`GetRefreshModelTree`	`()`
`void`	`SetRefreshModelTree`	`(xbool value)`

If this is true, refresh the Creo Parametric Model Tree after the regeneration. If this is false (the default) the tree is not refreshed. A model must be active to use this attribute.

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

static pfcRegenInstructions_ptr Create (optional xbool AllowFixUI, optional xbool ForceRegen, optional pfcFeature_ptr FromFeat)

Creates a new RegenInstructions object.

Manual References:: Solid: Regenerating a Solid

Parameters:

AllowFixUI: If this is true, the Fix Model interface is displayed if there is an error. If this is false, the Fix Model interface is not displayed. (If null is passed, false is assumed.)
ForceRegen: Reserved for the future. Pass null.
FromFeat: Reserved for the future. Pass null.

Returns:: The new RegenInstructions object