API Documentation > Interface Classes > Class pfcModelCheckCustomCheckListener
Class pfcModelCheckCustomCheckListener

# include <pfcModelCheck.h>

class pfcModelCheckCustomCheckListener
: public virtual pfcActionListener
{
xaideclare(pfcModelCheckCustomCheckListener)
...
};


Description
This interface should be extended to provide the implementation for a ModelCheck custom check.
Method Summary
Override this method to evaluate a ModelCheck externally defined check.
void
Override this method to execute a repair action on an item found by a custom check.
void
Override this method to update an item found by a custom check.
Method Detail
OnCustomCheck
(xrstring CheckName, pfcModel_ptr Mdl)
Override this method to evaluate a ModelCheck externally defined check.
Manual References:
Parameters:
CheckName
The name of the check.
Mdl
The model.
Returns:
The pfcCustomCheckResults object containing the results of the check for this model.
void
OnCustomCheckAction
(xrstring CheckName, pfcModel_ptr Mdl, optional xrstring SelectedItem)
Override this method to execute a repair action on an item found by a custom check.
Manual References:
Parameters:
CheckName
Name of the check.
Mdl
The model.
SelectedItem
Label of the item that was selected from the table, if applicable. This will match the value of string returned in the pfcCustomCheckResults object returned by pfcModelCheckCustomCheckListener::OnCustomCheck(xrstring, pfcModel_ptr). Can be null if no item was selected.
Returns:
void
OnCustomCheckUpdate
(xrstring CheckName, pfcModel_ptr Mdl, optional xrstring SelectedItem)
Override this method to update an item found by a custom check.
Manual References:
Parameters:
CheckName
Name of the check.
Mdl
The model.
SelectedItem
Label of the item that was selected from the table,if applicable. This will match the value of string returned in the pfcCustomCheckResults object returned by pfcModelCheckCustomCheckListener::OnCustomCheck(xrstring, pfcModel_ptr).
Returns:
Was this helpful?