View: Hide Browser | Browser on the left | Browser on the right| Dictionary
Report:General Info | Inner Elements | Relations | Attributes | Operations 

Class collection

An object of class collection represents a collection, that is, an ordered set of references to objects of class other than collection or iterator. An object is said to be a member of a collection if the collection contains a reference to the object. The maximum number of members in a collection is not specified by this standard.
A VHPI program creates a collection or appends one or more members to a collection by calling the vhpi_create function (see 21.5). The order of members in a collection is the order in which they are appended to the collection. A VHPI program may call the vhpi_create function during any phase of tool execution.
If a member of a collection ceases to exist, it ceases to be a member of the collection. The reference to the member is replaced with a null reference, that is, a reference to no object. Thus, the number of references in the collection remains unchanged.
The lifetime of a collection is the duration between its creation and the time at which a handle that refers to the collection is released.
Application context: library information model, design hierarchy information model
NOTES:
1—The VHPI information model provides no associations by which a VHPI program can navigate to a collection. A VHPI program that creates a collection should maintain a handle to the collection and release the handle when the collection is no longer required.
2—Releasing a handle to a collection does not release any handle that refers to a member of the collection.

General Info
Name collection 
Owner  stdMeta 
Base Classifier  base 
Visibility public 
Is Active false 
Is Abstract true 

Inner Elements
Name Type 
 unnamed Generalization 
 unnamed InstanceSpecification 

Relations
Name Type Begins Ends 
 unnamed Generalization  anyCollection  collection 
 unnamed Generalization  collection  base 
 unnamed Generalization  uniformCollection  collection 
 unnamed Association  collection  base 

Attributes
Name Type Classifier Default Value 
 NumMembers  IntT  collection  
 Members  base  collection  

Operations
Name Return Type Classifier 
 vhpi_create  HandleT  collection