Group type
pw:: | Group type |
Static Actions | |
create | This action creates a new group object. |
getAll | This action gets a list of all of the current groups. |
getByName | This action gets a group with a given name. |
Instance Attributes | |
EntityType | This action sets the entity type of the group. |
Instance Actions | |
delete | This action deletes this group. |
addEntity | This action adds one or more entities to a group. |
removeEntity | This action removes one or more entities from a group. |
contains | This action returns true if the group contains an entity. |
getEntityCount | This action returns the number of entities in a group. |
getEntity | This action gets an entity from the group. |
getEntityList | This action returns all the entities in a group as a list. |
removeAll | This action removes all entities from the group. |
pw::Group create
This action creates a new group object.
None
This action returns a new pw::Group object.
pw::Group getAll
This action gets a list of all of the current groups.
-type groupType | This optional parameter is used to filter the result groups to a specific type. groupType must be one of pw::Connector, pw::Domain, pw::Block, pw::DatabaseEntity, or pw::Source. |
This action returns a list of pw::Group objects.
pw::Group getByName name
This action gets a group with a given name.
name | This parameter is the name of the group. |
This action returns a pw::Group object.
$group set/getEntityType type
This action sets the entity type of the group.
This attribute is a glyph class name, one of pw::Connector, pw::Domain, pw::Block, pw::DatabaseEntity, or pw::SourceEntity
The default value for this attribute is undefined.
The entity type must be set before any entities can be added to the group. If the entity type has not been set, getEntityType will result in an error.
$group addEntity entity_list
This action adds one or more entities to a group.
entity_list | This parameter is a glyph entity or list of entities to add to the group and must be of the type specified by <setEntityType> |
This action returns a boolean, which is true if at least one entity was added to the group.
$group removeEntity entity_list
This action removes one or more entities from a group.
entity_list | This parameter is a glyph entity or list of entities to remove from the group. |
This action returns a boolean, which is true if the entities were removed from the group.
$group contains entity ?entity ...?
This action returns true if the group contains an entity.
entity | This parameter is a glyph entity. |
This action returns a boolean, which is true if the group contains the entity.
$group getEntity index
This action gets an entity from the group.
index | This parameter is the index of the entity to get with the range [1, number of entities]. |
This action returns a pw::Connector, pw::Domain, pw::Block, pw::DatabaseEntity, or pw::SourceEntity depending on the type of group.
$group getEntityList
This action returns all the entities in a group as a list.
None
This action returns a Tcl list of pw::Connector, pw::Domain, pw::Block, pw::DatabaseEntity, or pw::SourceEntity depending on the type of group.
This action creates a new group object.
pw::Group create
This action gets a list of all of the current groups.
pw::Group getAll
This action gets a group with a given name.
pw::Group getByName name
This action sets the entity type of the group.
$group set/getEntityType type
This action deletes this group.
$group delete
This action adds one or more entities to a group.
$group addEntity entity_list
This action removes one or more entities from a group.
$group removeEntity entity_list
This action returns true if the group contains an entity.
$group contains entity ?entity ...?
This action returns the number of entities in a group.
$group getEntityCount
This action gets an entity from the group.
$group getEntity index
This action returns all the entities in a group as a list.
$group getEntityList
This action removes all entities from the group.
$group removeAll