Package com.comsol.model

Interface CommonList

All Superinterfaces:

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

All Known Subinterfaces:

ComponentCommonList

public interface CommonList
extends PropFeatureList<CommonFeature>, IListMove

List of common definitions features.

Method Summary

Modifier and Type	Method	Description
CommonFeature	create(java.lang.String tag, java.lang.String type)	Creates a common definitions feature.
CommonFeature	create(java.lang.String tag, java.lang.String type, java.lang.String component)	Creates a common definitions feature.
java.lang.String[][]	insert(java.lang.String filename, java.lang.String[] features, java.lang.String... password)	Insert common definitions feature from an mph file into the common list of this model 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

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

Creates a common definitions feature.

Specified by:

create in interface PropFeatureList<CommonFeature>

Parameters:

tag - Common definitions feature tags.

type - Type of common definitions feature: one of ....

Returns:

Created common definitions feature.

create

CommonFeature create(java.lang.String tag,
                     java.lang.String type,
                     java.lang.String component)

Creates a common definitions feature.

Parameters:

tag - Common definitions feature tags.

type - Type of common definitions feature: one of AmbientProperties, ....

component - Component tag.

Returns:

Created common definitions feature.

insert

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

Insert common definitions feature from an mph file into the common list of this model 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 - The file name.

features - The tags of the features to insert.

password - Optional password for opening the file.

Returns:

Results from the insert operation.