Package com.comsol.model

Interface FunctionFeatureList

All Superinterfaces:

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

All Known Subinterfaces:

CapeOpenFeatureList, ComponentFunctionFeatureList, ThermodynamicsFeatureList

public interface FunctionFeatureList
extends PropFeatureList<FunctionFeature>, IListMove

List of functions.

Method Summary

Modifier and Type	Method	Description
FunctionFeature	create(java.lang.String tag, java.lang.String oper)	Create a function.
java.lang.String[][]	insert(java.lang.String filename, java.lang.String[] functions, java.lang.String... password)	Insert functions from an mph file into the function 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

FunctionFeature create(java.lang.String tag,
                       java.lang.String oper)

Create a function.

Specified by:

create in interface PropFeatureList<FunctionFeature>

Parameters:

tag - Feature tag.

oper - Type of function.

Returns:

Created function.

insert

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

Insert functions from an mph file into the function 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.

functions - The tags of the functions to insert.

password - Optional password for opening the file.

Returns:

Results from the insert operation.