Class defining a plain regular table. More...

#include <PlainTable.h>

Inheritance diagram for casacore::PlainTable:

Public Member Functions
	PlainTable (SetupNewTable &, rownr_t nrrow, Bool initialize, const TableLock &lockOptions, int endianFormat, const TSMOption &tsmOption)
	Construct the object for a new table. More...

	PlainTable (MPI_Comm mpiComm, SetupNewTable &, rownr_t nrrow, Bool initialize, const TableLock &lockOptions, int endianFormat, const TSMOption &tsmOption)
	MPI version of the constructor. More...

void	PlainTableCommon (SetupNewTable &, rownr_t nrrow, Bool initialize, const TableLock &lockOptions, int endianFormat, const TSMOption &tsmOption)
	Common part of the constructor shared by MPI and non-MPI. More...

	PlainTable (AipsIO &, uInt version, const String &name, const String &type, rownr_t nrrow, int option, const TableLock &lockOptions, const TSMOption &tsmOption, Bool addToCache, uInt locknr)
	Construct the object for an existing table. More...

virtual	~PlainTable ()
	The destructor flushes (i.e. More...

virtual void	reopenRW ()
	Try to reopen the table for read/write access. More...

virtual Bool	asBigEndian () const
	Is the table stored in big or little endian format? More...

virtual const StorageOption &	storageOption () const
	Get the storage option used for the table. More...

virtual Bool	isMultiUsed (Bool checkSubTables) const
	Is the table in use (i.e. More...

virtual const TableLock &	lockOptions () const
	Get the locking info. More...

virtual void	mergeLock (const TableLock &lockOptions)
	Merge the given lock info with the existing one. More...

virtual Bool	hasLock (FileLocker::LockType) const
	Has this process the read or write lock, thus can the table be read or written safely? More...

virtual Bool	lock (FileLocker::LockType, uInt nattempts)
	Try to lock the table for read or write access. More...

virtual void	unlock ()
	Unlock the table. More...

void	autoReleaseLock (Bool always=False)
	Do a release of an AutoLock when the inspection interval has expired. More...

virtual void	flush (Bool fsync, Bool recursive)
	Flush the table, i.e. More...

virtual void	resync ()
	Resync the Table object with the table file. More...

virtual uInt	getModifyCounter () const
	Get the modify counter. More...

virtual void	setTableChanged ()
	Set the table to being changed. More...

virtual Bool	isWritable () const
	Test if the table is opened as writable. More...

virtual TableDesc	actualTableDesc () const
	Get the actual table description. More...

virtual Record	dataManagerInfo () const
	Get the data manager info. More...

virtual TableRecord &	keywordSet ()
	Get readonly access to the table keyword set. More...

virtual TableRecord &	rwKeywordSet ()
	Get read/write access to the table keyword set. More...

virtual BaseColumn *	getColumn (uInt columnIndex) const
	Get a column object using its index. More...

virtual BaseColumn *	getColumn (const String &columnName) const
	Get a column object using its name. More...

virtual Bool	canAddRow () const
	Test if it is possible to add a row to this table. More...

virtual void	addRow (rownr_t nrrow, Bool initialize)
	Add one or more rows and possibly initialize them. More...

virtual Bool	canRemoveRow () const
	Test if it is possible to remove a row from this table. More...

virtual void	removeRow (rownr_t rownr)
	Remove the given row. More...

virtual void	addColumn (const ColumnDesc &columnDesc, Bool)
	Add a column to the table. More...

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. More...

virtual void	removeColumn (const Vector< String > &columnNames)
	Remove columns. More...

virtual Bool	canRenameColumn (const String &columnName) const
	Test if a column can be renamed (yes). More...

virtual void	renameColumn (const String &newName, const String &oldName)
	Rename a column. More...

virtual void	renameHypercolumn (const String &newName, const String &oldName)
	Rename a hypercolumn. More...

virtual DataManager *	findDataManager (const String &name, Bool byColumn) const
	Find the data manager with the given name or for the given column. More...

Public Member Functions inherited from casacore::BaseTable
	BaseTable (const String &tableName, int tableOption, rownr_t nrrow)
	Initialize the object. More...

	BaseTable (MPI_Comm mpiComm, const String &tableName, int tableOption, rownr_t nrrow)
	MPI version of the constructor. More...

void	BaseTableCommon (const String &tableName, int tableOption, rownr_t nrrow)
	Common code shared by the MPI constructor and non-MPI constructor. More...

virtual	~BaseTable ()

void	link ()
	Link to this BaseTable object (i.e. More...

virtual Bool	isNull () const
	Is the table a null table? By default it is not. More...

void	doNotWrite ()
	Do not write the table (used in in case of exceptions). More...

Bool	isColumnWritable (const String &columnName) const
	Test if the given column is writable. More...

Bool	isColumnWritable (uInt columnIndex) const

Bool	isColumnStored (const String &columnName) const
	Test if the given column is stored (otherwise it is virtual). More...

Bool	isColumnStored (uInt columnIndex) const

const String &	tableName () const
	Get the table name. More...

virtual void	getPartNames (Block< String > &names, Bool recursive) const
	Get the names of the tables this table consists of. More...

virtual void	rename (const String &newName, int tableOption)
	Rename the table. More...

virtual void	copy (const String &newName, int tableOption) const
	Copy the table and all its subtables. More...

virtual void	deepCopy (const String &newName, const Record &dataManagerInfo, const StorageOption &, int tableOption, Bool valueCopy, int endianFormat, Bool noRows) const

virtual int	tableType () const
	Get the table type. More...

int	tableOption () const
	Get the table option. More...

void	markForDelete (Bool callback, const String &oldName)
	Mark the table for delete. More...

void	unmarkForDelete (Bool callback, const String &oldName)
	Unmark the table for delete. More...

Bool	isMarkedForDelete () const
	Test if the table is marked for delete. More...

const TableDesc &	tableDesc () const
	Get the table description. More...

void	showStructure (std::ostream &, Bool showDataMan, Bool showColumns, Bool showSubTables, Bool sortColumns, Bool cOrder)
	Show the table structure (implementation of Table::showStructure). More...

TableInfo &	tableInfo ()
	Get access to the TableInfo object. More...

virtual void	flushTableInfo ()
	Write the TableInfo object. More...

rownr_t	nrow () const
	Get number of rows. More...

void	removeRow (const Vector< rownr_t > &rownrs)

void	removeRow (const Vector< uInt > &rownrs)

BaseTable *	select (const TableExprNode &, rownr_t maxRow, rownr_t offset)
	Select rows using the given expression (which can be null). More...

BaseTable *	select (rownr_t maxRow, rownr_t offset)
	Select maxRow rows and skip first offset rows. More...

BaseTable *	select (const Vector< rownr_t > &rownrs)
	Select rows using a vector of row numbers. More...

BaseTable *	select (const Block< Bool > &mask)
	Select rows using a mask block. More...

BaseTable *	project (const Block< String > &columnNames)
	Project the given columns (i.e. More...

BaseTable *	tabAnd (BaseTable *)
	Do logical operations on a table. More...

BaseTable *	tabOr (BaseTable *)
	union with another table More...

BaseTable *	tabSub (BaseTable *)
	subtract another table More...

BaseTable *	tabXor (BaseTable *)
	xor with another table More...

BaseTable *	tabNot ()
	take complement More...

BaseTable *	sort (const Block< String > &columnNames, const Block< CountedPtr< BaseCompare > > &compareObjects, const Block< Int > &sortOrder, int sortOption, std::shared_ptr< Vector< rownr_t >> sortIterBoundaries=nullptr, std::shared_ptr< Vector< size_t >> sortIterKeyIdxChange=nullptr)
	Sort a table on one or more columns of scalars. More...

BaseTableIterator *	makeIterator (const Block< String > &columnNames, const Block< CountedPtr< BaseCompare > > &, const Block< Int > &orders, int option, bool cacheIterationBoundaries=false)
	Create an iterator. More...

void	addColumns (const TableDesc &tableDesc, const Record &dmInfo, Bool addToParent)
	Add one or more columns to the table. More...

Bool	checkRemoveColumn (const Vector< String > &columnNames, Bool throwException) const
	Check if the set of columns can be removed. More...

virtual Vector< rownr_t >	rowNumbers () const
	Get a vector of row numbers. More...

virtual BaseTable *	root ()
	Get pointer to root table (i.e. More...

virtual Bool	rowOrder () const
	Tell if the table is in row order. More...

virtual Vector< rownr_t > *	rowStorage ()
	By the default the table cannot return the storage of rownrs. More...

virtual Bool	adjustRownrs (rownr_t nrrow, Vector< rownr_t > &rownrs, Bool determineOrder) const
	Adjust the row numbers to be the actual row numbers in the root table. More...

virtual BaseTable *	doSort (PtrBlock< BaseColumn * > &, const Block< CountedPtr< BaseCompare > > &, const Block< Int > &sortOrder, int sortOption, std::shared_ptr< Vector< rownr_t >> sortIterBoundaries, std::shared_ptr< Vector< size_t >> sortIterKeyIdxChange)
	Do the actual sort. More...

RefTable *	makeRefTable (Bool rowOrder, rownr_t initialNrrow)
	Create a RefTable object. More...

void	checkRowNumber (rownr_t rownr) const
	Check if the row number is valid. More...

int	traceId () const
	Get the table's trace-id. More...

Static Public Member Functions
static void	getLayout (TableDesc &desc, AipsIO &ios)
	Return the layout of a table (i.e. More...

static ByteIO::OpenOption	toAipsIOFoption (int tableOption)
	Convert a Table option to an AipsIO file option. More...

static TableCache &	tableCache ()
	Get access to the TableCache. More...

Static Public Member Functions inherited from casacore::BaseTable
static void	unlink (BaseTable *)
	Unlink from a BaseTable. More...

static TableInfo	tableInfo (const String &tableName)
	Get the table info of the table with the given name. More...

Private Member Functions
	PlainTable (const PlainTable &)
	Copy constructor is forbidden, because copying a table requires some more knowledge (like table name of result). More...

PlainTable &	operator= (const PlainTable &)
	Assignment is forbidden, because copying a table requires some more knowledge (like table name of result). More...

void	closeObject ()
	Close the object which is called by the destructor. More...

virtual void	renameSubTables (const String &newName, const String &oldName)
	Rename the subtables (used by rename function). More...

MemoryIO *	doReleaseCallBack (Bool always)

Bool	putFile (Bool always)
	When needed, write the table control information in an AipsIO file. More...

void	syncTable ()
	Synchronize the table after having acquired a lock which says that main table data has changed. More...

void	setEndian (int endianFormat)
	Determine and set the endian format (big or little). More...

void	checkWritable (const char *func) const
	Throw an exception if the table is not writable. More...

Static Private Member Functions
static MemoryIO *	releaseCallBack (void *plainTableObject, Bool always)
	The callback function when a lock is released. More...

Private Attributes
CountedPtr< 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

Additional Inherited Members
Protected Member Functions inherited from casacore::BaseTable
void	scratchCallback (Bool isScratch, const String &oldName) const
	Do the callback for scratch tables (if callback is set). More...

Bool	makeTableDir ()
	Create the table directory when needed (and possible). More...

void	trueDeepCopy (const String &newName, const Record &dataManagerInfo, const StorageOption &, int tableOption, int endianFormat, Bool noRows) const
	Make a true deep copy of the table. More...

void	prepareCopyRename (const String &newName, int tableOption) const
	Prepare for copying or renaming a table. More...

void	throwIfTableExists ()
	Check if the table already exists. More...

Bool	openedForWrite () const
	Test if the table is opened for write. More...

void	writeStart (AipsIO &, Bool bigEndian)
	Start writing a table. More...

void	writeEnd (AipsIO &)
	End writing a table. More...

Bool	shouldNotWrite () const
	Should the table be written. More...

void	getTableInfo ()
	Read the TableInfo object. More...

Protected Attributes inherited from casacore::BaseTable
uInt	nrlink_p

rownr_t	nrrow_p

rownr_t	nrrowToAdd_p

CountedPtr< TableDesc >	tdescPtr_p

String	name_p

int	option_p

Bool	noWrite_p

Bool	delete_p

TableInfo	info_p

Bool	madeDir_p

int	itsTraceId

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.
The PlainTable class structure is shown in this UML diagram.

To Do

notify RefTable's when deleting rows

Definition at line 87 of file PlainTable.h.

Constructor & Destructor Documentation

casacore::PlainTable::PlainTable	(	SetupNewTable &	,
		rownr_t	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	(	MPI_Comm	mpiComm,
		SetupNewTable &	,
		rownr_t	nrrow,
		Bool	initialize,
		const TableLock &	lockOptions,
		int	endianFormat,
		const TSMOption &	tsmOption
	)

MPI version of the constructor.

casacore::PlainTable::PlainTable	(	AipsIO &	,
		uInt	version,
		const String &	name,
		const String &	type,
		rownr_t	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.

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members