Package com.comsol.model

Interface ExportFeatureList

All Superinterfaces:

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

public interface ExportFeatureList
extends PropFeatureList<ExportFeature>, IListMove

List of export features.

Method Summary

Modifier and Type	Method	Description
ExportFeature	create(java.lang.String tag, java.lang.String oper)	Create an export feature.
ExportFeature	create(java.lang.String tag, java.lang.String plotGroupTag, java.lang.String exportType)	Create an export feature from a plot group.
ExportFeature	create(java.lang.String tag, java.lang.String plotGroupTag, java.lang.String plotName, java.lang.String exportType)	Create a plot data export feature.
java.lang.String[][]	insert(java.lang.String filename, java.lang.String[] materials, java.lang.String... password)	Insert export features from an mph file into the export 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.
void	run()	Execute all export features.

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

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

Create an export feature.

Specified by:

create in interface PropFeatureList<ExportFeature>

Parameters:

tag - Feature tag.

oper - Type of feature.

Returns:

Created export feature.

create

ExportFeature create(java.lang.String tag,
                     java.lang.String plotGroupTag,
                     java.lang.String exportType)

Create an export feature from a plot group.

Parameters:

tag - Tag of created export feature.

plotGroupTag - Tag of plot group.

exportType - Type of export.

Returns:

Created export feature.

create

ExportFeature create(java.lang.String tag,
                     java.lang.String plotGroupTag,
                     java.lang.String plotName,
                     java.lang.String exportType)

Create a plot data export feature.

Parameters:

tag - Tag of created export feature.

plotGroupTag - Tag of plot group.

plotName - Name of plot.

exportType - Type of export.

Returns:

Created export feature.

insert

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

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

materials - The tags of the export features to insert.

password - Optional password for opening the file.

Returns:

Results from the insert operation.

run

void run()

Execute all export features.