com.comsol.model

Interface ComponentCommonList

All Superinterfaces:

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

public interface ComponentCommonList
extends CommonList

List of common definitions features for a component.

Method Summary

Modifier and Type

Method and Description

java.lang.String[][]

insert(java.lang.String filename, java.lang.String[] features, java.lang.String... password) Insert definition features from an mph file into the common list of this component 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.CommonList

create, create

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface com.comsol.model.IListMove

move

Method Detail

insert

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

Insert definition features from an mph file into the common list of this component 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.

Specified by:

insert in interface CommonList

Parameters:

filename - The file name.

features - The tags of the definitions features to insert.

password - Optional password for opening the file.

Returns:

Results from the insert operation.