com.comsol.model

Interface Unit

All Superinterfaces:

ModelEntity, PrimitiveModelEntity

public interface Unit
extends ModelEntity

Unit.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	aliases() Returns the aliases for the unit.
Unit	aliases(java.lang.String[] aliases) Sets the aliases for the unit.
Unit	definition(java.lang.String[] units, int[] powers) Sets the definition of a derived unit in powers of other units.
int[]	dimension() Returns the dimension of the unit.
double	offset() Returns the offset of the unit.
Unit	offset(double offset) Set the offset of the unit.
java.lang.String	quantity() Returns the quantity of the unit.
Unit	quantity(java.lang.String quantity) Sets the quantity of the unit.
double	scale() Returns the scale of the unit.
Unit	scale(double scale) Sets the scale of the unit.
java.lang.String	symbol() Returns the symbol of the unit.
Unit	symbol(java.lang.String symbol) Sets the symbol of the unit.

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

aliases

java.lang.String[] aliases()

Returns the aliases for the unit.

Returns:

Unit aliases.

aliases

Unit aliases(java.lang.String[] aliases)

Sets the aliases for the unit.

Parameters:

aliases - Unit aliases.

Returns:

Modified unit.

definition

Unit definition(java.lang.String[] units,
                int[] powers)

Sets the definition of a derived unit in powers of other units.

Parameters:

units - Vector of units.

powers - List of powers of the units.

Returns:

Modified unit.

dimension

int[] dimension()

Returns the dimension of the unit.

Returns:

Unit dimension.

offset

double offset()

Returns the offset of the unit.

Returns:

Unit offset.

offset

Unit offset(double offset)

Set the offset of the unit.

Parameters:

offset - Unit offset.

Returns:

Modified unit.

quantity

java.lang.String quantity()

Returns the quantity of the unit.

Returns:

Unit quantity.

quantity

Unit quantity(java.lang.String quantity)

Sets the quantity of the unit.

Parameters:

quantity - Unit quanity.

Returns:

Modified unit.

scale

double scale()

Returns the scale of the unit.

Returns:

Unit scale.

scale

Unit scale(double scale)

Sets the scale of the unit.

Parameters:

scale - Unit scale.

Returns:

Modified unit.

symbol

java.lang.String symbol()

Returns the symbol of the unit.

Returns:

Unit symbol.

symbol

Unit symbol(java.lang.String symbol)

Sets the symbol of the unit.

Parameters:

symbol - Unit symbol.

Returns:

Modified unit.