Xilinx 8.2i Life Jacket User Manual


 
88 www.xilinx.com Development System Reference Guide
Chapter 3: Tcl
R
property_name and property_value specify the property name and value for all of the
collection variables in the current ISE project. There are two available property settings for
the collection set command, they are:
display_line_limitspecifies the number of lines that can be displayed by a collection
variable. This property setting is useful for very large collections, which may have
thousands, if not millions of objects. The default value for this property is 100. The
minimum value is 0. There is no maximum value limit for this property.
display_typeinstructs Tcl to include the object type in the display of objects from any
specified collection variable. Values for this property are true and false. By default, this
option is set to false, which means object types are not displayed. See the example
below.
sizeof (show the number of objects in a collection)
The collection sizeof command returns the number of objects in the specified collection.
% collection sizeof <collection_variable>
collection is the name of the Xilinx Tcl command.
sizeof is the name of the collection subcommand.
collection variable specifies the name of the collection for Tcl to return the size of.
object (get object information)
The object command returns the name, type, or property information of any Xilinx Tcl
object in the current ISE project. You can specify a single object or an object from a
collection of objects.
% object <subcommand>
Example: % collection set display_type true
Description: In this example, the collection set command is used to set the property
name and value for all collection variables in the project.
display_type is the name of the property setting.
true specifies the value for the property.
Tcl Return: The previous value of the property.
Example: % collection sizeof $colVar
Description: In this example, the collection sizeof command is used to return the
size of the collection, which is referenced by the colVar collection
variable.
Tcl Return: An integer return of the number of items in the specified collection.