Package com.comsol.model

Interface DatasetFeature

All Superinterfaces:

ModelEntity, PrimitiveModelEntity, PropFeature, ResultBaseFeature, SelectionContainer, SelectionEntity

public interface DatasetFeature
extends ResultBaseFeature

Datasets represent the source of data for plotting, for example by pointing to a solution and a geometry or by providing a transformation from another dataset, e.g. by introducing a cut plane in a 3D dataset.

Method Summary

Modifier and Type	Method	Description
DatasetFeature	create(java.lang.String tag, java.lang.String oper)	Create a dataset.
void	createDeformedConfig(java.lang.String gtag, java.lang.String mtag)	Only possible for solution datasets.
void	createMesh(java.lang.String compTag, java.lang.String geomTag, java.lang.String meshTag, java.lang.String importTag)	Only possible for filter and partition datasets.
void	createMeshPart(java.lang.String compTag, java.lang.String geomTag, java.lang.String meshTag, java.lang.String importTag)	Only possible for filter and partition datasets.
DatasetFeatureList	feature()	Returns the list of features in this dataset.
DatasetFeature	feature(java.lang.String tag)	Retrieves a specific sub-feature with a given tag, or throws an exception otherwise.
void	refresh()	Reread the files that this dataset depends on, if any.
void	run()	Plot the dataset.

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, resolveModelPath

Methods inherited from interface com.comsol.model.PropFeature

getAllowedPropertyValues, getBoolean, getBoolean, getBoolean, getBooleanArray, getBooleanMatrix, getDouble, getDouble, getDouble, getDoubleArray, getDoubleMatrix, getEntryKeyIndex, getEntryKeys, getInt, getInt, getInt, getIntArray, getIntMatrix, getReferenceArray, getString, getString, getString, getString, getStringArray, getStringMatrix, getType, getValueType, hasProperty, hasSelection, move, move, properties, remove, remove, selection, set, set, set, set, set, set, set, set, set, set, set, set, setEntry, setEntry, setEntry, setEntry, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex

Methods inherited from interface com.comsol.model.ResultBaseFeature

hasWarning, problem, problem, runCommand

Methods inherited from interface com.comsol.model.SelectionEntity

selection

Method Detail

create

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

Create a dataset.

Parameters:

tag - Feature tag.

oper - Type of dataset.

Returns:

Created dataset.

createDeformedConfig

void createDeformedConfig(java.lang.String gtag,
                          java.lang.String mtag)

Only possible for solution datasets. Creates a deformed geometry configuration from the solution and xmesh.

Parameters:

gtag - Geometry sequence tag.

mtag - Mesh sequence tag.

createMesh

void createMesh(java.lang.String compTag,
                java.lang.String geomTag,
                java.lang.String meshTag,
                java.lang.String importTag)

Only possible for filter and partition datasets. Creates a mesh in a new component from the result of evaluating the dataset.

Parameters:

compTag - Component tag.

geomTag - Geometry sequence tag.

meshTag - Mesh sequence tag.

importTag - Mesh import tag.

createMeshPart

void createMeshPart(java.lang.String compTag,
                    java.lang.String geomTag,
                    java.lang.String meshTag,
                    java.lang.String importTag)

Only possible for filter and partition datasets. Creates a mesh part from the result of evaluating the dataset.

Parameters:

compTag - Component tag.

geomTag - Geometry sequence tag.

meshTag - Mesh sequence tag.

importTag - Mesh import tag.

feature

DatasetFeatureList feature()

Returns the list of features in this dataset.

Returns:

List of dataset features.

feature

DatasetFeature feature(java.lang.String tag)

Retrieves a specific sub-feature with a given tag, or throws an exception otherwise.

Parameters:

tag - Dataset feature tag.

Returns:

Dataset feature.

refresh

void refresh()

Reread the files that this dataset depends on, if any.

run

void run()

Plot the dataset.