Glyph Version 7.22.2 |
pw:: CollectionType for a group of entities Derives FromInformationIn the context of the pw::Collection, an entity refers to objects of or derived from the following types: Summary
create
This action creates a new collection object. ParametersNone ReturnsThis action returns a new pw::Collection object. set
This action sets the members of a collection. Any existing membership is cleared. Parameters
ReturnsThis action returns the pw::Collection object. add
This action adds members to a collection. Any existing membership is not changed. Parameters
ReturnsThis action returns the pw::Collection object. remove
This action removes members from a collection. Parameters
ReturnsThis action returns the pw::Collection object. contains
This action specifies if a collection contains a given entity. Parameters
ReturnsThis action returns a boolean, which is true if the entity is in the collection. getEntityCount
This action returns the number of entities in a collection. ParametersNone ReturnsThis action returns the integer entity count. do
This action performs a command on each entity in the collection. Parameters
ReturnsThis action returns a boolean, which is false if one of the commands changed the membership status of one or more entities, indicating that not all entities may have been processed. See AlsogetResult
This action obtains the results of the last do operation. Parameters
ReturnsThis action returns the command-specific result of the action on the given entity. InformationAn error is raised if the entity is not in the collection. See AlsoresultList
This action returns a list of results in a collection. ParametersNone ReturnsThis action returns the result list. Note: the order of the result list is guaranteed only to be in the same order as the list returned by list, which may not be the same as the order the objects were added to the collection. See Also |
This action creates a new collection object.
pw::Collection create
This action deletes the collection.
$collection delete
This action sets the members of a collection.
$collection set entity_list
This action adds members to a collection.
$collection add entity_list
This action removes members from a collection.
$collection remove entity_list
This action specifies if a collection contains a given entity.
$collection contains entity
This action returns a list of entity objects in a collection.
$collection list
This action returns the number of entities in a collection.
$collection getEntityCount
This action performs a command on each entity in the collection.
$collection do ?-strict? action ?args...?
This action obtains the results of the last do operation.
$collection getResult entity ?resultVar?
This action returns a list of results in a collection.
$collection resultList