Package com.comsol.model

Interface NodeGroupList

All Superinterfaces:

IListMove, java.lang.Iterable<NodeGroup>, ModelEntity, ModelEntityList<NodeGroup>, PrimitiveModelEntity, PropFeatureList<NodeGroup>

public interface NodeGroupList
extends PropFeatureList<NodeGroup>, IListMove

List of node groups.

Method Summary

Modifier and Type	Method	Description
void	clear()	Remove all groups in the list.
NodeGroup	copy(java.lang.String newTag, java.lang.String tag, java.lang.String context)	Creates a copy of an entity, inserts it in this list and assigns it to the given model node.
NodeGroup	create(java.lang.String tag)	Create a node group.
NodeGroup	create(java.lang.String tag, java.lang.String type)	Create a node group.
NodeGroup	create(java.lang.String tag, java.lang.String type, java.lang.String context)	Create a node group.
NodeGroup	duplicate(java.lang.String newTag, java.lang.String tag)	Creates a new group with tag newTag which is a duplicate of the group tagged tag.
void	remove(java.lang.String tag)	Removes a group and its members from the model.
void	ungroup(java.lang.String tag)	Removes a group but not its members.
void	ungroupAll()	Remove all groups in the list.

Methods inherited from interface com.comsol.model.IListMove

move

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

copy, copyTo, duplicateTo, get, index, size, tags, uniquetag

Methods inherited from interface com.comsol.model.PrimitiveModelEntity

getContainer, getDisplayString, resolveModelPath

Method Detail

clear

void clear()

Remove all groups in the list. Also removes all group members from the model.

Specified by:

clear in interface ModelEntityList<NodeGroup>

copy

NodeGroup copy(java.lang.String newTag,
               java.lang.String tag,
               java.lang.String context)

Creates a copy of an entity, inserts it in this list and assigns it to the given model node. The tag of the entity to copy is given as a path of tags, 'tag1/tag2/tag3' etc.

Specified by:

copy in interface ModelEntityList<NodeGroup>

Parameters:

newTag - The tag of the new entity.

tag - Tag of the entity to copy.

context - A tag of a model entity defining the context.

Returns:

The copied model entity.

create

NodeGroup create(java.lang.String tag)

Create a node group.

Parameters:

tag - Group tag.

Returns:

Created node group.

create

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

Create a node group.

Specified by:

create in interface PropFeatureList<NodeGroup>

Parameters:

tag - Group tag.

type - Group type.

Returns:

Created node group.

create

NodeGroup create(java.lang.String tag,
                 java.lang.String type,
                 java.lang.String context)

Create a node group.

Parameters:

tag - Group tag.

type - Group type.

context - A tag of a model entity defining the context.

Returns:

Created node group.

duplicate

NodeGroup duplicate(java.lang.String newTag,
                    java.lang.String tag)

Creates a new group with tag newTag which is a duplicate of the group tagged tag. The group members are also duplicated.

Specified by:

duplicate in interface ModelEntityList<NodeGroup>

Parameters:

newTag - Tag of the new group.

tag - Tag of group to duplicate.

Returns:

The new entity.

remove

void remove(java.lang.String tag)

Removes a group and its members from the model. Any member which cannot be removed is kept.

Specified by:

remove in interface ModelEntityList<NodeGroup>

Parameters:

tag - Tag of group to remove.

ungroup

void ungroup(java.lang.String tag)

Removes a group but not its members.

Parameters:

tag - Tag of group to remove.

ungroupAll

void ungroupAll()

Remove all groups in the list. The group members are not removed from the model.