com.comsol.model

Interface Results

All Superinterfaces:

IListMove, java.lang.Iterable<PropFeature>, ModelEntity, PrimitiveModelEntity

public interface Results
extends ModelEntity, IListMove, java.lang.Iterable<PropFeature>

The top level object for the postprocessing hierarchy.

Method Summary

Modifier and Type	Method and Description
void	clear() Remove all entities in the list.
void	clearStoredPlotData() Clears the plot data stored in plot features (plot groups, plots, and plot attributes).
ResultFeature	create(java.lang.String tag, int dimension) Creates a plot group, of a certain dimension.
ResultFeature	create(java.lang.String tag, java.lang.String type) Create a result feature of a certain type.
DatasetFeatureList	dataset() Gets the data set feature list.
DatasetFeature	dataset(java.lang.String tag) Gets a data set feature with a given tag.
ResultFeature	duplicate(java.lang.String newTag, java.lang.String tag) Creates a new feature in the list with the same settings as the original.
EvaluationGroupFeatureList	evaluationGroup() Gets the evaluation group list.
EvaluationGroupFeature	evaluationGroup(java.lang.String tag) Gets an evaluation group feature with a given tag.
ExportFeatureList	export() Gets an export feature list.
ExportFeature	export(java.lang.String tag) Gets an export feature with a given tag.
ResultFeature	get(java.lang.String tag) Gets a feature in the list with a given tag.
java.lang.String[][]	insert(java.lang.String filename, java.lang.String[] features, java.lang.String... password) Insert result features from an mph file into the result 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.
boolean	isOnlyPlotWhenRequested() Returns true if plots selected in the Model Builder only should be updated when the user explicitly requests it.
NumericalFeatureList	numerical() Gets a numerical feature list.
NumericalFeature	numerical(java.lang.String tag) Gets a numerical feature with a given tag.
ResultParam	param() Returns the parameters.
void	remove(java.lang.String tag) Remove a plot group with a given tag.
ReportFeatureList	report() Gets a report feature list.
ReportFeature	report(java.lang.String tag) Gets a report feature with a given tag.
void	setOnlyPlotWhenRequested(boolean value) Set if plots selected in the Model Builder only should be updated when the user explicitly requests it.
int	size() Determines the number of plot groups.
TableFeatureList	table() Get the list of table features.
TableFeature	table(java.lang.String tag) Get the table feature with a given tag.
java.lang.String[]	tags() Returns the tags of all result features.
java.lang.String	uniquetag(java.lang.String tag) Returns a unique tag in the list context.

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 com.comsol.model.IListMove

move

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

clear

void clear()

Remove all entities in the list.

clearStoredPlotData

void clearStoredPlotData()

Clears the plot data stored in plot features (plot groups, plots, and plot attributes).

create

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

Create a result feature of a certain type.

Parameters:

tag - Result feature tag.

type - Result feature type.

Returns:

Created result feature.

create

ResultFeature create(java.lang.String tag,
                     int dimension)

Creates a plot group, of a certain dimension.

Parameters:

tag - Plot group tag.

dimension - Plot group dimension (1, 2, or 3).

Returns:

Created plot group.

dataset

DatasetFeatureList dataset()

Gets the data set feature list.

Returns:

Data set feature list.

dataset

DatasetFeature dataset(java.lang.String tag)

Gets a data set feature with a given tag.

Parameters:

tag - Data set feature tag.

Returns:

Data set feature.

duplicate

ResultFeature duplicate(java.lang.String newTag,
                        java.lang.String tag)

Creates a new feature in the list with the same settings as the original. Returns the new feature.

Parameters:

newTag - Tag of new feature.

tag - Tag of duplicated feature.

Returns:

Duplicated feature.

evaluationGroup

EvaluationGroupFeatureList evaluationGroup()

Gets the evaluation group list.

Returns:

Evaluation group list.

evaluationGroup

EvaluationGroupFeature evaluationGroup(java.lang.String tag)

Gets an evaluation group feature with a given tag.

Parameters:

tag - Evaluation group feature tag.

Returns:

Evaluation group feature.

export

ExportFeatureList export()

Gets an export feature list.

Returns:

Export feature list.

export

ExportFeature export(java.lang.String tag)

Gets an export feature with a given tag.

Parameters:

tag - Gets an export feature with a given tag.

Returns:

Export feature.

get

ResultFeature get(java.lang.String tag)

Gets a feature in the list with a given tag.

Parameters:

tag - Result feature tag.

Returns:

Requested result feature.

insert

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

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

password - Optional password for opening the file.

Returns:

Results from the insert operation.

isOnlyPlotWhenRequested

boolean isOnlyPlotWhenRequested()

Returns true if plots selected in the Model Builder only should be updated when the user explicitly requests it.

Returns:

true if updating a plot requires a user action.

numerical

NumericalFeatureList numerical()

Gets a numerical feature list.

Returns:

Numerical feature list.

numerical

NumericalFeature numerical(java.lang.String tag)

Gets a numerical feature with a given tag.

Parameters:

tag - Numerical feature tag.

Returns:

Numerical feature.

param

ResultParam param()

Returns the parameters.

Returns:

Parameters.

remove

void remove(java.lang.String tag)

Remove a plot group with a given tag.

Parameters:

tag - Plot group tag.

report

ReportFeatureList report()

Gets a report feature list.

Returns:

Report feature list.

report

ReportFeature report(java.lang.String tag)

Gets a report feature with a given tag.

Parameters:

tag - Report feature tag.

Returns:

Report feature.

setOnlyPlotWhenRequested

void setOnlyPlotWhenRequested(boolean value)

Set if plots selected in the Model Builder only should be updated when the user explicitly requests it.

Parameters:

value - true if updating a plot should require a user action.

size

int size()

Determines the number of plot groups.

Returns:

Number of plot groups.

table

TableFeatureList table()

Get the list of table features.

Returns:

List of table features.

table

TableFeature table(java.lang.String tag)

Get the table feature with a given tag.

Parameters:

tag - Table feature tag.

Returns:

Table feature.

tags

java.lang.String[] tags()

Returns the tags of all result features.

Returns:

List of tags.

uniquetag

java.lang.String uniquetag(java.lang.String tag)

Returns a unique tag in the list context.

Parameters:

tag - The base for the unique tag.

Returns:

A unique tag.