pw:: Group	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.

Static Actions

create

pw::Group create

This action creates a new group object.

Parameters

None

Returns

This action returns a new pw::Group object.

getAll

pw::Group getAll

This action gets a list of all of the current groups.

Parameters

-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.

Returns

This action returns a list of pw::Group objects.

getByName

pw::Group getByName name

This action gets a group with a given name.

Parameters

name	This parameter is the name of the group.

Returns

This action returns a pw::Group object.

Instance Attributes

EntityType

$group set/getEntityType type

This action sets the entity type of the group.

Type

This attribute is a glyph class name, one of pw::Connector, pw::Domain, pw::Block, pw::DatabaseEntity, or pw::SourceEntity

Default

The default value for this attribute is undefined.

Information

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.

Instance Actions

delete

$group delete

This action deletes this group.

Parameters

None

Returns

This action returns nothing.

addEntity

$group addEntity entity_list

This action adds one or more entities to a group.

Parameters

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>

Returns

This action returns a boolean, which is true if at least one entity was added to the group.

removeEntity

$group removeEntity entity_list

This action removes one or more entities from a group.

Parameters

entity_list

This parameter is a glyph entity or list of entities to remove from the group.

Returns

This action returns a boolean, which is true if the entities were removed from the group.

contains

$group contains entity ?entity ...?

This action returns true if the group contains an entity.

Parameters

entity

This parameter is a glyph entity.

Returns

This action returns a boolean, which is true if the group contains the entity.

getEntityCount

$group getEntityCount

This action returns the number of entities in a group.

Parameters

None

Returns

This action returns an <int>, which is the number of entities in the group.

getEntity

$group getEntity index

This action gets an entity from the group.

Parameters

index

This parameter is the index of the entity to get with the range [1, number of entities].

Returns

This action returns a pw::Connector, pw::Domain, pw::Block, pw::DatabaseEntity, or pw::SourceEntity depending on the type of group.

getEntityList

$group getEntityList

This action returns all the entities in a group as a list.

Parameters

None

Returns

This action returns a Tcl list of pw::Connector, pw::Domain, pw::Block, pw::DatabaseEntity, or pw::SourceEntity depending on the type of group.

removeAll

$group removeAll

This action removes all entities from the group.

Parameters

None

Returns

This action returns nothing.

pw::Group create

This action creates a new group object.

pw::Group getAll

This action gets a list of all of the current groups.

pw::Group getByName name

This action gets a group with a given name.

$group set/getEntityType type

This action sets the entity type of the group.

$group delete

This action deletes this group.

$group addEntity entity_list

This action adds one or more entities to a group.

$group removeEntity entity_list

This action removes one or more entities from a group.

$group contains entity ?entity ...?

This action returns true if the group contains an entity.

$group getEntityCount

This action returns the number of entities in a group.

$group getEntity index

This action gets an entity from the group.

$group getEntityList

This action returns all the entities in a group as a list.

$group removeAll

This action removes all entities from the group.

Entity type

Group type

A connector is a computationally one-dimensional grid entity, defined in the parameter space of one or more end-connected curve segments.

A domain is a computationally two-dimensional grid entity, bounded by one or more pw::Edges.

A block is a volume grid bounded by one or more pw::Faces.

Base type for all database entities

Global actions for source entities

Base type for all source entities

A boolean is represented as a 0 or 1, with 0 being false and 1 being true.