utils.ZipArchive Class Reference

Class to create and update zip archives that contain simulation result files. More...

Public Member Functions
	ZipArchive (String zipFileName) throws IOException
	Constructor to open a zip file output stream and set the zip file name. More...
final void	addToZipArchiveAndDelete (File f) throws IOException
	Adds a simulation results file to its respective zip archive and then deletes the result file. More...
final void	addToZipArchiveAndKeepLast (File f, File fNew) throws IOException
	Adds a simulation results file to its respective zip archive, and keeps the result file under a specified name. More...
void	close () throws IOException
	Closes the zip file results archive. More...

Detailed Description

Class to create and update zip archives that contain simulation result files.

iDynoMiCS simulations can produce a large number of result files, depending on the output period specified. With each timestep these files are added to a zip archive to keep these files together. This class contains methods to create and update these files

Constructor & Destructor Documentation

utils.ZipArchive.ZipArchive

(

String

zipFileName

)

throws IOException

Constructor to open a zip file output stream and set the zip file name.

Constructor to open a zip file output stream and set the zip file name

Parameters

zipFileName

The name assigned to this zip file of simulation results

Exceptions

IOException

Exception thrown if this stream cannot be opened

Member Function Documentation

final void utils.ZipArchive.addToZipArchiveAndDelete

(

File

f

)

throws IOException

Adds a simulation results file to its respective zip archive and then deletes the result file.

Add a simulation results file to its respective zip archive. The file itself is deleted after this has occurred

Parameters

f	The results file to be added to the zip archive

Exceptions

IOException

Exception thrown if this zip file cannot be opened

final void utils.ZipArchive.addToZipArchiveAndKeepLast	(	File	f,
		File	fNew
	)		throws IOException

Adds a simulation results file to its respective zip archive, and keeps the result file under a specified name.

Add a simulation results file to its respective zip archive. In this version of the method the result file is retained

Parameters

f	The results file to be added to the zip archive
fNew	The new name to be assigned to this results file

Exceptions

IOException

Exception thrown if this stream cannot be opened

void utils.ZipArchive.close

(

)

throws IOException

Closes the zip file results archive.

Closes the zip file results archive

Exceptions

IOException

Exception thrown if the file cannot be closed

---

The documentation for this class was generated from the following file:

• /home/kieran/Dropbox/workspace/iDynoMiCS/src/utils/ZipArchive.java