Package mgui.io.domestic.shapes

Class VolumeOutputOptions

java.lang.Object

mgui.interfaces.InterfaceOptions

mgui.io.InterfaceIOOptions

mgui.io.domestic.shapes.VolumeOutputOptions

All Implemented Interfaces:

InterfaceObject, NamedObject, TreeObject, CleanableObject, XMLObject

public class VolumeOutputOptions
extends InterfaceIOOptions

Specifies options for outputting a Volume3DInt to persistent storage.

Since:

1.0

Version:

1.0

Author:

Andrew Reid

Nested Class Summary

Nested classes/interfaces inherited from interface mgui.interfaces.xml.XMLObject

XMLObject.XMLEncoding, XMLObject.XMLType

Field Summary

Fields

Modifier and Type	Field	Description
boolean	apply_masks
boolean	compress
int	datatype
java.io.File[]	files
boolean	flipX
boolean	flipY
boolean	flipZ
double	intercept
short	qform_code
short	sform_code
double	slope
java.lang.String	use_column
Volume3DInt[]	volumes

Constructor Summary

Constructors

Constructor	Description
VolumeOutputOptions()

Method Summary

Modifier and Type	Method	Description
javax.swing.JFileChooser	getFileChooser()	Returns a file chooser appropriate for this options instance
javax.swing.JFileChooser	getFileChooser(java.io.File f)	Returns a file chooser appropriate for this options instance
java.io.File[]	getFiles()	Returns the list of files associated with this options instance
java.lang.String	getXML(int tab)	Returns this object's XML representation as a single string.
void	handleXMLElementStart(java.lang.String localName, org.xml.sax.Attributes attributes, XMLObject.XMLType type)	Handles the start of an XML element.
void	setFiles(java.io.File[] files)	Sets the list of files associated with this options instance
void	setFromComplementaryOptions(InterfaceIOOptions options)	Sets the values of this object from those of options, defined for its complementary I/O interface.
void	setObject(InterfaceObject obj)	Sets the object on which to perform an I/O operation

Methods inherited from class mgui.io.InterfaceIOOptions

getDTD, getLocalName, getShortXML, getXML, getXMLSchema, handleXMLElementEnd, handleXMLString, writeXML, writeXML, writeXML

Methods inherited from class mgui.interfaces.InterfaceOptions

clean, destroy, getName, getTreeLabel, isDestroyed, issueTreeNode, setName, setTreeNode

Methods inherited from class java.lang.Object

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

Field Details

datatype

public int datatype

files

public java.io.File[] files

volumes

public Volume3DInt[] volumes

intercept

public double intercept

slope

public double slope

use_column

public java.lang.String use_column

apply_masks

public boolean apply_masks

compress

public boolean compress

sform_code

public short sform_code

qform_code

public short qform_code

flipX

public boolean flipX

flipY

public boolean flipY

flipZ

public boolean flipZ

Constructor Details

VolumeOutputOptions

public VolumeOutputOptions()

Method Details

getFileChooser

public javax.swing.JFileChooser getFileChooser()

Description copied from class: InterfaceIOOptions

Returns a file chooser appropriate for this options instance

Specified by:

getFileChooser in class InterfaceIOOptions

Returns:

getFileChooser

public javax.swing.JFileChooser getFileChooser(java.io.File f)

Description copied from class: InterfaceIOOptions

Returns a file chooser appropriate for this options instance

Specified by:

getFileChooser in class InterfaceIOOptions

Returns:

getFiles

public java.io.File[] getFiles()

Description copied from class: InterfaceIOOptions

Returns the list of files associated with this options instance

Specified by:

getFiles in class InterfaceIOOptions

Returns:

setFiles

public void setFiles(java.io.File[] files)

Description copied from class: InterfaceIOOptions

Sets the list of files associated with this options instance

Specified by:

setFiles in class InterfaceIOOptions

setObject

public void setObject(InterfaceObject obj)
               throws java.lang.ClassCastException

Description copied from class: InterfaceIOOptions

Sets the object on which to perform an I/O operation

Specified by:

setObject in class InterfaceIOOptions

Throws:

java.lang.ClassCastException - if obj is the wrong class for this options instance

setFromComplementaryOptions

public void setFromComplementaryOptions(InterfaceIOOptions options)

Description copied from class: InterfaceIOOptions

Sets the values of this object from those of options, defined for its complementary I/O interface.

Overrides:

setFromComplementaryOptions in class InterfaceIOOptions

getXML

public java.lang.String getXML(int tab)

Description copied from interface: XMLObject

Returns this object's XML representation as a single string. NOTE: this is not feasible for larger objects and containers, thus may not be implemented for these objects. Use the XMLObject.writeXML(int,java.io.Writer,mgui.io.standard.xml.XMLOutputOptions,mgui.interfaces.ProgressUpdater) functions to write larger objects to file.

Specified by:

getXML in interface XMLObject

Overrides:

getXML in class InterfaceIOOptions

Parameters:

tab - The number of tabs to place before the opening XML wrapper

Returns:

handleXMLElementStart

public void handleXMLElementStart(java.lang.String localName,
org.xml.sax.Attributes attributes,
XMLObject.XMLType type)
                           throws org.xml.sax.SAXException

Description copied from interface: XMLObject

Handles the start of an XML element.

Specified by:

handleXMLElementStart in interface XMLObject

Overrides:

handleXMLElementStart in class InterfaceIOOptions

Parameters:

localName - Local name of the element

attributes - Set of element attributes

type - The XMLType of this element

Throws:

org.xml.sax.SAXException