Package com.comsol.model

Interface ElemFeature

All Superinterfaces:

ModelEntity, PrimitiveModelEntity, SelectionContainer, SelectionEntity

All Known Subinterfaces:

Element

public interface ElemFeature
extends SelectionEntity

Element feature.

Method Summary

Modifier and Type	Method	Description
ElemFeatureList	field()	Returns all element features from field.
ElemFeature	field(java.lang.String name)	Returns an element feature from field.
boolean	getModifier(int bit)	Returns the value of the modifier flag.
boolean	isExpression()	Returns true if a string value represents an expression.
ElemFeature	isExpression(boolean isExpr)	Sets the expression flag for a string value.
ElemFeatureList	pos()	Returns all element features from pos.
ElemFeature	pos(int index)	Returns an element feature from pos.
XDLocalSelection	selection()	Returns the selection.
ElemFeature	set(java.lang.String name, java.lang.String value)	Sets a property to a string value in an element feature.
ElemFeature	set(java.lang.String name, java.lang.String[] value)	Sets a property to a string vector value in an element feature.
ElemFeature	set(java.lang.String name, java.lang.String[][] value)	Sets a property to a string vector value in an element feature.
ElemFeature	setModifier(boolean flag, int bit)	Sets the modifier flags for this element.
java.lang.String	value()	Returns a value from an element feature.
ElemFeature	value(java.lang.String value)	Sets the value for an element feature.

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

field

ElemFeatureList field()

Returns all element features from field.

Returns:

List of element features.

field

ElemFeature field(java.lang.String name)

Returns an element feature from field.

Parameters:

name - field tag.

Returns:

Element feature.

getModifier

boolean getModifier(int bit)

Returns the value of the modifier flag. Seethe setModifier method for information about the supported flags.

Parameters:

bit - Flag's bit position.

Returns:

true or false.

isExpression

boolean isExpression()

Returns true if a string value represents an expression.

Returns:

true or false.

isExpression

ElemFeature isExpression(boolean isExpr)

Sets the expression flag for a string value.

Parameters:

isExpr - Expression flag.

Returns:

Element feature.

pos

ElemFeatureList pos()

Returns all element features from pos.

Returns:

List of element features.

pos

ElemFeature pos(int index)

Returns an element feature from pos.

Parameters:

index - Position index.

Returns:

Element feature.

selection

XDLocalSelection selection()

Returns the selection.

Specified by:

selection in interface SelectionEntity

Returns:

Selection.

set

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

Sets a property to a string value in an element feature.

Parameters:

name - Property name.

value - Property value.

Returns:

Element feature.

set

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

Sets a property to a string vector value in an element feature.

Parameters:

name - Property name.

value - Property value.

Returns:

Element feature.

set

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

Sets a property to a string vector value in an element feature.

Parameters:

name - Property name.

value - Property value.

Returns:

Element feature.

setModifier

ElemFeature setModifier(boolean flag,
                        int bit)

Sets the modifier flags for this element. Internally, each flag represents a bitin an integer value. The meaning of each supported flag is summarized below, andin some contexts the flag isn't used.
Bit 0: Flag is true when a string value represents an expression. See also isExpression.
Bit 1: Use record in standard selection elements (default is set).
Bit 2: Use record in extra-dimension selection elements (default is cleared).
Bit 3: Flag is true when a string value represents a geometry tag.
.

Parameters:

flag - Flag's value.

bit - Flag's bit position.

Returns:

Element feature.

value

java.lang.String value()

Returns a value from an element feature.

Returns:

Value.

value

ElemFeature value(java.lang.String value)

Sets the value for an element feature.

Parameters:

value - Value to set.

Returns:

Element feature.