CIP C++ documentation for class "pfcFeatureActionListener"

Class pfcFeatureActionListener

# include <pfcFeature.h> class pfcFeatureActionListener : public virtual pfcActionListener { xaideclare(pfcFeatureActionListener) ... };

Description

This class defines an action listener for features.

Manual References:: Action Listeners: Creo Object TOOLKIT C++ Action Listeners, Action Listeners: Feature Level Action Listeners

Method Summary


`void`	`OnAfterCopy (pfcFeature_ptr FromFeat, pfcFeature_ptr ToFeat, pfcFeatureCopyType Type)`
	This is the listener method called after a successful feature copy.

`void`	`OnAfterRegen (pfcFeature_ptr Feat)`
	This is the notification function called after a feature has been regenerated.

`void`	`OnAfterSuppress (pfcFeature_ptr Feat)`
	This is the notification function called after a feature has been suppressed from a solid.

`void`	`OnBeforeDelete (pfcFeature_ptr Feat)`
	This is the action listener called before deleting a feature.

`void`	`OnBeforeParameterCreate (pfcFeature_ptr Owner, xrstring Name, pfcParamValue_ptr Value)`
	This is the notification function called before a parameter is created. To abort parameter creation throw exception `pfcXCancelProEAction`.

`void`	`OnBeforeParameterDelete (pfcParameter_ptr Param)`
	This is the listener method called before deleting a parameter. To abort parameter delete operation throw exception `pfcXCancelProEAction`.

`void`	`OnBeforeParameterModify (pfcParameter_ptr Param, pfcParamValue_ptr Value)`
	This is the notification function called before a parameter is modified. To abort parameter modification throw exception `pfcXCancelProEAction`.

`void`	`OnBeforeRedefine (pfcFeature_ptr Feat)`
	This is the notification function called before a feature is redefined.

`void`	`OnBeforeRegen (pfcFeature_ptr Feat)`
	This is the notification function called before a feature is regenerated.

`void`	`OnBeforeSuppress (pfcFeature_ptr Feat)`
	This is the notification function called before a feature is suppressed.

`void`	`OnRegenFailure (pfcFeature_ptr Feat)`
	This is the notification function called when a regeneration fails.

Method Detail

void OnBeforeDelete (pfcFeature_ptr Feat)

This is the action listener called before deleting a feature.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners, Action Listeners: Cancelling an ActionListener Operation

Parameters:

Feat: The feature about to be deleted

Returns:

void OnBeforeSuppress (pfcFeature_ptr Feat)

This is the notification function called before a feature is suppressed.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners, Action Listeners: Cancelling an ActionListener Operation

Parameters:

Feat: The feature to be suppressed

Returns:

void OnAfterSuppress (pfcFeature_ptr Feat)

This is the notification function called after a feature has been suppressed from a solid.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners

Parameters:

Feat: The feature that was suppressed

Returns:

void OnBeforeRegen (pfcFeature_ptr Feat)

This is the notification function called before a feature is regenerated.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners

Parameters:

Feat: The feature to be regenerated

Returns:

void OnAfterRegen (pfcFeature_ptr Feat)

This is the notification function called after a feature has been regenerated.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners

Parameters:

Feat: The feature that was just regenerated

Returns:

void OnRegenFailure (pfcFeature_ptr Feat)

This is the notification function called when a regeneration fails.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners

Parameters:

Feat: The feature whose regeneration failed

Returns:

void OnBeforeRedefine (pfcFeature_ptr Feat)

This is the notification function called before a feature is redefined.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners, Action Listeners: Cancelling an ActionListener Operation

Parameters:

Feat: The feature to be redefined

Returns:

void OnAfterCopy (pfcFeature_ptr FromFeat, pfcFeature_ptr ToFeat, pfcFeatureCopyType Type)

This is the listener method called after a successful feature copy.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners

Parameters:

FromFeat: Feature to be copied
ToFeat: Target for copied feature
Type: Type of feature copy, for example, using the same references, flipped to a miror image, and so on.

Returns:

void OnBeforeParameterCreate (pfcFeature_ptr Owner, xrstring Name, pfcParamValue_ptr Value)

This is the notification function called before a parameter is created. To abort parameter creation throw exception pfcXCancelProEAction.

Manual References:: Action Listeners: Cancelling an ActionListener Operation

Parameters:

Owner: Owner feature of parameter.
Name: Name of the parameter.
Value: Value of the parameter.

Returns:

void OnBeforeParameterModify (pfcParameter_ptr Param, pfcParamValue_ptr Value)

This is the notification function called before a parameter is modified. To abort parameter modification throw exception pfcXCancelProEAction.

Parameters:

Param: Name of the parameter.
Value: Value of the parameter.

Returns:

void OnBeforeParameterDelete (pfcParameter_ptr Param)

This is the listener method called before deleting a parameter. To abort parameter delete operation throw exception pfcXCancelProEAction.

Manual References:: Action Listeners: Feature Level Action Listeners, Action Listeners: Feature Level Action Listeners, Action Listeners: Cancelling an ActionListener Operation

Parameters:

Param: Parameter to be deleted

Returns: