Uses of Class hdf.object.FileFormat (HDFView 3.1.2)

Packages that use FileFormat
Package	Description
hdf.object
hdf.object.fits
hdf.object.h4
hdf.object.h5
hdf.object.nc2
hdf.view
hdf.view.dialog
hdf.view.TreeView

Uses of FileFormat in hdf.object

Fields in hdf.object declared as FileFormat
Modifier and Type	Field	Description
`protected FileFormat`	HObject.`fileFormat`	The file which contains the object

Methods in hdf.object that return FileFormat
Modifier and Type	Method	Description
`FileFormat`	FileFormat.`create(String fileName)`	Deprecated. As of 2.4, replaced by `createFile(String, int)`
`FileFormat`	FileFormat.`createFile(String filename, int createFlag)`	Creates a file with the specified name and returns a new FileFormat implementation instance associated with the file.
`abstract FileFormat`	FileFormat.`createInstance(String filename, int access)`	Creates a FileFormat implementation instance with specified filename and access.
`static FileFormat`	FileFormat.`getFileFormat(String key)`	Returns the FileFormat with specified key from the list of supported formats.
`FileFormat`	HObject.`getFileFormat()`	Returns the file that contains the object.
`static FileFormat[]`	FileFormat.`getFileFormats()`	Returns an array of supported FileFormat instances.
`static FileFormat`	FileFormat.`getInstance(String filename)`	Creates a FileFormat instance for the specified file.
`FileFormat`	FileFormat.`open(String pathname, int access)`	Deprecated. As of 2.4, replaced by `createInstance(String, int)` The replacement method has identical functionality and a more descriptive name.
`static FileFormat`	FileFormat.`removeFileFormat(String key)`	Removes a FileFormat from the list of supported formats.

Methods in hdf.object with parameters of type FileFormat
Modifier and Type	Method	Description
`static void`	FileFormat.`addFileFormat(String key, FileFormat fileformat)`	Adds a FileFormat with specified key to the list of supported formats.
`static HObject`	FileFormat.`findObject(FileFormat file, long[] oid)`	Finds an object by its object ID
`static HObject`	FileFormat.`findObject(FileFormat file, String path)`	Finds an object by the full path of the object (path+name)
`abstract boolean`	FileFormat.`isThisType(FileFormat fileFormat)`	Checks if the class implements the specified FileFormat.

Constructors in hdf.object with parameters of type FileFormat
Constructor	Description
`CompoundDS(FileFormat theFile, String dsName, String dsPath)`	Constructs a CompoundDS object with the given file, dataset name and path.
`CompoundDS(FileFormat theFile, String dsName, String dsPath, long[] oid)`	Deprecated. Not for public use in the future. Using `CompoundDS(FileFormat, String, String)`
`Dataset(FileFormat theFile, String dsName, String dsPath)`	Constructs a Dataset object with a given file, name and path.
`Dataset(FileFormat theFile, String dsName, String dsPath, long[] oid)`	Deprecated. Not for public use in the future.
`Datatype(FileFormat theFile, int tclass, int tsize, int torder, int tsign, Datatype tbase, Datatype pbase)`	Constructs a Datatype with specified class, size, byte order and sign.
`Datatype(FileFormat theFile, long tid)`	Constructs a Datatype with a given native datatype identifier.
`Datatype(FileFormat theFile, long tid, Datatype pbase)`	Constructs a Datatype with a given native datatype identifier.
`Datatype(FileFormat theFile, String typeName, String typePath)`	Constructs a named datatype with a given file, name and path.
`Datatype(FileFormat theFile, String typeName, String typePath, long[] oid)`	Deprecated. Not for public use in the future. Using `Datatype(FileFormat, String, String)`
`Group(FileFormat theFile, String grpName, String grpPath, Group grpParent)`	Constructs an instance of the group with specific name, path and parent group.
`Group(FileFormat theFile, String grpName, String grpPath, Group grpParent, long[] oid)`	Deprecated. Not for public use in the future. Using `Group(FileFormat, String, String, Group)`
`HObject(FileFormat theFile, String theName, String thePath)`	Constructs an instance of a data object with specific name and path.
`HObject(FileFormat theFile, String theName, String thePath, long[] oid)`	Deprecated.
`ScalarDS(FileFormat theFile, String theName, String thePath)`	Constructs an instance of a ScalarDS with specific name and path.
`ScalarDS(FileFormat theFile, String theName, String thePath, long[] oid)`	Deprecated. Not for public use in the future. Using `ScalarDS(FileFormat, String, String)`

Uses of FileFormat in hdf.object.fits

Subclasses of FileFormat in hdf.object.fits
Modifier and Type	Class	Description
`class`	`FitsFile`	This class provides file level APIs.

Methods in hdf.object.fits that return FileFormat
Modifier and Type	Method	Description
`FileFormat`	FitsFile.`createInstance(String filename, int access)`	Creates a FitsFile instance with specified file name and READ access.

Methods in hdf.object.fits with parameters of type FileFormat
Modifier and Type	Method	Description
`boolean`	FitsFile.`isThisType(FileFormat fileformat)`	Checks if the given file format is a Fits file.

Constructors in hdf.object.fits with parameters of type FileFormat
Constructor	Description
`FitsDataset(FileFormat fileFormat, nom.tam.fits.BasicHDU hdu, String dName, long[] oid)`	Constructs an FitsDataset object with specific netcdf variable.
`FitsGroup(FileFormat fileFormat, String name, String path, Group parent, long[] theID)`	Constructs an HDF5 group with specific name, path, and parent.

Uses of FileFormat in hdf.object.h4

Subclasses of FileFormat in hdf.object.h4
Modifier and Type	Class	Description
`class`	`H4File`	This class provides file level APIs.

Methods in hdf.object.h4 that return FileFormat
Modifier and Type	Method	Description
`FileFormat`	H4File.`createFile(String filename, int createFlag)`	Creates an HDF4 file with the specified name and returns a new H4File instance associated with the file.
`FileFormat`	H4File.`createInstance(String filename, int access)`	Creates an H4File instance with specified file name and access.

Methods in hdf.object.h4 with parameters of type FileFormat
Modifier and Type	Method	Description
`boolean`	H4File.`isThisType(FileFormat fileformat)`	Checks if the given file format is an HDF4 file.

Constructors in hdf.object.h4 with parameters of type FileFormat
Constructor	Description
`H4GRImage(FileFormat theFile, String name, String path)`
`H4GRImage(FileFormat theFile, String name, String path, long[] oid)`	Creates a H4GRImage object with specific name, path, and object ID.
`H4Group(FileFormat theFile, String name, String path, Group parent)`
`H4Group(FileFormat theFile, String name, String path, Group parent, long[] oid)`	Creates a group object with specific name, path, and parent.
`H4SDS(FileFormat theFile, String name, String path)`
`H4SDS(FileFormat theFile, String name, String path, long[] oid)`	Creates an H4SDS object with specific name and path.
`H4Vdata(FileFormat theFile, String name, String path)`
`H4Vdata(FileFormat theFile, String name, String path, long[] oid)`	Creates an H4Vdata object with specific name and path.

Uses of FileFormat in hdf.object.h5

Subclasses of FileFormat in hdf.object.h5
Modifier and Type	Class	Description
`class`	`H5File`	H5File is an implementation of the FileFormat class for HDF5 files.

Methods in hdf.object.h5 that return FileFormat
Modifier and Type	Method	Description
`FileFormat`	H5File.`createFile(String filename, int createFlag)`	Creates an HDF5 file with the specified name and returns a new H5File instance associated with the file.
`FileFormat`	H5File.`createInstance(String filename, int access)`	Creates an H5File instance with specified file name and access.

Methods in hdf.object.h5 with parameters of type FileFormat
Modifier and Type	Method	Description
`boolean`	H5File.`isThisType(FileFormat theFile)`	Checks if the specified FileFormat instance has the HDF5 format.

Constructors in hdf.object.h5 with parameters of type FileFormat
Constructor	Description
`H5CompoundDS(FileFormat theFile, String theName, String thePath)`	Constructs an instance of a HDF5 compound dataset with given file, dataset name and path.
`H5CompoundDS(FileFormat theFile, String theName, String thePath, long[] oid)`	Deprecated. Not for public use in the future. Using `H5CompoundDS(FileFormat, String, String)`
`H5Datatype(FileFormat theFile, long nativeID)`	Constructs a Datatype with a given native datatype identifier.
`H5Datatype(FileFormat theFile, long nativeID, Datatype pbase)`	Constructs a Datatype with a given native datatype identifier.
`H5Datatype(FileFormat theFile, String name, String path)`	Constructs an named HDF5 data type object for a given file, dataset name and group path.
`H5Datatype(FileFormat theFile, String name, String path, long[] oid)`	Deprecated. Not for public use in the future.
`H5Group(FileFormat theFile, String name, String path, Group parent)`	Constructs an HDF5 group with specific name, path, and parent.
`H5Group(FileFormat theFile, String name, String path, Group parent, long[] oid)`	Deprecated. Not for public use in the future. Using `H5Group(FileFormat, String, String, Group)`
`H5Link(FileFormat theFile, String name, String path)`	Constructs an HDF5 link with specific name, path, and parent.
`H5Link(FileFormat theFile, String theName, String thePath, long[] oid)`
`H5ScalarDS(FileFormat theFile, String theName, String thePath)`	Constructs an instance of a H5 scalar dataset with given file, dataset name and path.
`H5ScalarDS(FileFormat theFile, String theName, String thePath, long[] oid)`	Deprecated. Not for public use in the future. Using `H5ScalarDS(FileFormat, String, String)`

Uses of FileFormat in hdf.object.nc2

Subclasses of FileFormat in hdf.object.nc2
Modifier and Type	Class	Description
`class`	`NC2File`	This class provides file level APIs.

Methods in hdf.object.nc2 that return FileFormat
Modifier and Type	Method	Description
`FileFormat`	NC2File.`createInstance(String filename, int access)`	Creates a NC2File instance with specified file name and READ access.

Methods in hdf.object.nc2 with parameters of type FileFormat
Modifier and Type	Method	Description
`boolean`	NC2File.`isThisType(FileFormat fileformat)`	Checks if the given file format is a NetCDF3 file.

Constructors in hdf.object.nc2 with parameters of type FileFormat
Constructor	Description
`NC2Dataset(FileFormat fileFormat, ucar.nc2.Variable ncDataset, long[] oid)`	Constructs an NC2Dataset object with specific netcdf variable.
`NC2Group(FileFormat fileFormat, String name, String path, Group parent, long[] theID)`	Constructs an NC2 group with specific name, path, and parent.

Uses of FileFormat in hdf.view

Methods in hdf.view that return FileFormat
Modifier and Type	Method	Description
`static FileFormat`	Tools.`createNewFile(String filename, String dir, String type, List<FileFormat> openFiles)`	Create a new HDF file with default file creation properties

Methods in hdf.view with parameters of type FileFormat
Modifier and Type	Method	Description
`void`	HDFView.`closeFile(FileFormat theFile)`
`void`	HDFView.`writeDataToFile(FileFormat theFile)`	Write the change of data to the given file.

Method parameters in hdf.view with type arguments of type FileFormat
Modifier and Type	Method	Description
`static FileFormat`	Tools.`createNewFile(String filename, String dir, String type, List<FileFormat> openFiles)`	Create a new HDF file with default file creation properties

Uses of FileFormat in hdf.view.dialog

Fields in hdf.view.dialog declared as FileFormat
Modifier and Type	Field	Description
`protected FileFormat`	NewDataObjectDialog.`fileFormat`

Constructor parameters in hdf.view.dialog with type arguments of type FileFormat
Constructor	Description
`ImageConversionDialog(org.eclipse.swt.widgets.Shell parent, String typeFrom, String typeTo, String dir, List<FileFormat> openFiles)`	Constructs a FileConversionDialog

Uses of FileFormat in hdf.view.TreeView

Methods in hdf.view.TreeView that return FileFormat
Modifier and Type	Method	Description
`FileFormat`	DefaultTreeView.`getSelectedFile()`	Gets the selected file.
`FileFormat`	TreeView.`getSelectedFile()`	Gets the selected the file.
`FileFormat`	DefaultTreeView.`openFile(String filename, int accessID)`	Opens a file and retrieves the file structure of the file.
`FileFormat`	TreeView.`openFile(String filename, int accessID)`	Opens a file and retrieves the file structure of the file.
`FileFormat`	DefaultTreeView.`reopenFile(FileFormat fileFormat, int newFileAccessMode)`
`FileFormat`	TreeView.`reopenFile(FileFormat theFile, int newFileAccessMode)`

Methods in hdf.view.TreeView that return types with arguments of type FileFormat
Modifier and Type	Method	Description
`List<FileFormat>`	DefaultTreeView.`getCurrentFiles()`
`List<FileFormat>`	TreeView.`getCurrentFiles()`

Methods in hdf.view.TreeView with parameters of type FileFormat
Modifier and Type	Method	Description
`void`	DefaultTreeView.`closeFile(FileFormat file)`	Close a file
`void`	TreeView.`closeFile(FileFormat file)`	close a file
`FileFormat`	DefaultTreeView.`reopenFile(FileFormat fileFormat, int newFileAccessMode)`
`FileFormat`	TreeView.`reopenFile(FileFormat theFile, int newFileAccessMode)`
`void`	DefaultTreeView.`saveFile(FileFormat file)`	Save a file
`void`	TreeView.`saveFile(FileFormat file)`	save a file