Package com.comsol.model

Interface ColorTableFeatureList

All Superinterfaces:

IListMove, java.lang.Iterable<ColorTableFeature>, ModelEntity, ModelEntityList<ColorTableFeature>, PrimitiveModelEntity, PropFeatureList<ColorTableFeature>

public interface ColorTableFeatureList
extends PropFeatureList<ColorTableFeature>, IListMove

List of color table features.

Method Summary

Modifier and Type	Method	Description
ColorTableFeature	create(java.lang.String tag, java.lang.String oper)	Create a color table feature.
java.lang.String[]	getColorTableCategories(java.lang.String name)	Returns the categories that a color table belongs to.
java.lang.String[]	getColorTableNames()	Get the names of color tables that can be used.
double[][]	getColorTableRGB(java.lang.String name)	Returns the definition of a color table.
boolean	hasColorTable(java.lang.String name)	Check if a color table exists.
boolean	isColorTableContinuous(java.lang.String name)	Check if a color table is continuous.
double[][]	sampleColorTableRGB(java.lang.String name, int n)	Returns the definition of a color table.

Methods inherited from interface com.comsol.model.IListMove

move

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

clear, copy, copy, copyTo, duplicate, duplicateTo, get, index, remove, size, tags, uniquetag

Methods inherited from interface com.comsol.model.PrimitiveModelEntity

getContainer, getDisplayString, resolveModelPath

Method Detail

create

ColorTableFeature create(java.lang.String tag,
                         java.lang.String oper)

Create a color table feature.

Specified by:

create in interface PropFeatureList<ColorTableFeature>

Parameters:

tag - Feature tag.

oper - Type of feature.

Returns:

Created color table feature.

getColorTableCategories

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

Returns the categories that a color table belongs to.

Parameters:

name - The name of the color table.

Returns:

The categories, can be empty.

getColorTableNames

java.lang.String[] getColorTableNames()

Get the names of color tables that can be used.

Returns:

Names of color tables.

getColorTableRGB

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

Returns the definition of a color table.

Parameters:

name - The name of the color table.

Returns:

A matrix that contains one row per color in the color in the color table. The first three columns are the red, green, and blue components. The fourth column contains the length of the corresponding color band.

hasColorTable

boolean hasColorTable(java.lang.String name)

Check if a color table exists.

Parameters:

name - The name of the color table.

Returns:

True if the color table exists.

isColorTableContinuous

boolean isColorTableContinuous(java.lang.String name)

Check if a color table is continuous.

Parameters:

name - The name of the color table.

Returns:

True if the color table is continuous.

sampleColorTableRGB

double[][] sampleColorTableRGB(java.lang.String name,
                               int n)

Returns the definition of a color table.

Parameters:

name - The name of the color table.

n - The number of sample points (at least two).

Returns:

An n-by-3 matrix where the columns contain the red, green, and blue components.