This class is useful for generating catalogs of files.
Calling the "make" method will create a FITS output catalog
with the standard format. The genral user does not need
to worry about any of the other methods.
Certain catalog information is accumulated in the class data.
This makes it more efficient to generate more than one catalog
containing identical files.
It also allows the "all_files" and "fits_files" methods to
give lists
of files in the union of all catalogs created so far.
Sub-classes may change the format of the catalog file
by overriding some of the methods. The Util::HTMLcatalog class
does this.
Constructor
Accessors
- filename()
Set or return the filename generator object for this class.
- future_files(type=>format, type=>format...)
Set the files which we should not expect to exist yet when we
are making the catalog.
- fits_files()
Returns a list of all FITS format files appearing in all
catalogs created so far.
- all_files()
Returns a list of all files appearing in all
catalogs created so far.
Methods
- format(file)
Determine the format (FITS, ASCII, etc.) of a file.
- size(file)
Determine the size of a file in kilobytes.
- add_file(file, type, classes, description)
Add a file to the catalog.
- files_of_type(type)
Return all the files of a given type.
- add_type(type)
Add all the files of a given type to the catalog.
- fill()
Add all the files of all the file types to the catalog.
- close()
Actually write the catalog file.
- make()
Fill and close the catalog.
- register_in_parfile(param)
Add the name of the catalog to the parfile.
Special Methods
- BEGIN()
Initialize some of the class data.