EtsT_View_Model_Filter_Proc
Note: Requires OPNET Development Kit
Abstract
Callback: Called once when the user selects a view name in the View > Set Network/Subnet View menu.
Syntax
<view_model_filter_proc_name> (view_hndl, model_hndl, subnet_hndl)
| Argument | Type | Description |
|---|---|---|
view_hndl |
EtsT_View_Handle |
View to be applied. |
model_hndl |
EtsT_Model_Handle |
Model of interest. |
subnet_hndl |
EtsT_Obj_Handle |
Subnet of interest. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if the filter operation is successful; EtsC_Compcode_Failure otherwise.
Header
ets_api_view.h
Details
Model filters are implemented by the client code and should do the work of iterating over the network's objects and specifiying which objects are included in the view. If the subnet_hndl is invalid, the filter should act on the entire network; otherwise, only on the subnet.
This callback is specified in the view definition file using the tag:
model filter: <library_name> <function_name>