casacore::SetupNewTableRep Class Reference

Representation for handle class SetupNewTable. More...

#include <SetupNewTab.h>

Public Member Functions
	SetupNewTableRep (const String &tableName, const String &tableDescName, Table::TableOption, const StorageOption &)
	Create a new table using the table description with the given name.
	SetupNewTableRep (const String &tableName, const TableDesc &, Table::TableOption, const StorageOption &)
	Create a new table using the given table description.
	~SetupNewTableRep ()
uInt &	count ()
	Get access to the reference count.
const String &	name () const
	Get the name of the table.
int	option () const
	Get the table create option.
const StorageOption &	storageOption () const
	Get the storage option.
Bool	isMarkedForDelete () const
	Test if the table is marked for delete.
const TableDesc &	tableDesc () const
	Get the table description.
void	bindColumn (const String &columnName, const DataManager &)
	Bind a column to the given data manager.
void	bindColumn (const String &columnName, const String &otherColumn)
	Bind a column to the given data manager of the other column.
void	bindGroup (const String &columnGroup, const DataManager &, Bool rebind=False)
	Bind a group of columns to the given data manager.
void	bindAll (const DataManager &, Bool rebind=False)
	Bind all columns to the given data manager.
void	bindCreate (const Record &spec)
	Create data managers and bind the columns using the specifications in the given record (which is obtained using Table::dataManagerInfo()).
void	setShapeColumn (const String &columnName, const IPosition &shape)
	Define the shape of fixed shaped arrays in a column.
Bool	isUsed () const
	Test if object is already in use.
ColumnSet *	columnSetPtr ()
	Get pointer to column set.
TableDesc *	tableDescPtr ()
	Get pointer to table description.
void	setInUse ()
	Set object to in use by a (Plain)Table object.
void	handleUnbound ()
	Make a data manager for all unbound columns.
Private Member Functions
	SetupNewTableRep (const SetupNewTableRep &)
	Copy constructor is forbidden, because copying a table requires some more knowledge (like table name of result).
SetupNewTableRep &	operator= (const SetupNewTableRep &)
	Assignment is forbidden, because copying a table requires some more knowledge (like table name of result).
void	setup ()
	Setup the new table.
DataManager *	getDataManager (const DataManager &dataMan)
	Get the internal data manager object for the given data manager.
Private Attributes
uInt	count_p
	Reference count.
String	tabName_p
	Table name.
int	option_p
	Constructor options.
StorageOption	storageOpt_p
Bool	delete_p
	Marked for delete?
TableDesc *	tdescPtr_p
ColumnSet *	colSetPtr_p
SimpleOrderedMap< void , void >	dataManMap_p

Detailed Description

Representation for handle class SetupNewTable.

Intended use:

Internal

Review Status

Reviewed By:: bglenden
Date Reviewed:: 12AUG94
Test programs:: None

Prerequisite

TableDesc and related classes like ArrayColumnDesc
DataManager
Table

Etymology

SetupNewTableRep is the representation of class SetupNewTable.

Synopsis

SetupNewTableRep is the representation of class SetupNewTable . Its functionality is described there.

Motivation

Copying a SetupNewTable object as such is very difficult, if not impossible. However, being able to use a SetupNewTable copy constructor was required to be able to have (static) functions constructing a SetupNewTable object and return it by value (as done for example by ForwardColumn::setupNewTable). Therefore SetupNewTable is implemented using the handle idiom. SetupNewTable is the interface (i.e. the handle) for the user, while underneath SetupNewTableRep is doing all the work. The SetupNewTable copy constructor can simply copy yhe pointer to the underlying SetupNewTableRep object.

To Do

full implementation of tiling

Definition at line 93 of file SetupNewTab.h.

Constructor & Destructor Documentation

casacore::SetupNewTableRep::SetupNewTableRep	(	const String &	tableName,
		const String &	tableDescName,
		Table::TableOption	,
		const StorageOption &
	)

Create a new table using the table description with the given name.

The description will be read from a file.

casacore::SetupNewTableRep::SetupNewTableRep	(	const String &	tableName,
		const TableDesc &	,
		Table::TableOption	,
		const StorageOption &
	)

Create a new table using the given table description.

casacore::SetupNewTableRep::~SetupNewTableRep ( )

casacore::SetupNewTableRep::SetupNewTableRep ( const SetupNewTableRep & ) [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

void casacore::SetupNewTableRep::bindAll	(	const DataManager &	,
		Bool	rebind = `False`
	)

Bind all columns to the given data manager.

The flag rebind tells if the binding of an already bound column will be overwritten. It cannot be used anymore once the SetupNewTableRep object is used to construct a Table object.

Referenced by casacore::SetupNewTable::bindAll().

void casacore::SetupNewTableRep::bindColumn	(	const String &	columnName,
		const String &	otherColumn
	)

Bind a column to the given data manager of the other column.

If the other column is not bound, nothing will be done. If columnName is already bound, the binding will be overwritten. It cannot be used anymore once the SetupNewTableRep object is used to construct a Table object.

void casacore::SetupNewTableRep::bindColumn	(	const String &	columnName,
		const DataManager &
	)

Bind a column to the given data manager.

If already bound, the binding will be overwritten. It cannot be used anymore once the SetupNewTableRep object is used to construct a Table object.

Referenced by casacore::SetupNewTable::bindColumn().

void casacore::SetupNewTableRep::bindCreate ( const Record & spec )

Create data managers and bind the columns using the specifications in the given record (which is obtained using Table::dataManagerInfo()).

Referenced by casacore::SetupNewTable::bindCreate().

void casacore::SetupNewTableRep::bindGroup	(	const String &	columnGroup,
		const DataManager &	,
		Bool	rebind = `False`
	)

Bind a group of columns to the given data manager.

The flag rebind tells if the binding of an already bound column will be overwritten. It cannot be used anymore once the SetupNewTableRep object is used to construct a Table object.

Referenced by casacore::SetupNewTable::bindGroup().

ColumnSet* casacore::SetupNewTableRep::columnSetPtr ( ) [inline]

Get pointer to column set.

This function is used by PlainTable.

Definition at line 181 of file SetupNewTab.h.

References colSetPtr_p.

Referenced by casacore::SetupNewTable::columnSetPtr().

uInt& casacore::SetupNewTableRep::count ( ) [inline]

Get access to the reference count.

Definition at line 108 of file SetupNewTab.h.

References count_p.

DataManager* casacore::SetupNewTableRep::getDataManager ( const DataManager & dataMan ) [private]

Get the internal data manager object for the given data manager.

If it does not exist yet, it will be cloned and stored internally.

void casacore::SetupNewTableRep::handleUnbound ( )

Make a data manager for all unbound columns.

Referenced by casacore::SetupNewTable::handleUnbound().

Bool casacore::SetupNewTableRep::isMarkedForDelete ( ) const [inline]

Test if the table is marked for delete.

Definition at line 124 of file SetupNewTab.h.

References delete_p.

Referenced by casacore::SetupNewTable::isMarkedForDelete().

Bool casacore::SetupNewTableRep::isUsed ( ) const [inline]

Test if object is already in use.

Definition at line 176 of file SetupNewTab.h.

References colSetPtr_p, casacore::False, and casacore::True.

Referenced by casacore::SetupNewTable::isUsed().

const String& casacore::SetupNewTableRep::name ( ) const [inline]

Get the name of the table.

Definition at line 112 of file SetupNewTab.h.

References tabName_p.

Referenced by casacore::SetupNewTable::name().

SetupNewTableRep& casacore::SetupNewTableRep::operator= ( const SetupNewTableRep & ) [private]

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

Declaring it private, makes it unusable.

int casacore::SetupNewTableRep::option ( ) const [inline]

Get the table create option.

Definition at line 116 of file SetupNewTab.h.

References option_p.

Referenced by casacore::SetupNewTable::option().

void casacore::SetupNewTableRep::setInUse ( ) [inline]

Set object to in use by a (Plain)Table object.

This function is used by PlainTable.

Definition at line 191 of file SetupNewTab.h.

References colSetPtr_p.

Referenced by casacore::SetupNewTable::setInUse().

void casacore::SetupNewTableRep::setShapeColumn	(	const String &	columnName,
		const IPosition &	shape
	)

Define the shape of fixed shaped arrays in a column.

The shape of those arrays has to be known before the table can be constructed. It has to be defined via this function, if it was not already defined in the column description. If only the dimensionality was defined in the column description, the shape's dimensionality must match it. Calling this function for an non-fixed shaped array results in an exception. It cannot be used anymore once the SetupNewTableRep object is used to construct a Table object.

Referenced by casacore::SetupNewTable::setShapeColumn().

void casacore::SetupNewTableRep::setup ( ) [private]

Setup the new table.

This checks various things and creates the set of columns.

const StorageOption& casacore::SetupNewTableRep::storageOption ( ) const [inline]

Get the storage option.

Definition at line 120 of file SetupNewTab.h.

References storageOpt_p.

Referenced by casacore::SetupNewTable::storageOption().

const TableDesc& casacore::SetupNewTableRep::tableDesc ( ) const [inline]

Get the table description.

Definition at line 128 of file SetupNewTab.h.