Package com.comsol.model

Interface Expr

All Superinterfaces:

ExpressionBase, ExpressionEntity, ModelEntity, PrimitiveModelEntity, SelectionContainer, SelectionEntity, StudyContainer

All Known Subinterfaces:

ElementSet

public interface Expr
extends ExpressionEntity

Variable collection.

Method Summary

Modifier and Type	Method	Description
void	loadFile(java.lang.String path)	Loads from a file.
void	loadFile(java.lang.String path, char delim)	Loads from a file using a specified delimiter.
void	loadFile(java.lang.String path, char delim, boolean separateUnitColumns)	Loads from a file using a specified delimiter.
void	loadFile(java.lang.String path, java.lang.String sheet, java.lang.String range)	Loads from an Excel-file with a specified range to read, or a cell to start from, in the specified sheet.
void	loadFile(java.lang.String path, java.lang.String sheet, java.lang.String range, boolean separateUnitColumns)	Loads from an Excel-file with a specified range to read, or a cell to start from, in the specified sheet.
Expr	move(java.lang.String[] varNames, java.lang.String targetTag)	Moves variables to the variable feature with the given tag.
Expr	move(java.lang.String varName, java.lang.String targetTag)	Moves a variable to the variable feature with the given tag.
void	saveFile(java.lang.String path)	Saves to a file.
void	saveFile(java.lang.String path, char delim)	Saves to a file using a specified delimiter.
void	saveFile(java.lang.String path, char delim, boolean separateUnitColumns)	Saves to a file using a specified delimiter.
void	saveFile(java.lang.String path, java.lang.String sheet, java.lang.String range, boolean includeHeaders, boolean overwrite)	Saves to an Excel-file in a specified range, or at a cell to start from, in a specified sheet.
void	saveFile(java.lang.String path, java.lang.String sheet, java.lang.String range, boolean includeHeaders, boolean overwrite, boolean separateUnitColumns)	Saves to an Excel-file in a specified range, or at a cell to start from, in a specified sheet.
XDLocalSelection	selection()	Returns the variable collection selection.

Methods inherited from interface com.comsol.model.ExpressionBase

clear, descr, get, rename, set, set, varnames

Methods inherited from interface com.comsol.model.ExpressionEntity

descr, remove, remove, set, set

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

Method Detail

loadFile

void loadFile(java.lang.String path)

Loads from a file.

Parameters:

path - Path to file.

loadFile

void loadFile(java.lang.String path,
              char delim)

Loads from a file using a specified delimiter.

Parameters:

path - Path to file.

delim - Delimiter to use.

loadFile

void loadFile(java.lang.String path,
              java.lang.String sheet,
              java.lang.String range)

Loads from an Excel-file with a specified range to read, or a cell to start from, in the specified sheet.

Parameters:

path - Path to file.

sheet - The Excel-sheet to use. Inputting an empty string means using the first sheet.

range - The range, or a starting cell. Can be given as a cell coordinate (e.g. C3) of the top left cell, a range (e.g. C3:E10), or empty, in which case the sheet is read from the top left corner (A1).

loadFile

void loadFile(java.lang.String path,
              char delim,
              boolean separateUnitColumns)

Loads from a file using a specified delimiter.

Parameters:

path - Path to file.

delim - Delimiter to use.

separateUnitColumns - True to split expression columns into expression and unit.

loadFile

void loadFile(java.lang.String path,
              java.lang.String sheet,
              java.lang.String range,
              boolean separateUnitColumns)

Loads from an Excel-file with a specified range to read, or a cell to start from, in the specified sheet.

Parameters:

path - Path to file.

sheet - The Excel-sheet to use.

range - The range, or a starting cell.

separateUnitColumns - True to split expression columns into expression and unit.

move

Expr move(java.lang.String varName,
          java.lang.String targetTag)

Moves a variable to the variable feature with the given tag.

Parameters:

varName - Variable name.

targetTag - Target variable feature tag.

Returns:

The variable feature the variable moved to.

move

Expr move(java.lang.String[] varNames,
          java.lang.String targetTag)

Moves variables to the variable feature with the given tag.

Parameters:

varNames - Variable names.

targetTag - Target variable feature tag.

Returns:

The variable feature the variables moved to.

saveFile

void saveFile(java.lang.String path)

Saves to a file.

Parameters:

path - Path to file.

saveFile

void saveFile(java.lang.String path,
              char delim)

Saves to a file using a specified delimiter.

Parameters:

path - Path to file.

delim - Delimiter to use.

saveFile

void saveFile(java.lang.String path,
              char delim,
              boolean separateUnitColumns)

Saves to a file using a specified delimiter.

Parameters:

path - Path to file.

delim - Delimiter to use.

separateUnitColumns - True to split expression columns into expression and unit.

saveFile

void saveFile(java.lang.String path,
              java.lang.String sheet,
              java.lang.String range,
              boolean includeHeaders,
              boolean overwrite)

Saves to an Excel-file in a specified range, or at a cell to start from, in a specified sheet.

Parameters:

path - Path to file.

sheet - The Excel-sheet to use. Inputting an empty string means using the first sheet.

range - The range, or a starting cell. Can be given as a cell coordinate (e.g. C3) of the top left cell, a range (e.g. C3:E10), or empty, in which case the sheet is written from the top left corner (A1).

includeHeaders - True if column headers are to be written.

overwrite - True if an existing file is to be overwritten, or if an error should be cast in that instance.

saveFile

void saveFile(java.lang.String path,
              java.lang.String sheet,
              java.lang.String range,
              boolean includeHeaders,
              boolean overwrite,
              boolean separateUnitColumns)

Saves to an Excel-file in a specified range, or at a cell to start from, in a specified sheet.

Parameters:

path - Path to file.

sheet - The Excel-sheet to use.

range - The range, or a starting cell.

includeHeaders - True if column headers are to be written.

overwrite - True if an existing file is to be overwritten, or if an error should be cast in that instance.

separateUnitColumns - True to split expression columns into expression and unit.

selection

XDLocalSelection selection()

Returns the variable collection selection.

Specified by:

selection in interface SelectionEntity

Returns:

Selection.