Package com.comsol.model

Interface ModelNodeList

All Superinterfaces:

IListMove, java.lang.Iterable<ModelNode>, ModelEntity, ModelEntityList<ModelNode>, PrimitiveModelEntity

public interface ModelNodeList
extends ModelEntityList<ModelNode>, IListMove

List of model component nodes.

Method Summary

Modifier and Type	Method	Description
ModelNode	create(java.lang.String tag)	Creates a model component.
ModelNode	create(java.lang.String tag, boolean defineFrames)	Creates a model component node, and specifies whether all frames should be defined as separate Frame entities.
ModelNode	create(java.lang.String tag, java.lang.String type)	Creates a model component node of a given type.
ModelNode	createExtraDim(java.lang.String arg0)	Deprecated. Use create(String, String) instead.
java.lang.String[][]	insert(java.lang.String filename, java.lang.String[] components, java.lang.String... password)	Insert components from an mph file into this list and returns the result of the operation as a double string array of length 3. The first array contains the messages from insert, the second array contains paths to the inserted objects, and the third array contains paths to the inserted references.

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

clear, copy, copy, copyTo, duplicate, duplicateTo, get, index, remove, size, tags, uniquetag

Methods inherited from interface com.comsol.model.PrimitiveModelEntity

getContainer, getDisplayString, resolveModelPath

Method Detail

create

ModelNode create(java.lang.String tag)

Creates a model component.

Parameters:

tag - Model component tag.

Returns:

Created model component node.

create

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

Creates a model component node of a given type.

Parameters:

tag - Model component tag.

type - Model component type, can be "Component", "ExtraDim", or "MeshComponent".

Returns:

Created model component node.

create

ModelNode create(java.lang.String tag,
                 boolean defineFrames)

Creates a model component node, and specifies whether all frames should be defined as separate Frame entities.

Parameters:

tag - Model component tag.

defineFrames - If true, all four frames will be defined as separate Frame entities. Otherwise a single Frame will be created.

Returns:

Created model component node.

createExtraDim

@Deprecated
ModelNode createExtraDim(java.lang.String arg0)

Deprecated.

Use create(String, String) instead.

insert

java.lang.String[][] insert(java.lang.String filename,
                            java.lang.String[] components,
                            java.lang.String... password)

Insert components from an mph file into this list and returns the result of the operation as a double string array of length 3.
The first array contains the messages from insert, the second array contains paths to the inserted objects, and the third array contains paths to the inserted references. A pasted reference is an object that a inserted object refers to, and isn't necessarily contained by any of the inserted objects.

Parameters:

filename - File name.

components - components tags.

password - Optional password for opening the file.

Returns:

Results from the insert operation.