Package com.comsol.model

Interface ModelParamGroup

All Superinterfaces:

ExpressionBase, ModelEntity, PrimitiveModelEntity

public interface ModelParamGroup
extends ModelEntity, ExpressionBase

Parameter group.

Method Summary

Modifier and Type	Method	Description
ModelParamGroupCase	create(java.lang.String tag)	Creates a parameter case.
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.
ModelParamGroup	move(java.lang.String parName)	Moves a parameter to this parameter group.
ModelParamGroup	move(java.lang.String[] parNames)	Moves parameters to this parameter group.
ModelParamGroupCaseList	paramCase()	Returns all parameter cases in the parameter group.
ModelParamGroupCase	paramCase(java.lang.String cTag)	Returns a parameter group case 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.
void	setFromCase(java.lang.String paramCase)	Sets the parameters in this group from a specified parameter case.
void	setFromCase(java.lang.String[] parNames, java.lang.String paramCase)	Sets a number of named parameters in this group from a specified parameter case.
void	setShowInParamSel(boolean show)	Sets whether to show parameters in this group in parameter selection lists.
boolean	showInParamSel()	Check if the parameters in this group are visible in parameter selection lists.

Methods inherited from interface com.comsol.model.ExpressionBase

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

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

create

ModelParamGroupCase create(java.lang.String tag)

Creates a parameter case.

Parameters:

tag - Parameter case tag.

Returns:

Created parameter case.

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.

move

ModelParamGroup move(java.lang.String parName)

Moves a parameter to this parameter group.

Parameters:

parName - Parameter name.

Returns:

Parameter group.

move

ModelParamGroup move(java.lang.String[] parNames)

Moves parameters to this parameter group.

Parameters:

parNames - Parameter names.

Returns:

Parameter group.

paramCase

ModelParamGroupCaseList paramCase()

Returns all parameter cases in the parameter group.

Returns:

List of parameter group cases.

paramCase

ModelParamGroupCase paramCase(java.lang.String cTag)

Returns a parameter group case with the given tag.

Parameters:

cTag - Parameter group case tag.

Returns:

Parameter group case.

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.

setFromCase

void setFromCase(java.lang.String paramCase)

Sets the parameters in this group from a specified parameter case.

Parameters:

paramCase - The parameter case from which to set the parameters.

setFromCase

void setFromCase(java.lang.String[] parNames,
                 java.lang.String paramCase)

Sets a number of named parameters in this group from a specified parameter case.

Parameters:

parNames - The names of the parameters to set.

paramCase - The parameter case from which to set the parameters.

setShowInParamSel

void setShowInParamSel(boolean show)

Sets whether to show parameters in this group in parameter selection lists.

Parameters:

show - True if parameters in this group should be shown in parameter selection lists.

showInParamSel

boolean showInParamSel()

Check if the parameters in this group are visible in parameter selection lists.

Returns:

true if visible.