<HTML><HEAD><link type="text/css" href="../css/main_styles.css" rel="stylesheet"></HEAD>
<BODY><TITLE>%mqc_check_single_entity_color</TITLE><H1>%mqc_check_single_entity_color </H1><P CLASS="Paragraph">Classname: <B>%mqc_check_single_entity_color </B></P><P CLASS="Paragraph">Inherits from: <B><A href=..\checkmate\xug_base_checker.html>%ug_base_checker </A></B></P><PRE STYLE=\"text-align : left;\" CLASS=\"Code\"> </PRE><PRE STYLE=\"text-align : left;\" CLASS=\"Code\">
<B>Description:</B>
    Validate the entity color
Parameters:
    (List)   entity_type:              - Type of entity to check
                                         Set one or more from the following list:
                                         {  VIEW_DEPENDENT_GEOMETRY,  DIMENSION, _CURVE, LINE, ARC,
                                            CONIC, SPLINE, SKETCH, SOLID, SOLID_BODY, SHEET_BODY,
                                            FACETED_BODY, COMPONENT, DATUM, DATUM_PLANE, DATUM_AXIS,
                                            _POINT, CSYS, DRAFTING_ENTITY, _GROUP, PLANE, PATTERN,
                                            PATTERN_POINTS, FOREIGN_ENTITY };
                                         This is the mandatory parameter for the checker.
    (Integer) color:                   - Color options:
                                         { Blue, Green, Cyan, Red, Magenta,
                                           Yellow, White, Olive, Pink, Brown,
                                           Orange, Purple, Dark_red, Aquamarine, Gray }.
                                         This is the mandatory parameter for the checker.
      (Boolean)  disabled?             - If it is true, the checker is disabled.
                                         Default is False.
      (Boolean)  save_log_in_part      - The flag indicates whether the checking results can
                                         be saved to the part file
                                         Default is True.
    (Integer) log_type:                - Indicate which logging type to use to report
                                         the violation
                                           1 - log error
                                           2 - log warning
                                           3 - log information
                                         The default value is 1 which is to log error.
    (String)  log_msg:                 - User defined message to be added when the system
                                         reports the violation.
                                         The default is an empty string.
Results:
   PASS    -- if all specified type entities' color settings are correct
   FAILED  -- if any specified type entitiy's color is not correct

<B>See Also:</B>
   %mqc_check_multi_entity_color
============================================================================================
Create a new checker from this template by providing the mandatory parameters:
   1. (Must) change the class name and the category name
   2. (Must) specify the Entity Type / Entity Color mapping rules:
        (List)      entity_type: {SOLID,SOLID_BODY};
        (Integer)   color:1;
   3. (Optional) change log type:
        (Integer)    log_type:   1;
=============================================================================================
</PRE><PRE><FONT COLOR= blue>DefClass: %mqc_check_single_entity_color( %ug_base_checker );
</FONT></PRE><PRE STYLE=\"text-align : left;\" CLASS=\"Code\">  Check-Mate attributes and parameters </PRE><DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\"><FONT COLOR=blue>   ( String )               %test_category: "Template.File Structure";
   ( String )               %displayed_name: "Check Single Entity / Color Mapping";
   
</SPAN></FONT></PRE></DIV><DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\"><FONT COLOR=blue>   ( Boolean Parameter )    disabled?: false;
   ( Boolean Parameter )    save_log_in_part: true;
</SPAN></FONT></PRE></DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\">  checker parameters </PRE><DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\"><FONT COLOR=blue>   ( List )                 entity_type_init: {  VIEW_DEPENDENT_GEOMETRY,  DIMENSION, _CURVE, LINE, ARC, CONIC, SPLINE, SKETCH, SOLID, SOLID_BODY, SHEET_BODY, FACETED_BODY,
                                                  COMPONENT, DATUM, DATUM_PLANE, DATUM_AXIS, _POINT, CSYS, DRAFTING_ENTITY,
                                                  _GROUP, PLANE, PATTERN, PATTERN_POINTS, FOREIGN_ENTITY };
   ( String )               entity_type_label:  "Entity Type" ;

</SPAN></FONT></PRE></DIV><DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\"><FONT COLOR=blue>   ( List Parameter )       entity_type: {};
   ( Integer Parameter )              color: 0;
</SPAN></FONT></PRE></DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\">  parameter for log_option                                       </PRE><DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\"><FONT COLOR=blue>   ( List )                           color_option:
                                      {
                                          Blue      ,
                                          Green     ,
                                          Cyan      ,
                                          Red       ,
                                          Magenta   ,
                                          Yellow    ,
                                          White     , 
                                          Olive     ,
                                          Pink      ,
                                          Brown     ,
                                          Orange    ,
                                          Purple    ,
                                          Dark_red  ,
                                          Aquamarine,
                                          Gray      
                                      };
   ( String )                         color_label: "Entity Color";

                                            
</SPAN></FONT></PRE></DIV><DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\"><FONT COLOR=blue>   ( Integer Parameter )    log_type: 1;
</SPAN></FONT></PRE></DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\">  parameter for log_message     </PRE><DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\"><FONT COLOR=blue>   ( List )                 log_type_option: { LOG_ERROR, LOG_WARNING, LOG_INFO };
   ( String )               log_type_label: "Log Option";
</SPAN></FONT></PRE></DIV><DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\"><FONT COLOR=blue>   ( String Parameter )     log_msg: "";
</SPAN></FONT></PRE></DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\">  Attribute for check rules:</PRE><DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\"><FONT COLOR=blue>   ( String )               log_msg_label: "Log Message";

</SPAN></FONT></PRE></DIV><DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\"><FONT COLOR=blue>   ( List ) rules_to_check:
   
            If -empty?(entity_type:) & -(color: = 0)
            
            Then
                { { entity_type:, color: } }
                
            Else{};
           
</SPAN></FONT></PRE></DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\">  Checking...</PRE><DIV><PRE STYLE=\"text-align : left;\" CLASS=\"Code\"><FONT COLOR=blue>   ( Any Uncached ) do_check:

                    If empty?(rules_to_check:)

                    Then
                        ug_mqc_empty_param_warning()

                    Else loop
                    {
                       for $i from 1 to length(rules_to_check:);
                       for $each_rule in rules_to_check:;
                     
                       do ug_mqc_checkEntityColor( second($each_rule), 
                                                first($each_rule), 
                                                Nth( log_type:, log_type_option: ), 
                                                log_msg: );
                    };

</SPAN></FONT></PRE></DIV></TABLE><p class=EndLine>&nbsp;</p><p class=blank>&nbsp;</p></BODY></HTML>