com.comsol.model

Interface BatchList

All Superinterfaces:

java.lang.Iterable<PropFeature>, ModelEntity, PrimitiveModelEntity

public interface BatchList
extends ModelEntity, java.lang.Iterable<PropFeature>

List of batch jobs.

Method Summary

Modifier and Type	Method and Description
void	clear() Remove all entities in the list.
BatchFeature	create(java.lang.String tag, java.lang.String type) Creates a batch job.
BatchFeatureList	feature() Returns the tasks of a batch job.
BatchFeature	get(java.lang.String tag) Returns a batch job.
void	remove(java.lang.String tag) Removes a batch job.
int	size() Returns the number of batch jobs.
java.lang.String[]	tags() Returns the tags of the batch jobs.

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

clear

void clear()

Remove all entities in the list.

create

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

Creates a batch job.

Parameters:

tag - Batch job tag.

type - Batch job type: Parametric, Batch, or Cluster.

Returns:

Created batch job.

feature

BatchFeatureList feature()

Returns the tasks of a batch job.

Returns:

List of tasks.

get

BatchFeature get(java.lang.String tag)

Returns a batch job.

Parameters:

tag - Batch job tag.

Returns:

Batch job tag.

remove

void remove(java.lang.String tag)

Removes a batch job.

Parameters:

tag - Batch job tag.

size

int size()

Returns the number of batch jobs.

Returns:

Number of batch jobs.

tags

java.lang.String[] tags()

Returns the tags of the batch jobs.

Returns:

Batch job tags.