com.comsol.model

Interface AbstractSelection

All Superinterfaces:

ModelEntity, PrimitiveModelEntity

All Known Subinterfaces:

CumulativeSelection, GeomObjectGroupSelection, GeomObjectSelection, GeomObjectSelectionFeature, HideDraw, HideGeom, HideMesh, LocalGeomObjectSelection, LocalSelection, MeshSelection, SavePointHideGeom, SavePointSelection, Selection, SelectionFeature, XDLocalSelection

public interface AbstractSelection
extends ModelEntity

Base class for all selections.

Method Summary

Modifier and Type	Method and Description
int[]	dimension() If the selection is on a geometry, returns the dimensions where the selection applies.
int[]	dom(int arg0) Deprecated. Use entities(int) instead.
int[]	dom(java.lang.String arg0, int arg1) Deprecated. Use entities(String, int) instead.
int[]	entities(int dim) If the selection is on a geometry, return the geometric entities on the given dimension.
int[]	entities(java.lang.String oname, int dim) If the selection is on a geometry object, return the entities of the given dimension.
java.lang.String	geom() Returns the geometry tag of the selection as a string.
int[]	interiordom(int arg0) Deprecated. Use interiorEntities(int) instead.
int[]	interiorEntities(int dim) If the selection is on a geometry, return the interior entities of the given dimension.
boolean	isgeom() Deprecated. Use isGeom() instead.
boolean	isGeom() Returns true if the selection is a whole geometry.
boolean	isglobal() Deprecated. Use isGlobal() instead.
boolean	isGlobal() Returns true if the selection is global.
boolean	isinheriting() Deprecated. Use isInheriting() instead.
boolean	isInheriting() Returns true if the selection is inherited to lower dimension levels.
java.lang.String[]	object() Deprecated. Use objects() instead.
java.lang.String[]	objects() If the selection is a set of geometry objects, return the names of the objects.

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

dimension

int[] dimension()

If the selection is on a geometry, returns the dimensions where the selection applies.

Returns:

Integer array with dimensions.

dom

@Deprecated
int[] dom(int arg0)

Deprecated. Use entities(int) instead.

dom

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

Deprecated. Use entities(String, int) instead.

entities

int[] entities(int dim)

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

Parameters:

dim - Dimension to analyze.

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.

geom

java.lang.String geom()

Returns the geometry tag of the selection as a string. Returns null if the selection is global.

Returns:

Geometry tag or null.

interiorEntities

int[] interiorEntities(int dim)

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

Parameters:

dim - Dimension to analyze.

Returns:

List of interior entities.

interiordom

@Deprecated
int[] interiordom(int arg0)

Deprecated. Use interiorEntities(int) instead.

isGeom

boolean isGeom()

Returns true if the selection is a whole geometry.

Returns:

true if a whole geometry.

isGlobal

boolean isGlobal()

Returns true if the selection is global.

Returns:

true if a global selection.

isInheriting

boolean isInheriting()

Returns true if the selection is inherited to lower dimension levels.

Returns:

true if the selection is inherited.

isgeom

@Deprecated
boolean isgeom()

Deprecated. Use isGeom() instead.

isglobal

@Deprecated
boolean isglobal()

Deprecated. Use isGlobal() instead.

isinheriting

@Deprecated
boolean isinheriting()

Deprecated. Use isInheriting() instead.

object

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

Deprecated. Use objects() 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.