casacore::PlainTable Class Reference

Class defining a plain regular table. More...

#include <PlainTable.h>

Inheritance diagram for casacore::PlainTable:

Public Member Functions
	PlainTable (SetupNewTable &, uInt nrrow, Bool initialize, const TableLock &lockOptions, int endianFormat, const TSMOption &tsmOption)
	Construct the object for a new table.
	PlainTable (AipsIO &, uInt version, const String &name, const String &type, uInt nrrow, int option, const TableLock &lockOptions, const TSMOption &tsmOption, Bool addToCache, uInt locknr)
	Construct the object for an existing table.
virtual	~PlainTable ()
	The destructor flushes (i.e.
virtual void	reopenRW ()
	Try to reopen the table for read/write access.
virtual Bool	asBigEndian () const
	Is the table stored in big or little endian format?
virtual const StorageOption &	storageOption () const
	Get the storage option used for the table.
virtual Bool	isMultiUsed (Bool checkSubTables) const
	Is the table in use (i.e.
virtual const TableLock &	lockOptions () const
	Get the locking info.
virtual void	mergeLock (const TableLock &lockOptions)
	Merge the given lock info with the existing one.
virtual Bool	hasLock (FileLocker::LockType) const
	Has this process the read or write lock, thus can the table be read or written safely?
virtual Bool	lock (FileLocker::LockType, uInt nattempts)
	Try to lock the table for read or write access.
virtual void	unlock ()
	Unlock the table.
void	autoReleaseLock (Bool always=False)
	Do a release of an AutoLock when the inspection interval has expired.
virtual void	flush (Bool fsync, Bool recursive)
	Flush the table, i.e.
virtual void	resync ()
	Resync the Table object with the table file.
virtual uInt	getModifyCounter () const
	Get the modify counter.
virtual void	setTableChanged ()
	Set the table to being changed.
virtual Bool	isWritable () const
	Test if the table is opened as writable.
virtual TableDesc	actualTableDesc () const
	Get the actual table description.
virtual Record	dataManagerInfo () const
	Get the data manager info.
virtual TableRecord &	keywordSet ()
	Get readonly access to the table keyword set.
virtual TableRecord &	rwKeywordSet ()
	Get read/write access to the table keyword set.
virtual BaseColumn *	getColumn (uInt columnIndex) const
	Get a column object using its index.
virtual BaseColumn *	getColumn (const String &columnName) const
	Get a column object using its name.
virtual Bool	canAddRow () const
	Test if it is possible to add a row to this table.
virtual void	addRow (uInt nrrow, Bool initialize)
	Add one or more rows and possibly initialize them.
virtual Bool	canRemoveRow () const
	Test if it is possible to remove a row from this table.
virtual void	removeRow (uInt rownr)
	Remove the given row.
virtual void	addColumn (const ColumnDesc &columnDesc, Bool)
	Add a column to the table.
virtual void	addColumn (const ColumnDesc &columnDesc, const String &dataManager, Bool byName, Bool)
virtual void	addColumn (const ColumnDesc &columnDesc, const DataManager &dataManager, Bool)
virtual void	addColumn (const TableDesc &tableDesc, const DataManager &dataManager, Bool)
virtual Bool	canRemoveColumn (const Vector< String > &columnNames) const
	Test if columns can be removed.
virtual void	removeColumn (const Vector< String > &columnNames)
	Remove columns.
virtual Bool	canRenameColumn (const String &columnName) const
	Test if a column can be renamed (yes).
virtual void	renameColumn (const String &newName, const String &oldName)
	Rename a column.
virtual void	renameHypercolumn (const String &newName, const String &oldName)
	Rename a hypercolumn.
virtual DataManager *	findDataManager (const String &name, Bool byColumn) const
	Find the data manager with the given name or for the given column.
Static Public Member Functions
static void	getLayout (TableDesc &desc, AipsIO &ios)
	Return the layout of a table (i.e.
static ByteIO::OpenOption	toAipsIOFoption (int tableOption)
	Convert a Table option to an AipsIO file option.
static TableCache &	tableCache ()
	Get access to the TableCache.
Private Member Functions
	PlainTable (const PlainTable &)
	Copy constructor is forbidden, because copying a table requires some more knowledge (like table name of result).
PlainTable &	operator= (const PlainTable &)
	Assignment is forbidden, because copying a table requires some more knowledge (like table name of result).
void	closeObject ()
	Close the object which is called by the destructor.
virtual void	renameSubTables (const String &newName, const String &oldName)
	Rename the subtables (used by rename function).
MemoryIO *	doReleaseCallBack (Bool always)
Bool	putFile (Bool always)
	When needed, write the table control information in an AipsIO file.
void	syncTable ()
	Synchronize the table after having acquired a lock which says that main table data has changed.
void	setEndian (int endianFormat)
	Determine and set the endian format (big or little).
void	checkWritable (const char *func) const
	Throw an exception if the table is not writable.
Static Private Member Functions
static MemoryIO *	releaseCallBack (void *plainTableObject, Bool always)
	The callback function when a lock is released.
Private Attributes
ColumnSet *	colSetPtr_p
Bool	tableChanged_p
Bool	addToCache_p
TableLockData *	lockPtr_p
TableSyncData	lockSync_p
Bool	bigEndian_p
TSMOption	tsmOption_p
Static Private Attributes
static TableCache	theirTableCache

Detailed Description

Class defining a plain regular table.

Intended use:

Internal

Review Status

Reviewed By:: UNKNOWN
Date Reviewed:: before2004/08/25

Prerequisite

Etymology

PlainTable represents a plain regular table. This is opposed to a RefTable, which is a view on a PlainTable.

Synopsis

PlainTable is a table consisting of a keyword set and a number of filled and virtual columns. The table control information and the keyword set is stored in an AipsIO file. The data in the filled columns are stored separately by storage managers.

To Do

notify RefTable's when deleting rows

Definition at line 85 of file PlainTable.h.

Constructor & Destructor Documentation

casacore::PlainTable::PlainTable	(	SetupNewTable &	,
		uInt	nrrow,
		Bool	initialize,
		const TableLock &	lockOptions,
		int	endianFormat,
		const TSMOption &	tsmOption
	)

Construct the object for a new table.

It creates storage manager(s) for unbound columns and initializes all storage managers. The given number of rows is stored in the table and initialized if the flag is set.

casacore::PlainTable::PlainTable	(	AipsIO &	,
		uInt	version,
		const String &	name,
		const String &	type,
		uInt	nrrow,
		int	option,
		const TableLock &	lockOptions,
		const TSMOption &	tsmOption,
		Bool	addToCache,
		uInt	locknr
	)

Construct the object for an existing table.

It opens the table file, reads the table control information and creates and initializes the required storage managers.

virtual casacore::PlainTable::~PlainTable ( ) [virtual]

The destructor flushes (i.e.

writes) the table if it is opened for output and not marked for delete.

casacore::PlainTable::PlainTable ( const PlainTable & ) [private]

Copy constructor is forbidden, because copying a table requires some more knowledge (like table name of result).

Declaring it private, makes it unusable.

Member Function Documentation

virtual TableDesc casacore::PlainTable::actualTableDesc ( ) const [virtual]

Get the actual table description.

virtual void casacore::PlainTable::addColumn	(	const TableDesc &	tableDesc,
		const DataManager &	dataManager,
		Bool
	)			`[virtual]`

virtual void casacore::PlainTable::addColumn	(	const ColumnDesc &	columnDesc,
		const DataManager &	dataManager,
		Bool
	)			`[virtual]`

virtual void casacore::PlainTable::addRow	(	uInt	nrrow,
		Bool	initialize
	)			`[virtual]`

virtual DataManager* casacore::PlainTable::findDataManager	(	const String &	name,
		Bool	byColumn
	)			const `[virtual]`

virtual void casacore::PlainTable::flush	(	Bool	fsync,
		Bool	recursive
	)			`[virtual]`

static void casacore::PlainTable::getLayout	(	TableDesc &	desc,
		AipsIO &	ios
	)			`[static]`

virtual Bool casacore::PlainTable::lock	(	FileLocker::LockType	,
		uInt	nattempts
	)			`[virtual]`

static MemoryIO* casacore::PlainTable::releaseCallBack	(	void *	plainTableObject,
		Bool	always
	)			`[static, private]`

virtual void casacore::PlainTable::renameColumn	(	const String &	newName,
		const String &	oldName
	)			`[virtual]`

casacore::PlainTable Class Reference

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes