Package com.comsol.model

Interface GeomObjectSelection

All Superinterfaces:

AbstractSelection, ModelEntity, PrimitiveModelEntity

All Known Subinterfaces:

CumulativeSelection, GeomObjectGroupSelection, GeomObjectSelectionFeature, HideDraw, LocalGeomObjectSelection

public interface GeomObjectSelection
extends AbstractSelection

Geometry object selection.

Method Summary

Modifier and Type	Method	Description
GeomObjectSelection	add(java.lang.String... onames)	Adds the given objects to a selection of whole objects.
GeomObjectSelection	add(java.lang.String[] oname, int[][] entities)	Adds the entities to the selection on given objects.
GeomObjectSelection	add(java.lang.String oname, int[] entities)	Adds the entities to the selection on given object.
GeomObjectSelection	add(java.lang.String oname, int entity, int... entities)	Adds the given entities of the given object to the selection.
GeomObjectSelection	all()	Sets the selection to be (all entities of the given dimension of) all available objects.
GeomObjectSelection	all(java.lang.String oname)	Sets the selection to be all entities of the given object.
GeomObjectSelection	all(java.lang.String[] onames)	Sets the selection to be all entities of the given objects.
GeomObjectSelection	clear()	Clears all objects or entities from the selection.
GeomObjectSelection	clear(java.lang.String oname)	Clears all entities of the given object from the selection.
GeomObjectSelection	clear(java.lang.String[] onames)	Clears all entities of the given objects from the selection.
int[]	dom(java.lang.String arg0, int arg1)	Deprecated. Use entities(String, int) instead.
int[]	entities(java.lang.String oname)	If the selection selects entities, return the selected entities on the given geometry object.
int[]	entities(java.lang.String oname, int dim)	If the selection is on a geometry object, return the entities of the given dimension.
GeomObjectSelection	init()	Sets the selection to be an empty selection of whole objects.
GeomObjectSelection	init(int dim)	Sets the selection to be an empty selection of geometric entities in the specified dimension.
java.lang.String	named()	Returns named selection referred to.
GeomObjectSelection	named(java.lang.String selTag)	Let the selection refer to a named selection.
java.lang.String[]	object()	Deprecated. Use objects() instead.
GeomObjectSelection	object(java.lang.String arg0)	Deprecated. Use init() instead.
GeomObjectSelection	object(java.lang.String arg0, int arg1)	Deprecated. Use init(int) instead.
java.lang.String[]	objects()	If the selection is a set of geometry objects, return the names of the objects.
GeomObjectSelection	remove(java.lang.String... onames)	Removes the given objects from a selection of whole objects.
GeomObjectSelection	remove(java.lang.String[] onames, int[][] entities)	Removes the given entities of the given objects from the selection.
GeomObjectSelection	remove(java.lang.String oname, int[] entities)	Removes the given entities of the given object from the selection.
GeomObjectSelection	remove(java.lang.String oname, int entity, int... entities)	Removes the given entities of the given object from the selection.
GeomObjectSelection	set(java.lang.String... onames)	Sets a selection of whole objects to be the given objects.
GeomObjectSelection	set(java.lang.String[] onames, int[][] entities)	Sets the selection to be the given entities of the given objects.
GeomObjectSelection	set(java.lang.String oname, int entity)	Sets the selection on given object to be an entity.
GeomObjectSelection	set(java.lang.String oname, int[] entities)	Sets the selection to be the given entities of the given object.
GeomObjectSelection	set(java.lang.String oname, int entity, int... entities)	Sets the selection to be the given entities of the given object.

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, resolveModelPath

Method Detail

add

GeomObjectSelection add(java.lang.String... onames)

Adds the given objects to a selection of whole objects.

Parameters:

onames - Object names.

Returns:

Geometry object selection.

add

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

Adds the entities to the selection on given object.

Parameters:

oname - Object name.

entities - Entity indices.

Returns:

Geometry object selection.

add

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

Adds the entities to the selection on given objects.

Parameters:

oname - Object name.

entities - Entity indices for each object.

Returns:

Geometry object selection.

add

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

Adds the given entities of the given object to the selection.

Parameters:

oname - Object names.

entity - Entity index.

entities - Entity indices.

Returns:

Geometry object selection.

all

GeomObjectSelection all()

Sets the selection to be (all entities of the given dimension of) all available objects.

Returns:

Geometry object selection.

all

GeomObjectSelection all(java.lang.String oname)

Sets the selection to be all entities of the given object. Does not affect the selection on other objects.

Parameters:

oname - Object name.

Returns:

Geometry object selection.

all

GeomObjectSelection all(java.lang.String[] onames)

Sets the selection to be all entities of the given objects. Does not affect the selection on other objects.

Parameters:

onames - Object names.

Returns:

Geometry object selection.

clear

GeomObjectSelection clear()

Clears all objects or entities from the selection.

Returns:

Selection.

clear

GeomObjectSelection clear(java.lang.String oname)

Clears all entities of the given object from the selection.

Parameters:

oname - Object name.

Returns:

Geometry object selection.

clear

GeomObjectSelection clear(java.lang.String[] onames)

Clears all entities of the given objects from the selection.

Parameters:

onames - Object name.

Returns:

Geometry object selection.

dom

@Deprecated
int[] dom(java.lang.String arg0,
          int arg1)

Deprecated.

Use entities(String, int) instead.

entities

int[] entities(java.lang.String oname)

If the selection selects entities, return the selected entities on the given geometry object.

Parameters:

oname - Geometry object name.

Returns:

Vector of geometric entities.

entities

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

If the selection is on a geometry object, return the entities of the given dimension.

Parameters:

oname - Geometry object name.

dim - Dimension to analyze.

Returns:

Vector of geometric entities.

init

GeomObjectSelection init()

Sets the selection to be an empty selection of whole objects.

Returns:

Geometry object selection.

init

GeomObjectSelection init(int dim)

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

Parameters:

dim - Entity dimension.

Returns:

Geometry object selection.

named

java.lang.String named()

Returns named selection referred to. An empty string means that the selection is manual, that is, it does not refer to a named selection.

Returns:

Tag of named selection.

named

GeomObjectSelection named(java.lang.String selTag)

Let the selection refer to a named selection. If selTag is empty, it means that the selection becomes manual, that is, it does no longer refer to a named selection.

Parameters:

selTag - Tag of named selection.

Returns:

The selection.

object

@Deprecated
java.lang.String[] object()

Deprecated.

Use objects() instead.

object

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

Deprecated.

Use init() instead.

object

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

Deprecated.

Use init(int) instead.

objects

java.lang.String[] objects()

If the selection is a set of geometry objects, return the names of the objects.

Returns:

Vector of geometry object names.

remove

GeomObjectSelection remove(java.lang.String... onames)

Removes the given objects from a selection of whole objects.

Parameters:

onames - Object names.

Returns:

Geometry object selection.

remove

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

Removes the given entities of the given object from the selection.

Parameters:

oname - Object name.

entities - Entity indices.

Returns:

Geometry object selection.

remove

GeomObjectSelection remove(java.lang.String[] onames,
                           int[][] entities)

Removes the given entities of the given objects from the selection.

Parameters:

onames - Object names.

entities - Entity indices for each object.

Returns:

Geometry object selection.

remove

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

Removes the given entities of the given object from the selection.

Parameters:

oname - Object name.

entity - Entity index.

entities - Entity indices.

Returns:

Geometry object selection.

set

GeomObjectSelection set(java.lang.String... onames)

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

Parameters:

onames - Object names.

Returns:

Geometry object selection.

set

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

Sets the selection on given object to be an entity. Does not affect the selection on other objects.

Parameters:

oname - Object name.

entity - Entity index.

Returns:

Geometry object selection.

set

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

Sets the selection to be the given entities of the given object. Does not affect the selection on other objects.

Parameters:

oname - Object name.

entities - Entity indices.

Returns:

Geometry object selection.

set

GeomObjectSelection set(java.lang.String[] onames,
                        int[][] entities)

Sets the selection to be the given entities of the given objects. Does not affect the selection on other objects.

Parameters:

onames - Object names.

entities - Entity indices for each object.

Returns:

Geometry object selection.

set

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

Sets the selection to be the given entities of the given object. Does not affect the selection on other objects.

Parameters:

oname - Object name.

entity - Entity index.

entities - Additional entity indices.

Returns:

Geometry object selection.