com.comsol.model

Interface TableFeature

All Superinterfaces:

ModelEntity, PrimitiveModelEntity, PropFeature, ResultBaseFeature, SelectionContainer, SelectionEntity

public interface TableFeature
extends ResultBaseFeature

Contains numerical results, possibly from different sources.

Method Summary

Modifier and Type	Method and 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	clearTableData() Remove all data in the table.
PropFeatureList<PropFeature>	feature() Returns the list of features in this table.
java.lang.String[]	getColumnHeaders() Get the table's column headers.
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.
double[][]	getImag() Get the imaginary data in the table.
double[]	getImagRow(int index) Get the imaginary data in a row (0-index).
int	getNRows() Get the number of rows in the table.
double[][]	getReal() Get the real data in the table.
double[]	getRealRow(int index) Get the real data in a row (0-index).
java.lang.String[][]	getTableData(boolean fullPrecision) Get the table data as a string matrix, with or without full precision.
java.lang.String[]	getTableRow(int index, boolean fullPrecision) Get the table data of one row as a string array.
void	importData(java.lang.String filename) Fill the table with real or complex data from a file.
boolean	isComplex() Check if the table has allocated complex data.
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.
void	removeColumn(int index) Remove a column with a given index, if it exists.
void	removeRow(int index) Remove a row with a given index, if it exists.
void	save(java.lang.String filename) Save the table data in full precision to a text file.
void	save(java.lang.String filename, boolean fullPrecision) Save the table data to a text file.
void	saveFile(java.lang.String path) Saves to a file.
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	setColumnHeaders(java.lang.String[] value) Set the table's column headers, but leave the table's data unchanged.
void	setTableData(double[][] realData) Set the real data in the table.
void	setTableData(double[][] realData, double[][] imagData) Set the real and imaginary data in the table.

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, properties, 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.SelectionEntity

selection

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

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.

clearTableData

void clearTableData()

Remove all data in the table.

feature

PropFeatureList<PropFeature> feature()

Returns the list of features in this table.

Returns:

List of table features.

getColumnHeaders

java.lang.String[] getColumnHeaders()

Get the table's column headers.

Returns:

Vector with column headers.

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.

getImag

double[][] getImag()

Get the imaginary data in the table. This method will allocate imaginary data if none. This method always uses the all format.

Returns:

Matrix of imaginary table data.

getImagRow

double[] getImagRow(int index)

Get the imaginary data in a row (0-index).

Parameters:

index - Row index.

Returns:

Vector of imaginary table data.

getNRows

int getNRows()

Get the number of rows in the table.

Returns:

Number of rows.

getReal

double[][] getReal()

Get the real data in the table. This method always uses the all format.

Returns:

Matrix of real table data.

getRealRow

double[] getRealRow(int index)

Get the real data in a row (0-index).

Parameters:

index - Row index.

Returns:

Vector of real table data.

getTableData

java.lang.String[][] getTableData(boolean fullPrecision)

Get the table data as a string matrix, with or without full precision.

Parameters:

fullPrecision - true for full precision.

Returns:

.

getTableRow

java.lang.String[] getTableRow(int index,
                               boolean fullPrecision)

Get the table data of one row as a string array.

Parameters:

index - Row index.

fullPrecision - true for full precision.

Returns:

String vector of table row data.

importData

void importData(java.lang.String filename)

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

Parameters:

filename - File name.

isComplex

boolean isComplex()

Check if the table has allocated complex data.

Returns:

true if complex.

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.

removeColumn

void removeColumn(int index)

Remove a column with a given index, if it exists.

Parameters:

index - Column index.

removeRow

void removeRow(int index)

Remove a row with a given index, if it exists.

Parameters:

index - Row index.

save

void save(java.lang.String filename)

Save the table data in full precision to a text file.

Parameters:

filename - File name.

save

void save(java.lang.String filename,
          boolean fullPrecision)

Save the table data to a text file.

Parameters:

filename - File name.

fullPrecision - true for full precision.

saveFile

void saveFile(java.lang.String path)

Saves to a file.

Parameters:

path - Path to file.

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.

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.

setColumnHeaders

void setColumnHeaders(java.lang.String[] value)

Set the table's column headers, but leave the table's data unchanged.

Parameters:

value - The column headers.

setTableData

void setTableData(double[][] realData)

Set the real data in the table.

Parameters:

realData - Matrix of real table data.

setTableData

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

Set the real and imaginary data in the table. The latter can be null if none.

Parameters:

realData - Matrix of real table data.

imagData - Matrix of imaginary table data.