Representation of a Splatalogue casacore::Table. More...

#include <SplatalogueTable.h>

Inheritance diagram for casa::SplatalogueTable:

Public Member Functions
	SplatalogueTable (casacore::SetupNewTable &snt, casacore::uInt nrow, const casacore::String &freqUnit, const casacore::String &smu2Unit, const casacore::String &elUnit, const casacore::String &euUnit)

	SplatalogueTable (const casacore::String &tablename)
	open an existing splatalogue table. More...

	SplatalogueTable (const casacore::Table &table)
	copy semantics. More...

casacore::String	getFrequencyUnit () const

casacore::String	list () const
	Pretty print table contents to a String. More...

casacore::Record	toRecord () const

Public Member Functions inherited from casacore::Table
	Table ()
	Create a null Table object (i.e. More...

	Table (const String &tableName, TableOption=Table::Old, const TSMOption &=TSMOption())
	Create a table object for an existing table. More...

	Table (const String &tableName, const TableLock &lockOptions, TableOption=Table::Old, const TSMOption &=TSMOption())

	Table (const String &tableName, const String &tableDescName, TableOption=Table::Old, const TSMOption &=TSMOption())

	Table (const String &tableName, const String &tableDescName, const TableLock &lockOptions, TableOption=Table::Old, const TSMOption &=TSMOption())

	Table (TableType, EndianFormat=Table::AipsrcEndian, const TSMOption &=TSMOption())
	Make a new empty table (plain (scratch) or memory type). More...

	Table (SetupNewTable &, uInt nrrow=0, Bool initialize=False, EndianFormat=Table::AipsrcEndian, const TSMOption &=TSMOption())
	Make a table object for a new table, which can thereafter be used for reading and writing. More...

	Table (SetupNewTable &, TableType, uInt nrrow=0, Bool initialize=False, EndianFormat=Table::AipsrcEndian, const TSMOption &=TSMOption())

	Table (SetupNewTable &, TableType, const TableLock &lockOptions, uInt nrrow=0, Bool initialize=False, EndianFormat=Table::AipsrcEndian, const TSMOption &=TSMOption())

	Table (SetupNewTable &, TableLock::LockOption, uInt nrrow=0, Bool initialize=False, EndianFormat=Table::AipsrcEndian, const TSMOption &=TSMOption())

	Table (SetupNewTable &, const TableLock &lockOptions, uInt nrrow=0, Bool initialize=False, EndianFormat=Table::AipsrcEndian, const TSMOption &=TSMOption())

	Table (const Block< Table > &tables, const Block< String > &subTables=Block< String >(), const String &subDirName=String())
	Create a table object as the virtual concatenation of one or more of existing tables. More...

	Table (const Block< String > &tableNames, const Block< String > &subTables=Block< String >(), TableOption=Table::Old, const TSMOption &=TSMOption(), const String &subDirName=String())

	Table (const Block< String > &tableNames, const Block< String > &subTables, const TableLock &lockOptions, TableOption=Table::Old, const TSMOption &=TSMOption())

	Table (const Table &)
	Copy constructor (reference semantics). More...

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

Table &	operator= (const Table &)
	Assignment (reference semantics). More...

Block< String >	getPartNames (Bool recursive=False) const
	Get the names of the tables this table consists of. More...

Bool	isSameRoot (const Table &other) const
	Is the root table of this table the same as that of the other one? More...

void	closeSubTables () const
	Close all open subtables. More...

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

Table::EndianFormat	endianFormat () const
	Get the endian format in which the table is stored. More...

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

Bool	isMultiUsed (Bool checkSubTables=False) const
	Is the table used (i.e. More...

const TableLock &	lockOptions () const
	Get the locking options. More...

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

Bool	hasLock (Bool write) const

Bool	lock (FileLocker::LockType=FileLocker::Write, uInt nattempts=0)
	Try to lock the table for read or write access (default is write). More...

Bool	lock (Bool write, uInt nattempts=0)

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

Bool	hasDataChanged ()
	Determine if column or keyword table data have changed (or is being changed) since the last time this function was called. More...

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

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

Bool	isNull () const
	Test if the object is null, i.e. More...

void	throwIfNull () const
	Throw an exception if the object is null, i.e. More...

void	showStructure (std::ostream &, Bool showDataMans=True, Bool showColumns=True, Bool showSubTables=False, Bool sortColumns=False, Bool cOrder=False) const
	Show the structure of the table. More...

void	showKeywords (std::ostream &, Bool showSubTables=False, Bool showTabKey=True, Bool showColKey=False, Int maxVal=25) const
	Show the table and/or column keywords, possibly also of all subtables. More...

void	showKeywordSets (std::ostream &, Bool showTabKey, Bool showColKey, Int maxVal) const
	Show the table and/or column keywords of this table. More...

Bool	isRootTable () const
	Test if this table is the root table (ie. More...

Bool	isWritable () const
	Test if this table is opened as writable. 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 TableRecord &	keywordSet () const
	Get readonly access to the table keyword set. More...

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

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

TableInfo &	tableInfo ()

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

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

TableDesc	actualTableDesc () const

Record	dataManagerInfo () const
	Return all data managers used and the columns served by them. More...

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

void	rename (const String &newName, TableOption)
	Rename the table and all its subtables. More...

void	copy (const String &newName, TableOption, Bool noRows=False) const
	Copy the table and all its subtables. More...

void	deepCopy (const String &newName, TableOption, Bool valueCopy=False, EndianFormat=AipsrcEndian, Bool noRows=False) const

void	deepCopy (const String &newName, const Record &dataManagerInfo, TableOption, Bool valueCopy=False, EndianFormat=AipsrcEndian, Bool noRows=False) const

void	deepCopy (const String &newName, const Record &dataManagerInfo, const StorageOption &, TableOption, Bool valueCopy=False, EndianFormat=AipsrcEndian, Bool noRows=False) const

Table	copyToMemoryTable (const String &name, Bool noRows=False) const
	Make a copy of a table to a MemoryTable object. More...

TableType	tableType () const
	Get the table type. More...

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

void	markForDelete ()
	Mark the table for delete. More...

void	unmarkForDelete ()
	Unmark the table for delete. More...

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

uInt	nrow () const
	Get the number of rows. More...

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

void	addRow (uInt nrrow=1, Bool initialize=False)
	Add one or more rows at the end of the table. More...

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

void	removeRow (uInt rownr)
	Remove the given row(s). More...

void	removeRow (const Vector< uInt > &rownrs)

TableExprNode	nodeRownr (uInt origin=0) const
	Create a TableExprNode object for the rownumber function. More...

TableExprNode	nodeRandom () const
	Create a TableExprNode object for the rand function. More...

Table	operator() (const TableExprNode &, uInt maxRow=0, uInt offset=0) const
	Select rows from a table using an select expression consisting of TableExprNode objects. More...

Table	operator() (const Vector< uInt > &rownrs) const
	Select rows using a vector of row numbers. More...

Table	operator() (const Block< Bool > &mask) const
	Select rows using a mask block. More...

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

Table	operator& (const Table &) const
	Do logical operations on a table. More...

Table	operator\| (const Table &) const
	Union with another table. More...

Table	operator- (const Table &) const
	Subtract another table. More...

Table	operator^ (const Table &) const
	Xor with another table. More...

Table	operator! () const
	Take complement. More...

Table	sort (const String &columnName, int=Sort::Ascending, int=Sort::ParSort) const
	Sort a table on one or more columns of scalars. More...

Table	sort (const Block< String > &columnNames, int=Sort::Ascending, int=Sort::ParSort) const
	Sort on multiple columns. More...

Table	sort (const Block< String > &columnNames, const Block< Int > &sortOrders, int=Sort::ParSort) const
	Sort on multiple columns. More...

Table	sort (const Block< String > &columnNames, const Block< CountedPtr< BaseCompare > > &compareObjects, const Block< Int > &sortOrders, int=Sort::ParSort) const
	Sort on multiple columns. More...

Vector< uInt >	rowNumbers () const
	Get a vector of row numbers in the root table of rows in this table. More...

Vector< uInt >	rowNumbers (const Table &that, Bool tryFast=False) const
	Get a vector of row numbers in that table of rows in this table. More...

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

void	addColumn (const ColumnDesc &columnDesc, const String &dataManager, Bool byName, Bool addToParent=True)
	Use an existing data manager with the given name or type. More...

void	addColumn (const ColumnDesc &columnDesc, const DataManager &dataManager, Bool addToParent=True)
	Use the given data manager (which is a new one). More...

void	addColumn (const TableDesc &tableDesc, const DataManager &dataManager, Bool addToParent=True)
	Add a bunch of columns using the given new data manager. More...

void	addColumn (const TableDesc &tableDesc, const Record &dataManagerInfo, Bool addToParent=True)

Bool	canRemoveColumn (const String &columnName) const
	Test if columns can be removed. More...

Bool	canRemoveColumn (const Vector< String > &columnNames) const

void	removeColumn (const String &columnName)
	Remove columns. More...

void	removeColumn (const Vector< String > &columnName)

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

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

void	renameHypercolumn (const String &newName, const String &oldName)

void	getTableKeyword (AipsIO &, Bool openWritable)
	Read a table from AipsIO (for `TableKeywords`). More...

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

TableExprNode	key (const String &keywordName) const
	Create a TableExprNode object for a column or for a keyword in the table keyword set. More...

TableExprNode	key (const Vector< String > &fieldNames) const

TableExprNode	col (const String &columnName) const

TableExprNode	col (const String &columnName, const Vector< String > &fieldNames) const

TableExprNode	keyCol (const String &name, const Vector< String > &fieldNames) const

Static Public Attributes
static const casacore::String	SPECIES

static const casacore::String	RECOMMENDED

static const casacore::String	CHEMICAL_NAME

static const casacore::String	FREQUENCY

static const casacore::String	QUANTUM_NUMBERS

static const casacore::String	INTENSITY

static const casacore::String	SMU2

static const casacore::String	LOGA

static const casacore::String	EL

static const casacore::String	EU

static const casacore::String	LINELIST

static const casacore::String	ISSPLAT

static const casacore::String	RECORD_VALUE

static const casacore::String	RECORD_UNIT

static const casacore::String	RECORD_SPECIES

static const casacore::String	RECORD_RECOMMENDED

static const casacore::String	RECORD_CHEMNAME

static const casacore::String	RECORD_FREQUENCY

static const casacore::String	RECORD_QNS

static const casacore::String	RECORD_INTENSITY

static const casacore::String	RECORD_SMU2

static const casacore::String	RECORD_LOGA

static const casacore::String	RECORD_EL

static const casacore::String	RECORD_EU

static const casacore::String	RECORD_LINE_LIST

Private Member Functions
	SplatalogueTable ()

void	_construct (const casacore::Bool setup)
	void _defineTable(const casacore::String& tablename, const casacore::uInt nrow); More...

void	_addKeywords ()

Private Attributes
casacore::String	_freqUnit

casacore::String	_smu2Unit

casacore::String	_elUnit

casacore::String	_euUnit

Additional Inherited Members
Public Types inherited from casacore::Table
enum	TableOption { Old, New, NewNoReplace, Scratch, Update, Delete }
	Define the possible options how a table can be opened. More...

enum	TableType { Plain, Memory }
	Define the possible table types. More...

enum	EndianFormat { BigEndian, LittleEndian, LocalEndian, AipsrcEndian }
	Define the possible endian formats in which table data can be stored. More...

typedef void	ScratchCallback (const String &name, Bool isScratch, const String &oldName)
	Define the signature of the function being called when the state of a scratch table changes (i.e. More...

Static Public Member Functions inherited from casacore::Table
static ScratchCallback *	setScratchCallback (ScratchCallback *)
	Set the pointer to the ScratchCallback function. More...

static Table	openTable (const String &tableName, TableOption=Table::Old, const TSMOption &=TSMOption())
	Try to open a table. More...

static Table	openTable (const String &tableName, const TableLock &lockOptions, TableOption=Table::Old, const TSMOption &=TSMOption())

static Bool	canDeleteTable (const String &tableName, Bool checkSubTables=False)
	Can the table be deleted? If true, function deleteTable can safely be called. More...

static Bool	canDeleteTable (String &message, const String &tableName, Bool checkSubTables=False)

static void	deleteTable (const String &tableName, Bool checkSubTables=False)
	Delete the table. More...

static Bool	isOpened (const String &tableName)
	Is the table used (i.e. More...

static uInt	nAutoLocks ()
	Determine the number of locked tables opened with the AutoLock option (Locked table means locked for read and/or write). More...

static void	relinquishAutoLocks (Bool all=False)
	Unlock locked tables opened with the AutoLock option. More...

static Vector< String >	getLockedTables (FileLocker::LockType=FileLocker::Read, int lockOption=-1)
	Get the names of tables locked in this process. More...

static Bool	isNativeDataType (DataType dtype)
	Test if the given data type is native to the table system. More...

static String	fileName (const String &tableName)
	Make the table file name. More...

static Bool	isReadable (const String &tableName, bool throwIf=False)
	Test if a table with the given name exists and is readable. More...

static uInt	getLayout (TableDesc &desc, const String &tableName)
	Return the layout of a table (i.e. More...

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

static Bool	isWritable (const String &tableName, bool throwIf=False)
	Test if a table with the given name exists and is writable. More...

static Vector< String >	nonWritableFiles (const String &tableName)
	Find the non-writable files in a table. More...

Protected Member Functions inherited from casacore::Table
	Table (BaseTable *, Bool countIt=True)
	Construct a Table object from a BaseTable*. More...

void	open (const String &name, const String &type, int tableOption, const TableLock &lockOptions, const TSMOption &tsmOpt)
	Open an existing table. More...

Protected Attributes inherited from casacore::Table
BaseTable *	baseTabPtr_p

Bool	isCounted_p

uInt	lastModCounter_p

Static Protected Attributes inherited from casacore::Table
static ScratchCallback *	scratchCallback_p

Detailed Description

Representation of a Splatalogue casacore::Table.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

Splatalogue Table

Synopsis

A table containing Splatalogue fields and metadata which holds Splatalogue data.

Example

Motivation

Definition at line 67 of file SplatalogueTable.h.

Constructor & Destructor Documentation

casa::SplatalogueTable::SplatalogueTable	(	casacore::SetupNewTable &	snt,
		casacore::uInt	nrow,
		const casacore::String &	freqUnit,
		const casacore::String &	smu2Unit,
		const casacore::String &	elUnit,
		const casacore::String &	euUnit
	)

casa::SplatalogueTable::SplatalogueTable ( const casacore::String & tablename )

open an existing splatalogue table.

Checks are done to ensure the table is indeed a SplatalogueTable and not just a generic table. If

casa::SplatalogueTable::SplatalogueTable ( const casacore::Table & table )

copy semantics.

Tests are done to insure the input table is a splatalogue table.

casa::SplatalogueTable::SplatalogueTable ( )

private

Member Function Documentation

void casa::SplatalogueTable::_addKeywords ( )

private

void casa::SplatalogueTable::_construct ( const casacore::Bool setup )

private

void _defineTable(const casacore::String& tablename, const casacore::uInt nrow);

casacore::String casa::SplatalogueTable::getFrequencyUnit ( ) const

casacore::String casa::SplatalogueTable::list ( ) const

Pretty print table contents to a String.

casacore::Record casa::SplatalogueTable::toRecord ( ) const

Member Data Documentation

casacore::String casa::SplatalogueTable::_elUnit

private

Definition at line 119 of file SplatalogueTable.h.

casacore::String casa::SplatalogueTable::_euUnit

private

Definition at line 119 of file SplatalogueTable.h.

casacore::String casa::SplatalogueTable::_freqUnit

private

Definition at line 119 of file SplatalogueTable.h.

casacore::String casa::SplatalogueTable::_smu2Unit

private

Definition at line 119 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::CHEMICAL_NAME

static

Definition at line 72 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::EL

static

Definition at line 78 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::EU

static

Definition at line 79 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::FREQUENCY

static

Definition at line 73 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::INTENSITY

static

Definition at line 75 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::ISSPLAT

static

Definition at line 81 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::LINELIST

static

Definition at line 80 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::LOGA

static

Definition at line 77 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::QUANTUM_NUMBERS

static

Definition at line 74 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::RECOMMENDED

static

Definition at line 71 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::RECORD_CHEMNAME

static

Definition at line 87 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::RECORD_EL

static

Definition at line 93 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::RECORD_EU

static

Definition at line 94 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::RECORD_FREQUENCY

static

Definition at line 88 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::RECORD_INTENSITY

static

Definition at line 90 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::RECORD_LINE_LIST

static

Definition at line 95 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::RECORD_LOGA

static

Definition at line 92 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::RECORD_QNS

static

Definition at line 89 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::RECORD_RECOMMENDED

static

Definition at line 86 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::RECORD_SMU2

static

Definition at line 91 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::RECORD_SPECIES

static

Definition at line 85 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::RECORD_UNIT

static

Definition at line 84 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::RECORD_VALUE

static

Definition at line 83 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::SMU2

static

Definition at line 76 of file SplatalogueTable.h.

const casacore::String casa::SplatalogueTable::SPECIES

static

Definition at line 70 of file SplatalogueTable.h.

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

casa/code/spectrallines/Splatalogue/SplatalogueTable.h

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Intended use:

Review Status

Etymology

Synopsis

Example

Motivation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation