Package mgui.io.foreign.caret

Class CaretPaintWriter

java.lang.Object

mgui.io.FileWriter

mgui.io.domestic.shapes.SurfaceDataFileWriter

mgui.io.foreign.caret.CaretPaintWriter

All Implemented Interfaces:

InterfaceIO, IconObject

public class CaretPaintWriter
extends SurfaceDataFileWriter

Writes a set of vertex-wise data columns to Caret paint files, binary format version 1.

Since:

1.0

Version:

1.0

Author:

Andrew Reid

Field Summary

Fields inherited from class mgui.io.FileWriter

dataFile, dataURL, failure_message, options, success_message

Constructor Summary

Constructors

Constructor	Description
CaretPaintWriter()

Method Summary

Modifier and Type	Method	Description
protected NameMap	getDefaultNameMap(Mesh3DInt mesh, java.lang.String column)
void	setFormat(java.lang.String format)
boolean	write(InterfaceIOOptions options, ProgressUpdater progress_bar)	Writes this object according to the given options.
protected boolean	writeHeader(SurfaceDataOutputOptions options, java.lang.String column)
boolean	writeValues(java.util.ArrayList<MguiNumber> values, ProgressUpdater progressBar)	Overridden from SurfaceDataFileWriter.
boolean	writeValues(SurfaceDataOutputOptions options, java.lang.String column, ProgressUpdater progressBar)

Methods inherited from class mgui.io.domestic.shapes.SurfaceDataFileWriter

getFailureMessage, getObjectIcon, getSuccessMessage, getSupportedObjects, getTitle, writeValues

Methods inherited from class mgui.io.FileWriter

getComplementIOType, getFile, getIOType, getLoaderComplement, getOptions, getProgressMessage, getURL, setFile, setOptions, setURL, toString, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

CaretPaintWriter

public CaretPaintWriter()

Method Details

setFormat

public void setFormat(java.lang.String format)

Specified by:

setFormat in class SurfaceDataFileWriter

write

public boolean write(InterfaceIOOptions options,
ProgressUpdater progress_bar)

Description copied from class: FileWriter

Writes this object according to the given options. If loaded object is of type PersistentObject, this method should also set the file writer and reference URL for the object.

Overrides:

write in class SurfaceDataFileWriter

Returns:

writeValues

public boolean writeValues(SurfaceDataOutputOptions options,
java.lang.String column,
ProgressUpdater progressBar)

writeValues

public boolean writeValues(java.util.ArrayList<MguiNumber> values,
ProgressUpdater progressBar)

Overridden from SurfaceDataFileWriter. In the case of this writer, however, one should only use the writeValues(SurfaceDataOutputOptions options, String column, ProgressUpdater progressBar) and write(InterfaceIOOptions options, ProgressUpdater progress_bar) methods, as this format requires a header to be written in additional to vertex values. Used on its own, this method will do nothing and will always return false.

Specified by:

writeValues in class SurfaceDataFileWriter

Parameters:

values - the values to write

progressBar - the progress updater (not utilized here)

writeHeader

protected boolean writeHeader(SurfaceDataOutputOptions options,
java.lang.String column)

getDefaultNameMap

protected NameMap getDefaultNameMap(Mesh3DInt mesh,
java.lang.String column)