<!DOCTYPE html
  PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<!--
Copyright (c) 2006 UGS Corp.

All Rights Reserved.

This software and related documentation are proprietary to UGS Corp.
-->
<html>
   <head>
      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
      <title>Filter Code Customization Options</title>
      <script language="javaScript">
        abridged="false";
        displayConditions=new Array();
      </script>
      <link type="text/css" href="../css/main_styles.css" rel="stylesheet">
   </head>
   <body class="bodydocs" onload="top.pageLoader()" bgcolor="#FFFFFF">
      <div class="title_topic4" id="xps10_pagetitle">Filter Code Customization Options</div>
      <hr noshade="true">
      <table cellspacing="4" align="center">
         <tr valign="top">
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td"><a class="links" href="javascript:void(0)" onclick="top.openFile('checkmate/filter_ov.html');return(false);">Overview</a></p>
            </td>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td"><a class="links" href="javascript:void(0)" onclick="top.openFile('checkmate/filter_code_list_ht.html');return(false);">How To</a></p>
            </td>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td">Options </p>
            </td>
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td"><a class="links" href="javascript:void(0)" onclick="top.openFile('checkmate/filter_entities_op.html');return(false);">Related Topics</a></p>
            </td>
         </tr>
      </table><br><p class="para_topic">There are special attributes that you can include in your filter checker code that provides you with a <b class="uiTerm">Specify Filters</b> option on the <b class="uiTerm">Customization</b> dialog of the Check-Mate <b class="uiTerm">Tests</b> tab.
      </p>
      <p class="para_topic">When you click this option, a<b class="uiTerm"> Filter for Entities</b> dialog starts and provides filter options for an NX object's type, layer, and color.
      </p>
      <p class="para_topic">You declare these attributes as follows in your checker code:</p><pre class="indent">   ( List Parameter )    entities: {};
   ( String )            entities_label: &quot;Entity Filter&quot;;
   ( Name Parameter )    entities_type_mode: Include;
   ( List Parameter )    entities_type_filter: {all};
   ( Name Parameter )    entities_layer_mode: Include;
   ( List Parameter )    entities_layer_filter: {all};
   ( Name Parameter )    entities_color_mode: Include;
   ( List Parameter )    entities_color_filter: {all};
</pre><p class="para_topic">You pass the last six of these eight attributes into the mqc_collectEntitiesWithFilterOptions function as follows:</p><pre class="indent">       $specified_entities  &lt;&lt; mqc_collectEntitiesWithFilterOptions( 
                                 entities_type_mode:,  entities_type_filter:,
                                 entities_layer_mode:, entities_layer_filter:,
                                 entities_color_mode:, entities_color_filter: );</pre><p class="para_topic"><code>$specified_entities  &lt;&lt; mqc_collectEntitiesWithFilterOptions(                                   entities_type_mode:,  entities_type_filter:,                                  entities_layer_mode:, entities_layer_filter:,                                  entities_color_mode:, entities_color_filter: );</code></p>
   </body>
</html>