Package com.comsol.model

Interface ParameterEntity

All Superinterfaces:

ModelEntity, ParameterContainer, PrimitiveModelEntity, SelectionContainer, SelectionEntity

All Known Subinterfaces:

CoeffFeature, ConstrFeature, MaterialModel, MultiphysicsCoupling, PhysicsFeature

public interface ParameterEntity
extends SelectionEntity, ParameterContainer

Base interface for entities with parameters.

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	getAllowedPropertyValues(java.lang.String name)	Returns the set of allowed values for a parameter if it is a finite set of strings, null otherwise.
boolean	getBoolean(java.lang.String name)	Returns the value as a boolean.
java.lang.String[][]	getDblStringArray(java.lang.String name)	Returns the value as a matrix of strings.
double[]	getDoubleArray(java.lang.String name)	Returns the value as a vector of doubles.
double[][]	getDoubleMatrix(java.lang.String name)	Returns the value as a matrix of doubles.
java.lang.String	getString(java.lang.String name)	Returns the value as a string.
java.lang.String[]	getStringArray(java.lang.String name)	Returns the value as a vector of strings.
java.lang.String[][]	getStringMatrix(java.lang.String name)	Returns the value as a matrix of strings.
java.lang.String	getValueType(java.lang.String name)	Returns the main data type which a parameter can return.
boolean	hasProperty(java.lang.String name)	Returns true if this feature supports a given parameter.
java.lang.String[]	properties()	Returns the names of all parameters.
LocalSelection	selection(java.lang.String extraSel)	Returns the extra selection.
ParameterEntity	set(java.lang.String name, boolean value)	Sets the value as a boolean value.
ParameterEntity	set(java.lang.String name, double value)	Sets the value as a double value.
ParameterEntity	set(java.lang.String name, double[] value)	Sets the value as a double vector value.
ParameterEntity	set(java.lang.String name, double[][] value)	Sets the value as a double matrix value.
ParameterEntity	set(java.lang.String name, int value)	Sets the value as an integer value.
ParameterEntity	set(java.lang.String name, int[] value)	Sets the value as an integer vector value.
ParameterEntity	set(java.lang.String name, int[][] value)	Sets the value as an integer matrix value.
ParameterEntity	set(java.lang.String arg0, int arg1, double arg2)	Deprecated. Use 0-based setIndex instead.
ParameterEntity	set(java.lang.String arg0, int arg1, double[] arg2)	Deprecated. Use 0-based setIndex instead.
ParameterEntity	set(java.lang.String arg0, int arg1, int arg2)	Deprecated. Use 0-based setIndex instead.
ParameterEntity	set(java.lang.String arg0, int arg1, int[] arg2)	Deprecated. Use 0-based setIndex instead.
ParameterEntity	set(java.lang.String arg0, int arg1, int arg2, double arg3)	Deprecated. Use 0-based setIndex instead.
ParameterEntity	set(java.lang.String arg0, int arg1, int arg2, int arg3)	Deprecated. Use 0-based setIndex instead.
ParameterEntity	set(java.lang.String arg0, int arg1, int arg2, java.lang.String arg3)	Deprecated. Use 0-based setIndex instead.
ParameterEntity	set(java.lang.String arg0, int arg1, java.lang.String arg2)	Deprecated. Use 0-based setIndex instead.
ParameterEntity	set(java.lang.String arg0, int arg1, java.lang.String[] arg2)	Deprecated. Use 0-based setIndex instead.
ParameterEntity	set(java.lang.String name, java.lang.String value)	Sets the value as a string value.
ParameterEntity	set(java.lang.String name, java.lang.String[] value)	Sets the value as a string vector value.
ParameterEntity	set(java.lang.String name, java.lang.String[][] value)	Sets the value as a string matrix value.
ParameterEntity	setIndex(java.lang.String name, boolean value, int index)	Sets vector parameter value at index.
ParameterEntity	setIndex(java.lang.String name, double[] value, int index)	Sets matrix parameter value at index.
ParameterEntity	setIndex(java.lang.String name, double value, int index)	Sets vector parameter value at index.
ParameterEntity	setIndex(java.lang.String name, double value, int firstIndex, int secondIndex)	Sets matrix parameter value at index.
ParameterEntity	setIndex(java.lang.String name, int[] value, int index)	Sets matrix parameter value at index.
ParameterEntity	setIndex(java.lang.String name, int value, int index)	Sets vector parameter value at index.
ParameterEntity	setIndex(java.lang.String name, int value, int firstIndex, int secondIndex)	Sets matrix parameter value at index.
ParameterEntity	setIndex(java.lang.String name, java.lang.String[] value, int index)	Sets matrix parameter value at index.
ParameterEntity	setIndex(java.lang.String name, java.lang.String value, int vector)	Sets parameter value at index.
ParameterEntity	setIndex(java.lang.String name, java.lang.String value, int firstIndex, int secondIndex)	Sets matrix parameter value at index.

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.ParameterContainer

commands, hasParam, param, params, runCommand

Methods inherited from interface com.comsol.model.PrimitiveModelEntity

getContainer, getDisplayString, resolveModelPath

Methods inherited from interface com.comsol.model.SelectionEntity

selection

Method Detail

getAllowedPropertyValues

java.lang.String[] getAllowedPropertyValues(java.lang.String name)

Returns the set of allowed values for a parameter if it is a finite set of strings, null otherwise.

Parameters:

name - Parameter name.

Returns:

Vector of parameter valid values.

getBoolean

boolean getBoolean(java.lang.String name)

Returns the value as a boolean.

Parameters:

name - Parameter name.

Returns:

Boolean value.

getDblStringArray

java.lang.String[][] getDblStringArray(java.lang.String name)

Returns the value as a matrix of strings.

Parameters:

name - Parameter name.

Returns:

String matrix value.

getDoubleArray

double[] getDoubleArray(java.lang.String name)

Returns the value as a vector of doubles.

Parameters:

name - Parameter name.

Returns:

Double vector value.

getDoubleMatrix

double[][] getDoubleMatrix(java.lang.String name)

Returns the value as a matrix of doubles.

Parameters:

name - Parameter name.

Returns:

Double matrix value.

getString

java.lang.String getString(java.lang.String name)

Returns the value as a string.

Parameters:

name - Parameter name.

Returns:

String value.

getStringArray

java.lang.String[] getStringArray(java.lang.String name)

Returns the value as a vector of strings.

Parameters:

name - Parameter name.

Returns:

String vector value.

getStringMatrix

java.lang.String[][] getStringMatrix(java.lang.String name)

Returns the value as a matrix of strings.

Parameters:

name - Parameter name.

Returns:

String matrix value.

getValueType

java.lang.String getValueType(java.lang.String name)

Returns the main data type which a parameter can return.

Parameters:

name - The name of the parameter.

Returns:

Data types: String, StringArray, StringMatrix, DoubleArray, DoubleMatrix.

hasProperty

boolean hasProperty(java.lang.String name)

Returns true if this feature supports a given parameter.

Parameters:

name - Parameter name.

Returns:

true if a feature supports the parameter.

properties

java.lang.String[] properties()

Returns the names of all parameters.

Returns:

Vector of parameter names.

selection

LocalSelection selection(java.lang.String extraSel)

Returns the extra selection.

Parameters:

extraSel - Extra selection name.

Returns:

LocalSelection.

set

ParameterEntity set(java.lang.String name,
                    java.lang.String value)

Sets the value as a string value.

Parameters:

name - Parameter name.

value - String value.

Returns:

Parameter entity.

set

ParameterEntity set(java.lang.String name,
                    java.lang.String[] value)

Sets the value as a string vector value.

Parameters:

name - Parameter name.

value - String vector value.

Returns:

Parameter entity.

set

ParameterEntity set(java.lang.String name,
                    java.lang.String[][] value)

Sets the value as a string matrix value.

Parameters:

name - Parameter name.

value - String matrix value.

Returns:

Parameter entity.

set

ParameterEntity set(java.lang.String name,
                    boolean value)

Sets the value as a boolean value.

Parameters:

name - Parameter name.

value - Boolean value.

Returns:

Parameter entity.

set

ParameterEntity set(java.lang.String name,
                    double value)

Sets the value as a double value.

Parameters:

name - Parameter name.

value - Double value.

Returns:

Parameter entity.

set

ParameterEntity set(java.lang.String name,
                    double[] value)

Sets the value as a double vector value.

Parameters:

name - Parameter name.

value - Double vector value.

Returns:

Parameter entity.

set

ParameterEntity set(java.lang.String name,
                    double[][] value)

Sets the value as a double matrix value.

Parameters:

name - Parameter name.

value - Double matrix value.

Returns:

Parameter entity.

set

ParameterEntity set(java.lang.String name,
                    int value)

Sets the value as an integer value.

Parameters:

name - Parameter name.

value - Integer value.

Returns:

Parameter entity.

set

ParameterEntity set(java.lang.String name,
                    int[] value)

Sets the value as an integer vector value.

Parameters:

name - Parameter name.

value - Integer vector value.

Returns:

Parameter entity.

set

ParameterEntity set(java.lang.String name,
                    int[][] value)

Sets the value as an integer matrix value.

Parameters:

name - Parameter name.

value - Integer matrix value.

Returns:

Parameter entity.

set

@Deprecated
ParameterEntity set(java.lang.String arg0,
                    int arg1,
                    java.lang.String arg2)

Deprecated.

Use 0-based setIndex instead.

set

@Deprecated
ParameterEntity set(java.lang.String arg0,
                    int arg1,
                    java.lang.String[] arg2)

Deprecated.

Use 0-based setIndex instead.

set

@Deprecated
ParameterEntity set(java.lang.String arg0,
                    int arg1,
                    double arg2)

Deprecated.

Use 0-based setIndex instead.

set

@Deprecated
ParameterEntity set(java.lang.String arg0,
                    int arg1,
                    double[] arg2)

Deprecated.

Use 0-based setIndex instead.

set

@Deprecated
ParameterEntity set(java.lang.String arg0,
                    int arg1,
                    int arg2)

Deprecated.

Use 0-based setIndex instead.

set

@Deprecated
ParameterEntity set(java.lang.String arg0,
                    int arg1,
                    int[] arg2)

Deprecated.

Use 0-based setIndex instead.

set

@Deprecated
ParameterEntity set(java.lang.String arg0,
                    int arg1,
                    int arg2,
                    java.lang.String arg3)

Deprecated.

Use 0-based setIndex instead.

set

@Deprecated
ParameterEntity set(java.lang.String arg0,
                    int arg1,
                    int arg2,
                    double arg3)

Deprecated.

Use 0-based setIndex instead.

set

@Deprecated
ParameterEntity set(java.lang.String arg0,
                    int arg1,
                    int arg2,
                    int arg3)

Deprecated.

Use 0-based setIndex instead.

setIndex

ParameterEntity setIndex(java.lang.String name,
                         java.lang.String value,
                         int vector)

Sets parameter value at index.

Parameters:

name - Parameter name.

value - Parameter value.

vector - Index in vector (0-based).

Returns:

Parameter entity.

setIndex

ParameterEntity setIndex(java.lang.String name,
                         java.lang.String[] value,
                         int index)

Sets matrix parameter value at index.

Parameters:

name - Parameter name.

value - Parameter value.

index - Index in matrix (0-based).

Returns:

Parameter entity.

setIndex

ParameterEntity setIndex(java.lang.String name,
                         boolean value,
                         int index)

Sets vector parameter value at index.

Parameters:

name - Parameter name.

value - Parameter value.

index - Index in vector (0-based).

Returns:

Parameter entity.

setIndex

ParameterEntity setIndex(java.lang.String name,
                         double value,
                         int index)

Sets vector parameter value at index.

Parameters:

name - Parameter name.

value - Parameter value.

index - Index in vector (0-based).

Returns:

Parameter entity.

setIndex

ParameterEntity setIndex(java.lang.String name,
                         double[] value,
                         int index)

Sets matrix parameter value at index.

Parameters:

name - Parameter name.

value - Parameter value.

index - Index in matrix (0-based).

Returns:

Parameter entity.

setIndex

ParameterEntity setIndex(java.lang.String name,
                         int value,
                         int index)

Sets vector parameter value at index.

Parameters:

name - Parameter name.

value - Parameter value (0-based).

index - Index in vector (0-based).

Returns:

Parameter entity.

setIndex

ParameterEntity setIndex(java.lang.String name,
                         int[] value,
                         int index)

Sets matrix parameter value at index.

Parameters:

name - Parameter name.

value - Parameter value.

index - Index in matrix.

Returns:

Parameter entity.

setIndex

ParameterEntity setIndex(java.lang.String name,
                         java.lang.String value,
                         int firstIndex,
                         int secondIndex)

Sets matrix parameter value at index.

Parameters:

name - Parameter name.

value - Parameter value.

firstIndex - First index in matrix (0-based).

secondIndex - Second index in matrix (0-based).

Returns:

Parameter entity.

setIndex

ParameterEntity setIndex(java.lang.String name,
                         double value,
                         int firstIndex,
                         int secondIndex)

Sets matrix parameter value at index.

Parameters:

name - Parameter name.

value - Parameter value.

firstIndex - First index in matrix (0-based).

secondIndex - Second index in matrix (0-based).

Returns:

Parameter entity.

setIndex

ParameterEntity setIndex(java.lang.String name,
                         int value,
                         int firstIndex,
                         int secondIndex)

Sets matrix parameter value at index.

Parameters:

name - Parameter name.

value - Parameter value.

firstIndex - First index in matrix (0-based).

secondIndex - Second index in matrix (0-based).

Returns:

Parameter entity.