Package com.comsol.model

Interface NodeGroup

All Superinterfaces:

java.lang.Iterable<ModelEntity>, ModelEntity, PrimitiveModelEntity, PropFeature, SelectionContainer, SelectionEntity

public interface NodeGroup
extends PropFeature, java.lang.Iterable<ModelEntity>

Node group.

Method Summary

Modifier and Type	Method	Description
ModelEntity	active(boolean flag)	Makes the group members active or inactive.
NodeGroup	add(java.lang.String tag)	Adds a model entity to the group.
NodeGroup	add(java.lang.String type, java.lang.String tag)	Adds a model entity to the group.
NodeGroup	create(java.lang.String tag)	Create a node group.
NodeGroupList	feature()	Returns all the sub node groups.
NodeGroup	feature(java.lang.String tag)	Returns sub-node group with correct tag.
ModelEntity	get(int index)	Returns the group member at the given position.
ModelEntity	getAfter()	Returns the model entity which this group is placed after.
java.lang.String[]	members()	Returns the tags of the group members.
java.lang.String[]	members(java.lang.String type)	Returns the tags of the group members of the specified type.
NodeGroup	placeAfter(java.lang.String tag)	Places the group after another entity.
NodeGroup	placeAfter(java.lang.String type, java.lang.String tag)	Places the group after another entity.
NodeGroup	remove(java.lang.String tag, boolean moveBefore)	Removes a model entity from the group.
NodeGroup	remove(java.lang.String type, java.lang.String tag, boolean moveBefore)	Removes a model entity from the group.
int	size()	Returns the number of group members.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface com.comsol.model.ModelEntity

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

Methods inherited from interface com.comsol.model.PropFeature

getAllowedPropertyValues, getBoolean, getBoolean, getBoolean, getBooleanArray, getBooleanMatrix, getDouble, getDouble, getDouble, getDoubleArray, getDoubleMatrix, getEntryKeyIndex, getEntryKeys, getInt, getInt, getInt, getIntArray, getIntMatrix, getReferenceArray, getString, getString, getString, getString, getStringArray, getStringMatrix, getType, getValueType, hasProperty, hasSelection, move, move, properties, remove, remove, selection, set, set, set, set, set, set, set, set, set, set, set, set, setEntry, setEntry, setEntry, setEntry, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex

Methods inherited from interface com.comsol.model.SelectionEntity

selection

Method Detail

active

ModelEntity active(boolean flag)

Makes the group members active or inactive. If inactivating, members which cannot be inactivated are ignored.

Specified by:

active in interface ModelEntity

Parameters:

flag - true: make active; false: make inactive.

Returns:

Model entity.

add

NodeGroup add(java.lang.String tag)

Adds a model entity to the group.

Parameters:

tag - The tag of the entity to add.

Returns:

The node group.

add

NodeGroup add(java.lang.String type,
              java.lang.String tag)

Adds a model entity to the group.

Parameters:

type - The model entity type.

tag - The tag of the entity to add.

Returns:

The node group.

create

NodeGroup create(java.lang.String tag)

Create a node group.

Parameters:

tag - Group tag.

Returns:

Created node group.

feature

NodeGroupList feature()

Returns all the sub node groups.

Returns:

List of node groups.

feature

NodeGroup feature(java.lang.String tag)

Returns sub-node group with correct tag.

Parameters:

tag - NodeGroup tag.

Returns:

NodeGroup.

get

ModelEntity get(int index)

Returns the group member at the given position.

Parameters:

index - The position among the members.

Returns:

Group member at the given position.

getAfter

ModelEntity getAfter()

Returns the model entity which this group is placed after. If null is returned, the group is placed before the first model entity.

Returns:

A model entity or null.

members

java.lang.String[] members()

Returns the tags of the group members. If there are members of more than one type, the members of the same type as the first member are returned. Use members(String) to get the members of a specific type.

Returns:

Entity tags.

members

java.lang.String[] members(java.lang.String type)

Returns the tags of the group members of the specified type.

Parameters:

type - The model entity type.

Returns:

Entity tags.

placeAfter

NodeGroup placeAfter(java.lang.String tag)

Places the group after another entity.

Parameters:

tag - The tag of the entity to place the group after. To place the group before the first entity use null or an empty string as tag.

Returns:

The node group.

placeAfter

NodeGroup placeAfter(java.lang.String type,
                     java.lang.String tag)

Places the group after another entity.

Parameters:

type - The model entity type.

tag - The tag of the entity to place the group after. To place the group before the first entity use null or an empty string as tag.

Returns:

The node group.

remove

NodeGroup remove(java.lang.String tag,
                 boolean moveBefore)

Removes a model entity from the group.

Parameters:

tag - The tag of the entity to remove.

moveBefore - Whether to move the entity before or after the other members of the group.

Returns:

The node group.

remove

NodeGroup remove(java.lang.String type,
                 java.lang.String tag,
                 boolean moveBefore)

Removes a model entity from the group.

Parameters:

type - The model entity type.

tag - The tag of the entity to remove.

moveBefore - Whether to move the entity before or after the other members of the group.

Returns:

The node group.

size

int size()

Returns the number of group members.

Returns:

Number of entities.