Package com.comsol.model

Interface ReportFeature

All Superinterfaces:

ModelEntity, PrimitiveModelEntity, PropFeature, ResultBaseFeature, SelectionContainer, SelectionEntity

public interface ReportFeature
extends ResultBaseFeature

Model report feature.

Method Summary

Modifier and Type	Method	Description
ReportFeature	create(java.lang.String tag, java.lang.String type)	Creates a report feature.
void	discardTemplateFile()	Discards the imported imported CSS-file or Microsoft Word or PowerPoint template file, if any.
void	exportTemplateFile(java.lang.String filename)	Exports a imported CSS-file or Microsoft Word or PowerPoint template to the specified file.
ReportFeatureList	feature()	Gets all children of this report feature.
ReportFeature	feature(java.lang.String tag)	Returns the child feature with the given tag.
void	generate()	Generates a report at the current level.
int	getSectionLevel()	Gets the section level.
void	importTemplateFile()	Imports the currently specified imported CSS-file or Microsoft Word or PowerPoint template.
void	importTemplateFile(java.lang.String filename)	Imports a imported CSS-file or Microsoft Word or PowerPoint template from the specified file.
void	refreshTemplateFile()	Rereads the imported CSS-file or Microsoft Word or PowerPoint template file, if any.
void	run()	Writes the report.

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

hasWarning, problem, problem, runCommand

Methods inherited from interface com.comsol.model.SelectionEntity

selection

Method Detail

create

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

Creates a report feature.

Parameters:

tag - Report feature tag.

type - Report feature type.

Returns:

The created report feature.

discardTemplateFile

void discardTemplateFile()

Discards the imported imported CSS-file or Microsoft Word or PowerPoint template file, if any.

exportTemplateFile

void exportTemplateFile(java.lang.String filename)

Exports a imported CSS-file or Microsoft Word or PowerPoint template to the specified file.

Parameters:

filename - Filename.

feature

ReportFeatureList feature()

Gets all children of this report feature.

Returns:

A list of report features.

feature

ReportFeature feature(java.lang.String tag)

Returns the child feature with the given tag.

Parameters:

tag - The feature tag.

Returns:

A report feature.

generate

void generate()

Generates a report at the current level.

getSectionLevel

int getSectionLevel()

Gets the section level.

Returns:

The section level (0 for the root).

importTemplateFile

void importTemplateFile()

Imports the currently specified imported CSS-file or Microsoft Word or PowerPoint template.

importTemplateFile

void importTemplateFile(java.lang.String filename)

Imports a imported CSS-file or Microsoft Word or PowerPoint template from the specified file.

Parameters:

filename - Filename.

refreshTemplateFile

void refreshTemplateFile()

Rereads the imported CSS-file or Microsoft Word or PowerPoint template file, if any.

run

void run()

Writes the report.