Package com.comsol.model

Interface MaterialList

All Superinterfaces:

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

All Known Subinterfaces:

ComponentMaterialList

public interface MaterialList
extends PropFeatureList<Material>, IListMove

List of materials.

Method Summary

Modifier and Type	Method	Description
Material	create(java.lang.String tag)	Creates material in current component.
Material	create(java.lang.String tag, java.lang.String type)	Creates material of specified type in current component.
Material	create(java.lang.String tag, java.lang.String type, java.lang.String component)	Creates material of specified type in the specified component.
java.lang.String	getString(java.lang.String name)	Gets string property.
java.lang.String[]	getStringArray(java.lang.String name)	Gets vector string property.
java.lang.String[][]	getStringMatrix(java.lang.String name)	Gets vector matrix property.
java.lang.String[][]	insert(java.lang.String filename, java.lang.String[] materials, java.lang.String... password)	Insert materials from an mph file into the material list of this model and returns the result of the operation as a double string array of length 3. The first array contains the messages from insert, the second array contains paths to the inserted objects, and the third array contains paths to the inserted references.
MaterialList	set(java.lang.String name, java.lang.String value)	Sets string property value.
MaterialList	set(java.lang.String name, java.lang.String[] value)	Sets string vector property value.
MaterialList	set(java.lang.String name, java.lang.String[][] value)	Sets string matrix property value.

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

Material create(java.lang.String tag)

Creates material in current component.

Parameters:

tag - Material tag.

Returns:

Created material.

create

Material create(java.lang.String tag,
                java.lang.String type)

Creates material of specified type in current component.

Specified by:

create in interface PropFeatureList<Material>

Parameters:

tag - Material tag.

type - Material type.

Returns:

Created material.

create

Material create(java.lang.String tag,
                java.lang.String type,
                java.lang.String component)

Creates material of specified type in the specified component.

Parameters:

tag - Material tag.

type - Material type.

component - Component, empty string to create a global material.

Returns:

Created material.

getString

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

Gets string property.

Parameters:

name - Property name.

Returns:

Property value.

getStringArray

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

Gets vector string property.

Parameters:

name - Property name.

Returns:

Property value.

getStringMatrix

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

Gets vector matrix property.

Parameters:

name - Property name.

Returns:

Property value.

insert

java.lang.String[][] insert(java.lang.String filename,
                            java.lang.String[] materials,
                            java.lang.String... password)

Insert materials from an mph file into the material list of this model and returns the result of the operation as a double string array of length 3.
The first array contains the messages from insert, the second array contains paths to the inserted objects, and the third array contains paths to the inserted references. A pasted reference is an object that a inserted object refers to, and isn't necessarily contained by any of the inserted objects.

Parameters:

filename - The file name.

materials - The tags of the materials to insert.

password - Optional password for opening the file.

Returns:

Results from the insert operation.

set

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

Sets string property value.

Parameters:

name - Property name.

value - Property value.

Returns:

MaterialList.

set

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

Sets string vector property value.

Parameters:

name - Property name.

value - Property value.

Returns:

MaterialList.

set

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

Sets string matrix property value.

Parameters:

name - Property name.

value - Property value.

Returns:

MaterialList.