Package com.comsol.model

Interface ModelParamGroupCase

All Superinterfaces:

ModelEntity, PrimitiveModelEntity

public interface ModelParamGroupCase
extends ModelEntity

Parameter group case.

Method Summary

Modifier and Type	Method	Description
java.lang.String	get(java.lang.String parName)	Returns a parameter case expression.
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.
void	reset()	Resets all parameter cases from parent parameter group.
void	reset(java.lang.String[] parNames)	Resets a number of parameter cases from parent parameter group.
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.
ModelParamGroupCase	set(java.lang.String parName, java.lang.String expr)	Sets a parameter case expression.

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

get

java.lang.String get(java.lang.String parName)

Returns a parameter case expression.

Parameters:

parName - Parameter name.

Returns:

Parameter case expression.

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.

range - The range, or a starting cell.

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.

reset

void reset()

Resets all parameter cases from parent parameter group.

reset

void reset(java.lang.String[] parNames)

Resets a number of parameter cases from parent parameter group.

Parameters:

parNames - The names of the parameters to reset.

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.

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.

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.

set

ModelParamGroupCase set(java.lang.String parName,
                        java.lang.String expr)

Sets a parameter case expression.

Parameters:

parName - Parameter name.

expr - Parameter case expression.

Returns:

Parameter case.