casacore::StorageOption Class Reference

Options defining how table files are organized. More...

#include <StorageOption.h>

List of all members.

Public Types
enum	Option {   MultiFile,   MultiHDF5,   SepFile,   Default,   Aipsrc }
	Define the possible options how table files are organized. More...
Public Member Functions
	StorageOption (Option option=Aipsrc, Int blockSize=-2)
	Create an option object.
void	fillOption ()
	Fill the option in case Aipsrc or Default was given.
Option	option () const
	Get the option.
void	setOption (Option option)
	Set the option.
uInt	blockSize () const
	Get the block size.
void	setBlockSize (Int blockSize)
	Set the block size.
Private Attributes
Option	itsOption
Int	itsBlockSize

---

Detailed Description

Options defining how table files are organized.

Intended use:

Public interface

Review Status

Reviewed By:

TPPR

Date Reviewed:

08.11.94

Test programs:

tTable

Synopsis

This class can be used to define how the files of a table are organized. There are two ways:

1. The old way where each storage manager has its own file(s).
2. Using MultiFile that storage managers can use to combine about all table files in a single file. This mode is particularly useful for new file systems (like Lustre) requiring large block sizes.
   The block size to be used in a MultiFile can be defined in this class. Default is 4 MByte.
3. Using MultiHDF5 which behaves similar to MultiFile but uses an HDF5 file instead of a regular file.

It is possible to specify the storage type and block size using aipsrc. The aipsrc variables are:

• tables.storage.type. The (case-insensitive) value can be 'multifile' or 'multihdf5'. Another value means the old way (separate files).
• tables.storage.blocksize gives the default blocksize to be used for the multifile and multihdf5 option.

Definition at line 71 of file StorageOption.h.

---

Member Enumeration Documentation

enum casacore::StorageOption::Option

Define the possible options how table files are organized.

Enumerator:

MultiFile	Let storage managers use a combined MultiFile.
MultiHDF5	Let storage managers use a combined MultiHDF5.
SepFile	Let storage managers use separate files.
Default	Use default (currently MultiFile).
Aipsrc	Use as defined in the aipsrc file.

Definition at line 75 of file StorageOption.h.

---

Constructor & Destructor Documentation

casacore::StorageOption::StorageOption	(	Option	option = Aipsrc,
		Int	blockSize = -2
	)

Create an option object.

The parameter values are described in the synopsis. A size value -2 means reading that size from the aipsrc file.

---

Member Function Documentation

uInt casacore::StorageOption::blockSize

(

)

const [inline]

Get the block size.

Definition at line 106 of file StorageOption.h.

References itsBlockSize.

void casacore::StorageOption::fillOption

(

)

Fill the option in case Aipsrc or Default was given.

It is done as explained in the synopsis.

Option casacore::StorageOption::option

(

)

const [inline]

Get the option.

Definition at line 98 of file StorageOption.h.

References itsOption.

void casacore::StorageOption::setBlockSize

(

Int

blockSize

)

[inline]

Set the block size.

Definition at line 110 of file StorageOption.h.

References itsBlockSize.

void casacore::StorageOption::setOption

(

Option

option

)

[inline]

Set the option.

Definition at line 102 of file StorageOption.h.

References itsOption.

---

Member Data Documentation

Int casacore::StorageOption::itsBlockSize [private]

Definition at line 115 of file StorageOption.h.

Referenced by blockSize(), and setBlockSize().

Option casacore::StorageOption::itsOption [private]

Definition at line 114 of file StorageOption.h.

Referenced by option(), and setOption().

---

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

• casacore/tables/Tables/StorageOption.h