<!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>Selection and Filter Overview</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">Selection and Filter Overview</div>
      <hr noshade="true">
      <table cellspacing="4" align="center">
         <tr valign="top">
            <td bgcolor="#f7f7f7" colspan="1" rowspan="1">
               <p class="para_td">Overview</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_code1_ht.html');return(false);">How To</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_custom_op.html');return(false);">Options</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_entities_op.html');return(false);">Related Topics</a></p>
            </td>
         </tr>
      </table><br><p class="para_topic">You can use filter and select options to specify the objects in a part to select or exclude from a checker. The %mqc_filter_func class contains the following filter functions:</p>
      <ul>
         <li>
            <p class="para_item">mqc_selectEntitiesWithFilters &mdash; gets object tags via the specified selection or filter condition.</p>
         </li>
         <li>
            <p class="para_item">mqc_collectEntitiesWithFilterOptions &mdash; collects tags of objects that satisfy filter option settings.</p>
         </li>
      </ul>
      <table border="0">
         <tr>
            <td valign="top" align="left"><img align="left" src="../graphics/note.gif" alt="Note" title="Note"></td>
            <td valign="bottom" align="left" width="100%">
               <div class="para_note">
                  <p class="para_note_body">For detailed descriptions of these functions, choose <b class="uiTerm">Analysis</b>&rarr; <b class="uiTerm">Check-Mate</b>&rarr; <b class="uiTerm">Author Tests</b>&rarr; <b class="uiTerm">Quick Reference</b>. 
                  </p>
               </div>
            </td>
         </tr>
      </table>
      <p class="para_topic">The two functions have different filtering methods which are described below.</p>
      <div class="title_division">mqc_collectEntitiesWithFilterOptions</div>
      <p class="para_division">This function specifies NX objects by type, layer, and color. The function takes six inputs. Three of the inputs are lists:</p>
      <ul>
         <li>
            <p class="para_item">$entity_types &mdash; supports all the object types on the class selection dialog. You can specify {all} for all of the object types or specify some {Line, Arc}.</p>
         </li>
         <li>
            <p class="para_item">$layer_specification &mdash; is a list of layer numbers strings or category name strings such as: {&rdquo;8, 10&ndash;12&rdquo;, &ldquo;SOLID&rdquo;}. </p>
         </li>
         <li>
            <p class="para_item">$color &mdash; supports a multiple list of RGB colors , such as {{255,0,0},{102,102,102}} or color index, such as {1,2,3}.</p>
         </li>
      </ul>
      <p class="para_division">The other three function arguments are of the Name data type and accept one of the token names Include or Exclude. These arguments are all suffixed with _mode.</p>
      <ul>
         <li>
            <p class="para_item">$entity_types_mode &mdash; uses Include to collect objects with the specified type in the $entitiy_types list. Use Exclude to collect objects without the specified types in the $entity_types list.</p>
         </li>
         <li>
            <p class="para_item">$layer_specification_mode &mdash; uses Include to collect objects on specified layers in the $layer_specification list. Use Exclude to collect objects outside of layers specified in the  $layer_specification list.</p>
         </li>
         <li>
            <p class="para_item">$colors_mode &mdash; uses Include to collect objects with the colors specified in the $color list. Use Exclude to collect objects without colors specified in the $color list.</p>
         </li>
      </ul>
      <p class="para_division">The output of the function is a list of tags that satisfy the filter settings.</p>
      <div class="title_division">mqc_selectEntitiesWithFilters</div>
      <p class="para_division">This function specifies NX objects by: type, layer, color, NX attribute name, line width, line font, and object name. The function has 16 arguments of which 14 specify filtering options. </p>
      <p class="para_division">The filtering arguments are of two types. One type selects the other excludes. The argument names have a prefix of either select_by or filter_by (for example select_by_color or filter_by_color). </p>
      <p class="para_division">Arguments with select_by include the item specified. Arguments with filter_by excludes the item specified. For example, select_by_color: {{0,255,0}} selects all green objects. But, filter_by_color: {{0,255,0}} excludes all green objects. Arguments with a select_by suffix take precedence over arguments with a filter_by suffix.</p>
      <p class="para_division">The function returns a list of tags that satisfy the filter options. See the function description for further details.</p>
   </body>
</html>