qed::check_properties (::quartus::qed)
The following table displays information for the qed::check_properties Tcl command:
Tcl Package and Version |
Belongs to ::quartus::qed 1.0 |
|||
Syntax | qed::check_properties [-h | -help] [-long_help] [-checks <checks> ] <object> | |||
Arguments | -h | -help | Short help | ||
-long_help | Long help with examples and possible return values | |||
-checks <checks> | List of Tcl expressions that evaluate to true for objects to retrieve. Expressions may use properties as variables of the same name during the check. | |||
<object> | Identifier associated with the object, must be unique | |||
Description |
Evalutes a series of expressions that operate on values of object properties and returns a boolean expression of the result of the evaluation. The "qed::check_properties" command simplifies the process of performing a conditional check on an object for a set of parameter values. The "-checks" option requires a list of Tcl expressions, even if you specify only one expression. If you specify only one expression, make the one expression a list itself as shown in the examples below. Each expression uses semantics of the Tcl "expr" command. Within each expression, access object properties with variables named according to the desired properties. Accessing object properties within expressions follows semantics of the Tcl "dict with" command. |
|||
Example Usage |
qed::create_object -type project project_A -user_data {this is some data!} qed::create_object -type group group_one -projects {project_A} # Checks for the string "this is " appearing in the # user_data property of the project_A object. # Returns: 1 qed::check_properties project_A -checks [list {"this is " in $user_data}] # Checks for the project group with ID "group_one" existing in # the groups property of the project_A object. # Returns: 1 qed::check_properties project_A -checks [list {group_one in $groups}] # Checks that the project with ID project_A does not appear in # the projects property of the group_one object. # Returns: 0 qed::check_properties group_one -checks [list {project_A ni $projects}] |
|||
Return Value | Code Name | Code | String Return | |
TCL_OK | 0 | INFO: Operation successful |