Package com.comsol.model

Interface TableFeature

All Superinterfaces:

ModelEntity, PrimitiveModelEntity, PropFeature, ResultBaseFeature, SelectionContainer, SelectionEntity, TableBaseFeature

public interface TableFeature
extends TableBaseFeature, ResultBaseFeature

Contains numerical results, possibly from different sources.

Method Summary

Modifier and Type	Method	Description
void	addColumns(java.lang.String[] headers, double[][] realData)	Add columns with given headers and real data.
void	addColumns(java.lang.String[] headers, double[][] realData, double[][] imagData)	Add columns with given headers and real and imaginary data.
void	addRow(double[] realData)	Add a row with real data.
void	addRow(double[] realData, double[] imagData)	Add a row with real and imaginary data.
void	addRowAndWarnings(double[] realData, boolean[] warning)	Add a row with real data.
void	addRowAndWarnings(double[] realData, double[] imagData, boolean[] warnings)	Add a row with real and imaginary data.
void	addRows(double[][] realData)	Add rows with real data.
void	addRows(double[][] realData, double[][] imagData)	Add rows with real and imaginary data.
void	addRowsAndWarnings(double[][] realData, boolean[][] warning)	Add rows with real data.
void	addRowsAndWarnings(double[][] realData, double[][] imagData, boolean[][] warnings)	Add rows with real and imaginary data.
PropFeatureList<PropFeature>	feature()	Returns the list of features in this table.
double[][]	getFilledImag()	Get the imaginary data in the table on the filled format.
double[][]	getFilledReal()	Get the real data in the table on the filled format.
void	importData(java.lang.String filename)	Fill the table with real or complex data from a file.
void	loadFile(java.lang.String path)	Loads from a file.
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.

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

Methods inherited from interface com.comsol.model.TableBaseFeature

clearTableData, getColumnHeaders, getImag, getImagRow, getNRows, getReal, getRealRow, getRowHeaders, getTableData, getTableRow, isComplex, removeColumn, removeRow, save, save, saveFile, saveFile, saveFile, setColumnHeaders, setTableData, setTableData

Method Detail

addColumns

void addColumns(java.lang.String[] headers,
                double[][] realData)

Add columns with given headers and real data.

Parameters:

headers - Vector of header texts.

realData - Matrix of real data.

addColumns

void addColumns(java.lang.String[] headers,
                double[][] realData,
                double[][] imagData)

Add columns with given headers and real and imaginary data. The latter can be null if none.

Parameters:

headers - Vector of header texts.

realData - Matrix of real data.

imagData - Matrix of imaginary data.

addRow

void addRow(double[] realData)

Add a row with real data.

Parameters:

realData - Matrix of real data.

addRow

void addRow(double[] realData,
            double[] imagData)

Add a row with real and imaginary data.

Parameters:

realData - Matrix of real data.

imagData - Matrix of imaginary data.

addRowAndWarnings

void addRowAndWarnings(double[] realData,
                       boolean[] warning)

Add a row with real data.

Parameters:

realData - Matrix of real data.

warning - Matrix of boolean data.

addRowAndWarnings

void addRowAndWarnings(double[] realData,
                       double[] imagData,
                       boolean[] warnings)

Add a row with real and imaginary data.

Parameters:

realData - Matrix of real data.

imagData - Matrix of imaginary data.

warnings - Matrix of boolean data.

addRows

void addRows(double[][] realData)

Add rows with real data.

Parameters:

realData - Matrix of real data.

addRows

void addRows(double[][] realData,
             double[][] imagData)

Add rows with real and imaginary data.

Parameters:

realData - Matrix of real data.

imagData - Matrix of imaginary data.

addRowsAndWarnings

void addRowsAndWarnings(double[][] realData,
                        boolean[][] warning)

Add rows with real data.

Parameters:

realData - Matrix of real data.

warning - Matrix of boolean data.

addRowsAndWarnings

void addRowsAndWarnings(double[][] realData,
                        double[][] imagData,
                        boolean[][] warnings)

Add rows with real and imaginary data.

Parameters:

realData - Matrix of real data.

imagData - Matrix of imaginary data.

warnings - Matrix of boolean data.

feature

PropFeatureList<PropFeature> feature()

Returns the list of features in this table.

Returns:

List of table features.

getFilledImag

double[][] getFilledImag()

Get the imaginary data in the table on the filled format. This method will allocate imaginary data if none.

Returns:

Matrix of imaginary table data.

getFilledReal

double[][] getFilledReal()

Get the real data in the table on the filled format.

Returns:

Matrix of real table data.

importData

void importData(java.lang.String filename)

Fill the table with real or complex data from a file.

Parameters:

filename - File name.

loadFile

void loadFile(java.lang.String path)

Loads from a file.

Parameters:

path - Path to file.

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.

range - The range, or a starting cell.