com.comsol.model

Interface GeomObjectGroupSelection

All Superinterfaces:

AbstractSelection, GeomObjectSelection, ModelEntity, PrimitiveModelEntity

public interface GeomObjectGroupSelection
extends GeomObjectSelection

Geometry object group selection.

Method Summary

Modifier and Type	Method and Description
GeomObjectGroupSelection	add(java.lang.String... oname) Adds the given objects to the selection.
GeomObjectGroupSelection	add(java.lang.String oname, int[] entities) Adds the entities to the selection on named object.
GeomObjectGroupSelection	add(java.lang.String oname, int entity, int... entities) Adds the entities to the selection on named object.
GeomObjectGroupSelection	addGroup(int... details) Adds the specified groups to the selection.
GeomObjectGroupSelection	all(java.lang.String oname) Sets the selection to be all the entities of an object.
GeomObjectGroupSelection	clear(java.lang.String oname) Clears all entities of the given object from the selection.
int[]	group() Returns the group numbers for the selected groups.
int[]	groupEntities(int detail) Returns the entity numbers of the specified detail group.
java.lang.String[]	groupNames() Returns a list of names of the groups found.
java.lang.String	groupObject(int detail) Returns the name of the geometry object that contains the specified detail group.
GeomObjectGroupSelection	init() Sets the selection to be a selection of whole geometry objects.
GeomObjectGroupSelection	init(int dim) Sets the selection to be a selection of geometric entities in a specified dimension.
GeomObjectGroupSelection	object(java.lang.String arg0) Deprecated. Use init() instead.
GeomObjectGroupSelection	object(java.lang.String arg0, int arg1) Deprecated. Use init(int) instead.
GeomObjectGroupSelection	remove(java.lang.String... oname) Removes the given objects from the selection.
GeomObjectGroupSelection	remove(java.lang.String oname, int[] entities) Removes the entities from the selection on named object.
GeomObjectGroupSelection	remove(java.lang.String oname, int entity, int... entities) Removes the entities from the selection on named object.
GeomObjectGroupSelection	removeGroup(int... details) Removes the specified groups from the selection.
GeomObjectGroupSelection	set(java.lang.String... oname) Sets the selection to be the given objects.
GeomObjectGroupSelection	set(java.lang.String oname, int entity) Sets the selection on named object to be an entity.
GeomObjectGroupSelection	set(java.lang.String oname, int[] entities) Sets the selection on named object to be an entity.
GeomObjectGroupSelection	set(java.lang.String oname, int entity, int... entities) Sets the selection on named object to be an entity.
GeomObjectGroupSelection	setGroup(int... details) Sets the selection groups.
int	size() Returns the number of detail groups found.

Methods inherited from interface com.comsol.model.GeomObjectSelection

add, all, all, clear, clear, dom, entities, entities, named, named, object, objects, remove, set

Methods inherited from interface com.comsol.model.AbstractSelection

dim, dimension, geom

Methods inherited from interface com.comsol.model.ModelEntity

active, author, author, comments, comments, dateCreated, dateModified, docMarker, docMarker, help, help, icon, isactive, isActive, label, label, lastModifiedBy, model, model, name, name, resetAuthor, scope, tag, tag, timeCreated, timeModified, version, version

Methods inherited from interface com.comsol.model.PrimitiveModelEntity

getContainer, getDisplayString

Method Detail

add

GeomObjectGroupSelection add(java.lang.String... oname)

Adds the given objects to the selection.

Specified by:

add in interface GeomObjectSelection

Parameters:

oname - Object names.

Returns:

Geometry object group selection.

add

GeomObjectGroupSelection add(java.lang.String oname,
                             int[] entities)

Adds the entities to the selection on named object.

Specified by:

add in interface GeomObjectSelection

Parameters:

oname - Object name.

entities - Entity indices.

Returns:

Geometry object group selection.

add

GeomObjectGroupSelection add(java.lang.String oname,
                             int entity,
                             int... entities)

Adds the entities to the selection on named object.

Specified by:

add in interface GeomObjectSelection

Parameters:

oname - Object name.

entity - Entity index.

entities - Entity indices.

Returns:

Geometry object group selection.

addGroup

GeomObjectGroupSelection addGroup(int... details)

Adds the specified groups to the selection.

Parameters:

details - Specified groups.

Returns:

Geometry object group selection.

all

GeomObjectGroupSelection all(java.lang.String oname)

Sets the selection to be all the entities of an object.

Specified by:

all in interface GeomObjectSelection

Parameters:

oname - Object name.

Returns:

Geometry object group selection.

clear

GeomObjectGroupSelection clear(java.lang.String oname)

Clears all entities of the given object from the selection. Does not affect the selection on other objects.

Specified by:

clear in interface GeomObjectSelection

Parameters:

oname - Object name.

Returns:

Geometry object group selection.

group

int[] group()

Returns the group numbers for the selected groups.

Returns:

List of group numbers.

groupEntities

int[] groupEntities(int detail)

Returns the entity numbers of the specified detail group.

Parameters:

detail - Specified group.

Returns:

List of entity numbers.

groupNames

java.lang.String[] groupNames()

Returns a list of names of the groups found.

Returns:

List of names of groups.

groupObject

java.lang.String groupObject(int detail)

Returns the name of the geometry object that contains the specified detail group.

Parameters:

detail - Specified group.

Returns:

Geometry object name.

init

GeomObjectGroupSelection init()

Sets the selection to be a selection of whole geometry objects.

Specified by:

init in interface GeomObjectSelection

Returns:

Geometry object group selection.

init

GeomObjectGroupSelection init(int dim)

Sets the selection to be a selection of geometric entities in a specified dimension.

Specified by:

init in interface GeomObjectSelection

Parameters:

dim - Dimension.

Returns:

Geometry object group selection.

object

@Deprecated
GeomObjectGroupSelection object(java.lang.String arg0)

Deprecated. Use init() instead.

Specified by:

object in interface GeomObjectSelection

object

@Deprecated
GeomObjectGroupSelection object(java.lang.String arg0,
                                             int arg1)

Deprecated. Use init(int) instead.

Specified by:

object in interface GeomObjectSelection

remove

GeomObjectGroupSelection remove(java.lang.String... oname)

Removes the given objects from the selection.

Specified by:

remove in interface GeomObjectSelection

Parameters:

oname - Object names.

Returns:

Geometry object group selection.

remove

GeomObjectGroupSelection remove(java.lang.String oname,
                                int[] entities)

Removes the entities from the selection on named object.

Specified by:

remove in interface GeomObjectSelection

Parameters:

oname - Object name.

entities - Entity indices.

Returns:

Geometry object group selection.

remove

GeomObjectGroupSelection remove(java.lang.String oname,
                                int entity,
                                int... entities)

Removes the entities from the selection on named object.

Specified by:

remove in interface GeomObjectSelection

Parameters:

oname - Object name.

entity - Entity index.

entities - Entity indices.

Returns:

Geometry object group selection.

removeGroup

GeomObjectGroupSelection removeGroup(int... details)

Removes the specified groups from the selection.

Parameters:

details - Specified groups.

Returns:

Geometry object group selection.

set

GeomObjectGroupSelection set(java.lang.String... oname)

Sets the selection to be the given objects.

Specified by:

set in interface GeomObjectSelection

Parameters:

oname - Object names.

Returns:

Geometry object group selection.

set

GeomObjectGroupSelection set(java.lang.String oname,
                             int entity)

Sets the selection on named object to be an entity.

Specified by:

set in interface GeomObjectSelection

Parameters:

oname - Object name.

entity - Entity index.

Returns:

Geometry object group selection.

set

GeomObjectGroupSelection set(java.lang.String oname,
                             int[] entities)

Sets the selection on named object to be an entity.

Specified by:

set in interface GeomObjectSelection

Parameters:

oname - Object name.

entities - Entity indices.

Returns:

Geometry object group selection.

set

GeomObjectGroupSelection set(java.lang.String oname,
                             int entity,
                             int... entities)

Sets the selection on named object to be an entity.

Specified by:

set in interface GeomObjectSelection

Parameters:

oname - Object names.

entity - Entity index.

entities - Additional entity indices.

Returns:

Geometry object group selection.

setGroup

GeomObjectGroupSelection setGroup(int... details)

Sets the selection groups.

Parameters:

details - Specified groups.

Returns:

Geometry object group selection.

size

int size()

Returns the number of detail groups found.

Returns:

Number of detail groups.