Package com.comsol.model

Interface CommonFeature

All Superinterfaces:

EquationViewParent, IPlotAndImageExport, ModelEntity, PrimitiveModelEntity, PropFeature, SelectionContainer, SelectionEntity

public interface CommonFeature
extends PropFeature, IPlotAndImageExport, EquationViewParent

Common definitions feature.

Method Summary

Modifier and Type	Method	Description
CommonFeature	create(java.lang.String tag, java.lang.String oper)	Create a common definitions feature subnode.
void	discardData()	Discard any imported data.
void	exportData(java.lang.String filename)	Export data.
CommonList	feature()	Returns the list of all common definitions feature subnodes.
CommonFeature	feature(java.lang.String tag)	Returns a common definitions feature subnode.
void	importData()	Import data.
void	importData(java.lang.String filename)	Import data from specified file.
ProblemList	problem()	Returns all problems for this feature.
ProblemFeature	problem(java.lang.String tag)	Returns a problem feature.
void	refresh()	Reread the files that this feature depends on, if any.
XDLocalSelection	selection()	Returns the selection.
LocalSelection	selection(java.lang.String name)	Returns the selection stored in a selection property with the given name.

Methods inherited from interface com.comsol.model.physics.EquationViewParent

featureInfo, featureInfo

Methods inherited from interface com.comsol.model.IPlotAndImageExport

image

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

Method Detail

create

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

Create a common definitions feature subnode.

Parameters:

tag - Subnode tag.

oper - Type of subnode.

Returns:

Created subnode.

discardData

void discardData()

Discard any imported data.

exportData

void exportData(java.lang.String filename)

Export data.

Parameters:

filename - Filename.

feature

CommonList feature()

Returns the list of all common definitions feature subnodes.

Returns:

Common definitions feature subnodes.

feature

CommonFeature feature(java.lang.String tag)

Returns a common definitions feature subnode.

Parameters:

tag - Common definitions feature subnode tag.

Returns:

Common definitions feature subnode.

importData

void importData()

Import data.

importData

void importData(java.lang.String filename)

Import data from specified file.

Parameters:

filename - Filename.

problem

ProblemList problem()

Returns all problems for this feature.

Returns:

Problem feature list.

problem

ProblemFeature problem(java.lang.String tag)

Returns a problem feature.

Parameters:

tag - Problem tag.

Returns:

Problem feature.

refresh

void refresh()

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

selection

XDLocalSelection selection()

Returns the selection.

Specified by:

selection in interface SelectionEntity

Returns:

Selection.

selection

LocalSelection selection(java.lang.String name)

Returns the selection stored in a selection property with the given name.

Specified by:

selection in interface PropFeature

Parameters:

name - Selection property name.

Returns:

Selection.