Package com.comsol.model

Interface BatchFeature

All Superinterfaces:

ModelEntity, PrimitiveModelEntity, PropFeature, SelectionContainer, SelectionEntity

public interface BatchFeature
extends PropFeature

A batch job or a task.

Method Summary

Modifier and Type	Method	Description
void	attach(java.lang.String study)	Attaches a batch job to a study, which includes assigning it to the study.
void	continueRun()	Continues the batch job.
BatchFeature	create(java.lang.String tag, java.lang.String oper)	Create a batch feature.
void	detach()	Detaches the batch job from its study.
BatchFeatureList	feature()	Returns the tasks of a batch job.
BatchFeature	feature(java.lang.String tag)	Returns a task.
void	getInitialValue()	Computes initial value for the batch job.
boolean	isAttached()	Test if batch job is attached to a study.
void	run()	Runs the batch job.
void	run(boolean createPlots)	Runs the batch job and creates plots.
void	run(java.lang.String actionType)	Runs the batch job.
java.lang.String	study()	Returns the study of the batch job.
void	study(java.lang.String tag)	Assigns a batch job to a study.

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

Methods inherited from interface com.comsol.model.PropFeature

getAllowedPropertyValues, getBoolean, getBoolean, getBoolean, getBooleanArray, getBooleanMatrix, getDouble, getDouble, getDouble, getDoubleArray, getDoubleMatrix, getEntryKeyIndex, getEntryKeys, getInt, getInt, getInt, getIntArray, getIntMatrix, getReferenceArray, getString, getString, getString, getString, getStringArray, getStringMatrix, getType, getValueType, hasProperty, hasSelection, move, move, properties, remove, remove, selection, set, set, set, set, set, set, set, set, set, set, set, set, setEntry, setEntry, setEntry, setEntry, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex, setIndex

Methods inherited from interface com.comsol.model.SelectionEntity

selection

Method Detail

attach

void attach(java.lang.String study)

Attaches a batch job to a study, which includes assigning it to the study.

Parameters:

study - Study tag.

continueRun

void continueRun()

Continues the batch job.

create

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

Create a batch feature.

Parameters:

tag - Feature tag.

oper - Type of feature.

Returns:

Created batch feature.

detach

void detach()

Detaches the batch job from its study.

feature

BatchFeatureList feature()

Returns the tasks of a batch job.

Returns:

List of tasks.

feature

BatchFeature feature(java.lang.String tag)

Returns a task.

Parameters:

tag - Task tag.

Returns:

Task.

getInitialValue

void getInitialValue()

Computes initial value for the batch job.

isAttached

boolean isAttached()

Test if batch job is attached to a study.

Returns:

true if attached.

run

void run()

Runs the batch job.

run

void run(java.lang.String actionType)

Runs the batch job.

Parameters:

actionType - action type.

run

void run(boolean createPlots)

Runs the batch job and creates plots.

Parameters:

createPlots - Create plots.

study

java.lang.String study()

Returns the study of the batch job.

Returns:

Study tag.

study

void study(java.lang.String tag)

Assigns a batch job to a study.

Parameters:

tag - Study tag.