CIP C++ documentation for class "wfcModelParamActionListener"

Class wfcModelParamActionListener

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

Description

This class defines an action listener for features.

Manual References:: Action Listeners: Model Level Action listeners

Method Summary


`void`	`OnAfterParameterDelete (pfcModel_ptr Owner, xrstring Name, pfcUnit_ptr Units, pfcParamValue_ptr OldValue)`
	This is the listener method called after deleting a parameter.

`void`	`OnAfterParameterModify (pfcParameter_ptr Param, pfcUnit_ptr NewUnits, pfcParamValue_ptr NewValue, pfcUnit_ptr OldUnits, pfcParamValue_ptr OldValue)`
	This is the notification function called after a parameter is modified.

`void`	`OnBeforeParameterCreate (pfcModel_ptr Owner, xrstring Name, pfcUnit_ptr Units, pfcParamValue_ptr Value)`
	This is the notification function called before a parameter is created.

`void`	`OnBeforeParameterModify (pfcParameter_ptr Param, pfcUnit_ptr NewUnits, pfcParamValue_ptr NewValue, pfcUnit_ptr OldUnits, pfcParamValue_ptr OldValue)`
	This is the notification function called before a parameter is modified.

Method Detail

void OnBeforeParameterCreate (pfcModel_ptr Owner, xrstring Name, pfcUnit_ptr Units, pfcParamValue_ptr Value)

This is the notification function called before a parameter is created.

Manual References:: Action Listeners: Model Level Action listeners, Action Listeners: Model Level Action listeners

Parameters:

Owner: Owner of the parameter being created.
Name: Parameter name.
Units: Parameter Units.
Value: Parameter Value.

Returns:

void OnBeforeParameterModify (pfcParameter_ptr Param, pfcUnit_ptr NewUnits, pfcParamValue_ptr NewValue, pfcUnit_ptr OldUnits, pfcParamValue_ptr OldValue)

This is the notification function called before a parameter is modified.

Manual References:: Action Listeners: Model Level Action listeners, Action Listeners: Model Level Action listeners

Parameters:

Param: Parameter which is being modified.
NewUnits: New units of the parameter.
NewValue: New value of the parameter.
OldUnits: Old units of the parameter.
OldValue: Old value of the parameter.

Returns:

void OnAfterParameterModify (pfcParameter_ptr Param, pfcUnit_ptr NewUnits, pfcParamValue_ptr NewValue, pfcUnit_ptr OldUnits, pfcParamValue_ptr OldValue)

This is the notification function called after a parameter is modified.

Manual References:: Action Listeners: Model Level Action listeners, Action Listeners: Model Level Action listeners

Parameters:

Param: Parameter which is being modified.
NewUnits: New units of the parameter.
NewValue: New value of the parameter.
OldUnits: Old units of the parameter.
OldValue: Old value of the parameter.

Returns:

void OnAfterParameterDelete (pfcModel_ptr Owner, xrstring Name, pfcUnit_ptr Units, pfcParamValue_ptr OldValue)

This is the listener method called after deleting a parameter.

Manual References:: Action Listeners: Model Level Action listeners, Action Listeners: Model Level Action listeners

Parameters:

Owner: Owner of the parameter being deleted.
Name: Parameter name.
Units: Parameter Units.
OldValue

Returns: