Abstract base class for a data manager. More...

#include <DataManager.h>

Public Member Functions
	DataManager ()
	Default constructor. More...

virtual	~DataManager ()

virtual DataManager *	clone () const =0
	Make a clone of the derived object. More...

virtual String	dataManagerName () const
	Return the name of the data manager. More...

virtual String	dataManagerType () const =0
	Return the type name of the data manager (in fact its class name). More...

void	dataManagerInfo (Record &info) const
	Add SEQNR and SPEC (the DataManagerSpec subrecord) to the info. More...

virtual Record	dataManagerSpec () const
	Return a record containing data manager specifications. More...

virtual Record	getProperties () const
	Get data manager properties that can be modified. More...

virtual void	setProperties (const Record &spec)
	Modify data manager properties given in record fields. More...

virtual Bool	isStorageManager () const
	Is the data manager a storage manager? The default is yes. More...

virtual Bool	canReallocateColumns () const
	Tell if the data manager wants to reallocate the data manager column objects. More...

virtual DataManagerColumn *	reallocateColumn (DataManagerColumn *column)
	Reallocate the column object if it is part of this data manager. More...

uInt	sequenceNr () const
	Get the (unique) sequence nr of this data manager. More...

uInt	ncolumn () const
	Get the nr of columns in this data manager (can be zero). More...

Bool	asBigEndian () const
	Have the data to be stored in big or little endian canonical format? More...

const TSMOption &	tsmOption () const
	Get the TSM option. More...

MultiFileBase *	multiFile ()
	Get the MultiFile pointer (can be 0). More...

String	keywordName (const String &keyword) const
	Compose a keyword name from the given keyword appended with the sequence number (e.g. More...

String	fileName () const
	Compose a unique filename from the table name and sequence number. More...

ByteIO::OpenOption	fileOption () const
	Get the AipsIO option of the underlying file. More...

virtual Bool	isRegular () const
	Is this a regular storage manager? It is regular if it allows addition of rows and writing data in them. More...

Table &	table () const
	Get the table this object is associated with. More...

virtual void	reopenRW ()
	Reopen the data manager for read/write access. More...

virtual Bool	canAddRow () const
	Does the data manager allow to add rows? (default no) More...

virtual Bool	canRemoveRow () const
	Does the data manager allow to delete rows? (default no) More...

virtual Bool	canAddColumn () const
	Does the data manager allow to add columns? (default no) More...

virtual Bool	canRemoveColumn () const
	Does the data manager allow to delete columns? (default no) More...

virtual Bool	canRenameColumn () const
	Does the data manager allow to rename columns? (default yes) More...

virtual void	setMaximumCacheSize (uInt nMiB)
	Set the maximum cache size (in bytes) to be used by a storage manager. More...

virtual void	showCacheStatistics (std::ostream &) const
	Show the data manager's IO statistics. More...

DataManagerColumn *	createScalarColumn (const String &columnName, int dataType, const String &dataTypeId)
	Create a column in the data manager on behalf of a table column. More...

DataManagerColumn *	createDirArrColumn (const String &columnName, int dataType, const String &dataTypeId)
	Create a direct array column. More...

DataManagerColumn *	createIndArrColumn (const String &columnName, int dataType, const String &dataTypeId)
	Create an indirect array column. More...

virtual void	deleteManager ()=0
	The data manager will be deleted (because all its columns are requested to be deleted). More...

DataManager *	getClone () const
	Has the object already been cloned? More...

void	setClone (DataManager *clone) const
	Set the pointer to the clone. More...

Static Public Member Functions
static void	registerCtor (const String &type, DataManagerCtor func)
	Register a mapping of a data manager type to its static construction function. More...

static DataManagerCtor	getCtor (const String &dataManagerType)
	Get the "constructor" of a data manager (thread-safe). More...

static Bool	isRegistered (const String &dataManagerType)
	Test if a data manager is registered (thread-safe). More...

static DataManager *	unknownDataManager (const String &dataManagerType, const Record &spec)
	Serve as default function for theirRegisterMap, which catches all unknown data manager types. More...

Static Public Attributes
static rownr_t	MAXROWNR32
	Define the highest row number that can be represented as signed 32-bit. More...

Protected Member Functions
void	decrementNcolumn ()
	Decrement number of columns (in case a column is deleted). More...

void	setEndian (Bool bigEndian)
	Tell the data manager if big or little endian format is needed. More...

void	setTsmOption (const TSMOption &tsmOption)
	Tell the data manager which TSM option to use. More...

void	setMultiFile (MultiFileBase *mfile)
	Tell the data manager that MultiFile can be used. More...

virtual Bool	hasMultiFileSupport () const
	Does the data manager support use of MultiFile? A derived class has to return True if it can use the MultiFile. More...

void	throwDataTypeOther (const String &columnName, int dataType) const
	Throw an exception in case data type is TpOther, because the storage managers (and maybe other data managers) do not support such columns. More...

Private Member Functions
	DataManager (const DataManager &)
	The copy constructor cannot be used for this base class. More...

DataManager &	operator= (const DataManager &)
	Assignment cannot be used for this base class. More...

virtual DataManagerColumn *	makeScalarColumn (const String &columnName, int dataType, const String &dataTypeId)=0
	Create a column in the data manager on behalf of a table column. More...

virtual DataManagerColumn *	makeDirArrColumn (const String &columnName, int dataType, const String &dataTypeId)=0
	Create a direct array column. More...

virtual DataManagerColumn *	makeIndArrColumn (const String &columnName, int dataType, const String &dataTypeId)=0
	Create an indirect array column. More...

void	checkDataType (const DataManagerColumn *colPtr, const String &columnName, int dataType, const String &dataTypeId) const
	Check if the data type of the created data manager column is correct. More...

virtual void	addRow64 (rownr_t nrrow)
	Add rows to all columns. More...

virtual void	removeRow64 (rownr_t rownr)
	Delete a row from all columns. More...

virtual void	addColumn (DataManagerColumn *)
	Add a column. More...

virtual void	removeColumn (DataManagerColumn *)
	Delete a column. More...

void	setSeqnr (uInt nr)
	Set the sequence number of this data manager. More...

void	linkToTable (Table &tab)
	Link the data manager to the Table object. More...

virtual Bool	flush (AipsIO &ios, Bool fsync)=0
	Flush and optionally fsync the data. More...

virtual void	create64 (rownr_t nrrow)
	Let the data manager initialize itself for a new table. More...

virtual rownr_t	open64 (rownr_t nrrow, AipsIO &ios)
	Let the data manager initialize itself for an existing table. More...

virtual rownr_t	resync64 (rownr_t nrrow)
	Resync the data by rereading cached data from the file. More...

virtual void	prepare ()
	Let the data manager initialize itself further. More...

virtual void	addRow (uInt nrrow)
	Backward compatibility function using uInt instead of rownr_t. More...

virtual void	removeRow (uInt rownr)

virtual void	create (uInt nrrow)

virtual void	open (uInt nrrow, AipsIO &ios)

virtual uInt	open1 (uInt nrrow, AipsIO &ios)

virtual void	resync (uInt nrrow)

virtual uInt	resync1 (uInt nrrow)

Static Private Member Functions
static std::map< String, DataManagerCtor >	initRegisterMap ()
	Register the main data managers. More...

Private Attributes
uInt	nrcol_p

uInt	seqnr_p

Bool	asBigEndian_p

TSMOption	tsmOption_p

MultiFileBase *	multiFile_p

Table *	table_p

DataManager *	clone_p

Static Private Attributes
static std::map< String, DataManagerCtor >	theirRegisterMap
	Declare the mapping of the data manager type name to a static "makeObject" function. More...

static std::recursive_mutex	theirMutex

Friends
class	SetupNewTable

class	ColumnSet

Detailed Description

Abstract base class for a data manager.

Intended use:

Internal

Review Status

Reviewed By:: Gareth Hunt
Date Reviewed:: 94Nov17

Synopsis

DataManager is the abstract base class for all kind of table data managers.
The DataManager class structure is shown in this UML diagram. There are currently 2 classes of data managers:

Storage managers handling the storage of data. These classes have to be derived from DataManager. StManAipsIO is an example of a storage manager.
Virtual column engines handling the on-the-fly calculation of data, which are not stored as such. The base class for these is VirtualColumnEngine (which is derived from DataManager), from which all virtual columns engine must be derived from.

DataManager contains some common data and defines several virtual functions, which usually have to be implemented in the derived classes. It also contains some helper functions for the derived classes (like fileName().

The actual handling of a column by the data manager is defined in the abstract base class DataManagerColumn. Each data manager must have an associated class (derived from DataManagerColumn) to handle the columns.

There is a protocol defined how a data manager is created and initialized. For a new table it is:

The user creates data managers and binds them to columns. For example:
SetupNewTable newtab("name.data", Table::New); // set up new table

StManAipsIO stman; // define storage manager

newtab.bindColumn ("column1", stman); // bind column to st.man.

newtab.bindColumn ("column2", stman); // bind column to st.man.

Table tab(newtab); // actually create table

casacore::DataManager::SetupNewTable
friend class SetupNewTable
Definition: DataManager.h:222

casacore::Table::New
@ New
create table
Definition: Table.h:176

When the given data manager object is used for the first time in a bind function, a copy of the object is made using the clone function. Thus in the above example column1 and column2 share the same data manager; only at the first bind the stman object is cloned. Columns not explicitly bound to a data manager get implicitly bound to the default data manager (as defined in the column description) by the Table constructor (as used in line 5).
After binding the unbound columns, the PlainTable constructor sets up the data managers. For each column it asks the data manager to construct a DataManagerColumn object (in fact, an object of a class derived from DataManagerColumn). This is done by the functions createScalarColumn, createIndArrColumn and createDirArrColumn. For each data manager the create function is called. This allows them to initialize themselves and/or to call an initialization function in their column objects. This is, for instance, used by the storage managers to create files. Thereafter the prepare function is called to allow the data managers to do further initialization possibly requiring information from other columns.
When the table gets written (by the PlainTable destructor), the flush function is called for each data manager. This allows the data manager or their column objects to write or flush their data. The table system takes care of storing the information required to reconstruct the data managers. It uses the function dataManagerType to store the (unique) type name of the data manager class.
Finally each data manager object gets deleted. Their destructors must delete their column objects (if any and if needed).

For an existing table the procedure is slightly different:

The statement
Table tab("name.data"); will create a table object for an existing table. This has the effect that the given table file will be read to reconstruct the Table object and the data managers.
The stored data manager class names are used to reconstruct the data managers. This uses the static registration map, which maps the class name to a static class constructor function (usually called makeObject). This requires that the type name and constructor for each possible data manager are registered before the table is opened. The DataManager function registerMainCtor (implemented in DataManager.cc) is called before a table is opened, so registration of data managers should, in principle, be done there.
However, for unknown data managers it is tried to load a shared library whose name is the lowercase version of the data manager without a possible template argument (e.g. bitflagsengine for data manager BitFlagsEngine<Int>). It can be preceeded by lib or libcasa_ and followed by.so or.dylib. The shared library has to have a function with a name like register_bitflagsengine that must register the data manager(s). The function must be declared as extern "C", otherwise its name gets mangled.
Each table column is bound to the correct data manager. The sequence number stored in the table file is used for that purpose.
The DataManager createXXXColumn functions are called for each table column to let the data manager construct a data manager column object.
For each data manager the open function is called to allow it and its column objects to read back the information stored in the flush function. Thereafter the prepare function is called for each data manager to allow it to initialize some variables. The reason that open and prepare are separated is that in order to initialize variables it may be required to use other columns. So it may be needed that all columns are read back before they get initialized.
Similar to a new table the flush functions gets called when the table gets written. Destruction is also the same as sketched for new tables.

Motivation

An abstract base class is needed to support data managers and virtual column engines in the table system in a transparant way.

To Do

Handle unregistered data managers in a better way. Instead of throwing an exception a subprocess could be started which represents the data manager.

Definition at line 220 of file DataManager.h.

Constructor & Destructor Documentation

◆ DataManager() [1/2]

casacore::DataManager::DataManager ( )

Default constructor.

◆ ~DataManager()

virtual casacore::DataManager::~DataManager ( )

virtual

◆ DataManager() [2/2]

casacore::DataManager::DataManager ( const DataManager & )

private

The copy constructor cannot be used for this base class.

The clone function should be used instead. The private declaration of this constructor makes it unusable.

Member Function Documentation

◆ addColumn()

virtual void casacore::DataManager::addColumn ( DataManagerColumn * )

privatevirtual

Add a column.

The default implementation throws a "not possible" exception.

Reimplemented in casacore::SSMBase, casacore::MSMBase, casacore::ISMBase, casacore::ForwardColumnEngine, casacore::DerivedMSCal, and dyscostman::DyscoStMan.

◆ addRow()

virtual void casacore::DataManager::addRow ( uInt nrrow )

privatevirtual

Backward compatibility function using uInt instead of rownr_t.

The default implementations throw an exception.

◆ addRow64()

virtual void casacore::DataManager::addRow64 ( rownr_t nrrow )

privatevirtual

Add rows to all columns.

The default implementation calls the uInt version.

Reimplemented in casacore::VirtualColumnEngine, casacore::TiledShapeStMan, casacore::TiledDataStMan, casacore::TiledColumnStMan, casacore::TiledCellStMan, casacore::MSMBase, casacore::ISMBase, casacore::ForwardColumnEngine, casacore::BaseMappedArrayEngine< VirtualType, StoredType >, casacore::BaseMappedArrayEngine< Complex, Int >, casacore::BaseMappedArrayEngine< Float, Short >, casacore::BaseMappedArrayEngine< Bool, StoredType >, casacore::SSMBase, and casacore::Adios2StMan.

◆ asBigEndian()

Bool casacore::DataManager::asBigEndian ( ) const

inline

Have the data to be stored in big or little endian canonical format?

Definition at line 289 of file DataManager.h.

References asBigEndian_p.

◆ canAddColumn()

virtual Bool casacore::DataManager::canAddColumn ( ) const

virtual

Does the data manager allow to add columns? (default no)

Reimplemented in dyscostman::DyscoStMan, casacore::SSMBase, casacore::MSMBase, casacore::ISMBase, casacore::ForwardColumnEngine, and casacore::DerivedMSCal.

◆ canAddRow()

virtual Bool casacore::DataManager::canAddRow ( ) const

virtual

Does the data manager allow to add rows? (default no)

Reimplemented in dyscostman::DyscoStMan, casacore::VirtualColumnEngine, casacore::TiledStMan, casacore::SSMBase, casacore::MSMBase, casacore::ISMBase, and casacore::ForwardColumnEngine.

◆ canReallocateColumns()

virtual Bool casacore::DataManager::canReallocateColumns ( ) const

virtual

Tell if the data manager wants to reallocate the data manager column objects.

This is used by the tiling storage manager. By default it returns False.

Reimplemented in casacore::TiledStMan, and casacore::MSMBase.

◆ canRemoveColumn()

virtual Bool casacore::DataManager::canRemoveColumn ( ) const

virtual

Does the data manager allow to delete columns? (default no)

Reimplemented in dyscostman::DyscoStMan, casacore::SSMBase, casacore::MSMBase, casacore::ISMBase, casacore::ForwardColumnEngine, and casacore::DerivedMSCal.

◆ canRemoveRow()

virtual Bool casacore::DataManager::canRemoveRow ( ) const

virtual

Does the data manager allow to delete rows? (default no)

Reimplemented in dyscostman::DyscoStMan, casacore::VirtualColumnEngine, casacore::SSMBase, casacore::MSMBase, casacore::ISMBase, and casacore::ForwardColumnEngine.

◆ canRenameColumn()

virtual Bool casacore::DataManager::canRenameColumn ( ) const

virtual

Does the data manager allow to rename columns? (default yes)

◆ checkDataType()

void casacore::DataManager::checkDataType	(	const DataManagerColumn *	colPtr,
		const String &	columnName,
		int	dataType,
		const String &	dataTypeId
	)		const

private

Check if the data type of the created data manager column is correct.

◆ clone()

virtual DataManager* casacore::DataManager::clone ( ) const

pure virtual

◆ create()

virtual void casacore::DataManager::create ( uInt nrrow )

privatevirtual

◆ create64()

virtual void casacore::DataManager::create64 ( rownr_t nrrow )

privatevirtual

Let the data manager initialize itself for a new table.

The default implementation calls the uInt version.

Reimplemented in casacore::VirtualTaQLColumn, casacore::TiledFileHelper, casacore::TiledShapeStMan, casacore::TiledDataStMan, casacore::TiledColumnStMan, casacore::TiledCellStMan, casacore::StManAipsIO, casacore::MSMBase, casacore::ISMBase, casacore::VirtualColumnEngine, casacore::ScaledComplexData< VirtualType, StoredType >, casacore::ScaledArrayEngine< VirtualType, StoredType >, casacore::RetypedArrayEngine< VirtualType, StoredType >, casacore::ForwardColumnIndexedRowEngine, casacore::ForwardColumnEngine, casacore::CompressFloat, casacore::CompressComplexSD, casacore::CompressComplex, casacore::BitFlagsEngine< StoredType >, casacore::BaseMappedArrayEngine< VirtualType, StoredType >, casacore::BaseMappedArrayEngine< Complex, Int >, casacore::BaseMappedArrayEngine< Float, Short >, casacore::BaseMappedArrayEngine< Bool, StoredType >, casacore::SSMBase, and casacore::Adios2StMan.

◆ createDirArrColumn()

DataManagerColumn* casacore::DataManager::createDirArrColumn	(	const String &	columnName,
		int	dataType,
		const String &	dataTypeId
	)

Create a direct array column.

◆ createIndArrColumn()

DataManagerColumn* casacore::DataManager::createIndArrColumn	(	const String &	columnName,
		int	dataType,
		const String &	dataTypeId
	)

Create an indirect array column.

◆ createScalarColumn()

DataManagerColumn* casacore::DataManager::createScalarColumn	(	const String &	columnName,
		int	dataType,
		const String &	dataTypeId
	)

Create a column in the data manager on behalf of a table column.

It calls makeXColumn and checks the data type.

Create a scalar column. The dataTypeId argument is gives the id (i.e. name) of the data type of the column. It is only used for virtual columns of a non-standard data type to be able to check if the correctness of the column data type.
Storage managers only handle standard data types and can readily ignore this argument.

◆ dataManagerInfo()

void casacore::DataManager::dataManagerInfo ( Record & info ) const

Add SEQNR and SPEC (the DataManagerSpec subrecord) to the info.

◆ dataManagerName()

virtual String casacore::DataManager::dataManagerName ( ) const

virtual

Return the name of the data manager.

This is the name of this instantiation of the data manager, thus not its type name. By default it returns an empty string.

Reimplemented in dyscostman::DyscoStMan, casacore::TiledStMan, casacore::SSMBase, casacore::ScaledArrayEngine< VirtualType, StoredType >, casacore::RetypedArrayEngine< VirtualType, StoredType >, casacore::MSMBase, casacore::MappedArrayEngine< VirtualType, StoredType >, casacore::ISMBase, casacore::ForwardColumnEngine, casacore::CompressFloat, casacore::CompressComplex, casacore::BitFlagsEngine< StoredType >, and casacore::Adios2StMan.

Referenced by casacore::RODataManAccessor::dataManagerName().

◆ dataManagerSpec()

virtual Record casacore::DataManager::dataManagerSpec ( ) const

virtual

Return a record containing data manager specifications.

The default implementation returns an empty record.

Reimplemented in dyscostman::DyscoStMan, casacore::VirtualTaQLColumn, casacore::TiledStMan, casacore::TiledShapeStMan, casacore::SSMBase, casacore::ScaledComplexData< VirtualType, StoredType >, casacore::ScaledArrayEngine< VirtualType, StoredType >, casacore::RetypedArrayEngine< VirtualType, StoredType >, casacore::MappedArrayEngine< VirtualType, StoredType >, casacore::ISMBase, casacore::ForwardColumnIndexedRowEngine, casacore::ForwardColumnEngine, casacore::CompressFloat, casacore::CompressComplex, casacore::BitFlagsEngine< StoredType >, casacore::Adios2StMan, and casacore::DerivedMSCal.

◆ dataManagerType()

virtual String casacore::DataManager::dataManagerType ( ) const

pure virtual

Return the type name of the data manager (in fact its class name).

It has to be a unique name, thus if the class is templated the template parameter has to be part of the name. This is used by the open/flush mechanism to be able to reconstruct the correct data manager.

Implemented in dyscostman::DyscoStMan, casacore::VSCEngine< T >, casacore::VirtualTaQLColumn, casacore::VACEngine< T >, casacore::TiledShapeStMan, casacore::TiledFileHelper, casacore::TiledDataStMan, casacore::TiledColumnStMan, casacore::TiledCellStMan, casacore::StManAipsIO, casacore::SSMBase, casacore::ScaledComplexData< VirtualType, StoredType >, casacore::ScaledArrayEngine< VirtualType, StoredType >, casacore::RetypedArrayEngine< VirtualType, StoredType >, casacore::MSMBase, casacore::MappedArrayEngine< VirtualType, StoredType >, casacore::ISMBase, casacore::ForwardColumnIndexedRowEngine, casacore::ForwardColumnEngine, casacore::CompressFloat, casacore::CompressComplexSD, casacore::CompressComplex, casacore::BitFlagsEngine< StoredType >, casacore::Adios2StMan, and casacore::DerivedMSCal.

Referenced by casacore::RODataManAccessor::dataManagerType().

◆ decrementNcolumn()

void casacore::DataManager::decrementNcolumn ( )

inlineprotected

Decrement number of columns (in case a column is deleted).

Definition at line 379 of file DataManager.h.

References nrcol_p.

◆ deleteManager()

virtual void casacore::DataManager::deleteManager ( )

pure virtual

The data manager will be deleted (because all its columns are requested to be deleted).

So clean up the things needed (e.g. delete files).

Implemented in dyscostman::DyscoStMan, casacore::VirtualColumnEngine, casacore::TiledStMan, casacore::StManAipsIO, casacore::SSMBase, casacore::MSMBase, casacore::ISMBase, and casacore::Adios2StMan.

◆ fileName()

String casacore::DataManager::fileName ( ) const

Compose a unique filename from the table name and sequence number.

Referenced by casacore::Adios2StMan::impl::fileName().

◆ fileOption()

ByteIO::OpenOption casacore::DataManager::fileOption ( ) const

Get the AipsIO option of the underlying file.

◆ flush()

virtual Bool casacore::DataManager::flush	(	AipsIO &	ios,
		Bool	fsync
	)

privatepure virtual

Flush and optionally fsync the data.

The AipsIO stream represents the main table file and can be used by virtual column engines to store SMALL amounts of data. It returns a True status if it had to flush (i.e. if data have changed).

Implemented in dyscostman::DyscoStMan, casacore::TiledFileHelper, casacore::VirtualColumnEngine, casacore::TiledShapeStMan, casacore::TiledDataStMan, casacore::TiledColumnStMan, casacore::TiledCellStMan, casacore::StManAipsIO, casacore::MSMBase, casacore::ISMBase, casacore::SSMBase, and casacore::Adios2StMan.

◆ getClone()

DataManager* casacore::DataManager::getClone ( ) const

inline

Has the object already been cloned?

Definition at line 528 of file DataManager.h.

References clone_p.

◆ getCtor()

static DataManagerCtor casacore::DataManager::getCtor ( const String & dataManagerType )

static

Get the "constructor" of a data manager (thread-safe).

◆ getProperties()

virtual Record casacore::DataManager::getProperties ( ) const

virtual

Get data manager properties that can be modified.

It is a subset of the data manager specification. The default implementation returns an empty record.

Reimplemented in casacore::TiledStMan, casacore::SSMBase, casacore::ISMBase, and casacore::BitFlagsEngine< StoredType >.

◆ hasMultiFileSupport()

virtual Bool casacore::DataManager::hasMultiFileSupport ( ) const

protectedvirtual

Does the data manager support use of MultiFile? A derived class has to return True if it can use the MultiFile.

The default implementation returns False.

Reimplemented in casacore::TiledStMan, casacore::SSMBase, and casacore::ISMBase.

◆ initRegisterMap()

static std::map<String,DataManagerCtor> casacore::DataManager::initRegisterMap ( )

staticprivate

Register the main data managers.

◆ isRegistered()

static Bool casacore::DataManager::isRegistered ( const String & dataManagerType )

static

Test if a data manager is registered (thread-safe).

◆ isRegular()

virtual Bool casacore::DataManager::isRegular ( ) const

virtual

Is this a regular storage manager? It is regular if it allows addition of rows and writing data in them.

The default implementation returns True.

◆ isStorageManager()

virtual Bool casacore::DataManager::isStorageManager ( ) const

virtual

Is the data manager a storage manager? The default is yes.

Reimplemented in casacore::VirtualColumnEngine.

◆ keywordName()

String casacore::DataManager::keywordName ( const String & keyword ) const

Compose a keyword name from the given keyword appended with the sequence number (e.g.

key_0). This makes the keyword name unique if multiple data managers are used with the same type.

◆ linkToTable()

void casacore::DataManager::linkToTable ( Table & tab )

private

Link the data manager to the Table object.

◆ makeDirArrColumn()

virtual DataManagerColumn* casacore::DataManager::makeDirArrColumn	(	const String &	columnName,
		int	dataType,
		const String &	dataTypeId
	)

privatepure virtual

Create a direct array column.

Implemented in casacore::TiledStMan, casacore::StManAipsIO, casacore::MSMBase, casacore::ISMBase, casacore::VirtualColumnEngine, casacore::VACEngine< T >, casacore::SSMBase, casacore::Adios2StMan, and dyscostman::DyscoStMan.

◆ makeIndArrColumn()

virtual DataManagerColumn* casacore::DataManager::makeIndArrColumn	(	const String &	columnName,
		int	dataType,
		const String &	dataTypeId
	)

privatepure virtual

Create an indirect array column.

Implemented in casacore::TiledStMan, casacore::StManAipsIO, casacore::MSMBase, casacore::ISMBase, casacore::VirtualTaQLColumn, casacore::VirtualColumnEngine, casacore::VACEngine< T >, casacore::ForwardColumnIndexedRowEngine, casacore::ForwardColumnEngine, casacore::BaseMappedArrayEngine< VirtualType, StoredType >, casacore::BaseMappedArrayEngine< Complex, Int >, casacore::BaseMappedArrayEngine< Float, Short >, casacore::BaseMappedArrayEngine< Bool, StoredType >, casacore::SSMBase, casacore::Adios2StMan, casacore::DerivedMSCal, and dyscostman::DyscoStMan.

◆ makeScalarColumn()

virtual DataManagerColumn* casacore::DataManager::makeScalarColumn	(	const String &	columnName,
		int	dataType,
		const String &	dataTypeId
	)

privatepure virtual

Create a column in the data manager on behalf of a table column.

Create a scalar column.

Implemented in casacore::TiledStMan, casacore::StManAipsIO, casacore::MSMBase, casacore::ISMBase, casacore::VSCEngine< T >, casacore::VirtualColumnEngine, casacore::ForwardColumnIndexedRowEngine, casacore::ForwardColumnEngine, casacore::VirtualTaQLColumn, casacore::SSMBase, casacore::Adios2StMan, casacore::DerivedMSCal, and dyscostman::DyscoStMan.

◆ multiFile()

MultiFileBase* casacore::DataManager::multiFile ( )

inline

Get the MultiFile pointer (can be 0).

Definition at line 297 of file DataManager.h.

References multiFile_p.

◆ ncolumn()

uInt casacore::DataManager::ncolumn ( ) const

inline

Get the nr of columns in this data manager (can be zero).

Definition at line 285 of file DataManager.h.

References nrcol_p.

Referenced by casacore::Adios2StMan::impl::ncolumn().

◆ open()

virtual void casacore::DataManager::open	(	uInt	nrrow,
		AipsIO &	ios
	)

privatevirtual

◆ open1()

virtual uInt casacore::DataManager::open1	(	uInt	nrrow,
		AipsIO &	ios
	)

privatevirtual

◆ open64()

virtual rownr_t casacore::DataManager::open64	(	rownr_t	nrrow,
		AipsIO &	ios
	)

privatevirtual

Let the data manager initialize itself for an existing table.

The AipsIO stream represents the main table file and must be used by virtual column engines to retrieve the data stored in the flush function.
The data manager returns 0 or the nr of rows it thinks there are. This is particularly useful for data managers like LofarStMan whose data are written outside the table system, thus for which no rows have been added.
The default implementation calls the uInt version of open and open1.

Reimplemented in casacore::VirtualColumnEngine, casacore::TiledStMan, casacore::StManAipsIO, casacore::MSMBase, casacore::ISMBase, casacore::Adios2StMan, and casacore::SSMBase.

◆ operator=()

DataManager& casacore::DataManager::operator= ( const DataManager & )

private

Assignment cannot be used for this base class.

The private declaration of this operator makes it unusable.

◆ prepare()

virtual void casacore::DataManager::prepare ( )

privatevirtual

Let the data manager initialize itself further.

Prepare is called after create/open has been called for all columns. In this way one can be sure that referenced columns are read back and partly initialized. The default implementation does nothing.

Reimplemented in dyscostman::DyscoStMan, casacore::VirtualTaQLColumn, casacore::VirtualColumnEngine, casacore::ScaledComplexData< VirtualType, StoredType >, casacore::ScaledArrayEngine< VirtualType, StoredType >, casacore::RetypedArrayEngine< VirtualType, StoredType >, casacore::MSMBase, casacore::ForwardColumnIndexedRowEngine, casacore::ForwardColumnEngine, casacore::CompressFloat, casacore::CompressComplex, casacore::BitFlagsEngine< StoredType >, casacore::BaseMappedArrayEngine< VirtualType, StoredType >, casacore::BaseMappedArrayEngine< Complex, Int >, casacore::BaseMappedArrayEngine< Float, Short >, casacore::BaseMappedArrayEngine< Bool, StoredType >, and casacore::DerivedMSCal.

◆ reallocateColumn()

virtual DataManagerColumn* casacore::DataManager::reallocateColumn ( DataManagerColumn * column )

virtual

Reallocate the column object if it is part of this data manager.

It returns a pointer to the new column object. This function is used by the tiling storage manager. By default it does nothing and returns the input pointer.

Reimplemented in casacore::TiledStMan, and casacore::MSMBase.

◆ registerCtor()

static void casacore::DataManager::registerCtor	(	const String &	type,
		DataManagerCtor	func
	)

static

Register a mapping of a data manager type to its static construction function.

It is fully thread-safe.

◆ removeColumn()

virtual void casacore::DataManager::removeColumn ( DataManagerColumn * )

privatevirtual

Delete a column.

The default implementation throws a "not possible" exception.

Reimplemented in casacore::SSMBase, casacore::MSMBase, casacore::ISMBase, casacore::ForwardColumnEngine, casacore::DerivedMSCal, and dyscostman::DyscoStMan.

◆ removeRow()

virtual void casacore::DataManager::removeRow ( uInt rownr )

privatevirtual

◆ removeRow64()

virtual void casacore::DataManager::removeRow64 ( rownr_t rownr )

privatevirtual

Delete a row from all columns.

The default implementation calls the uInt version.

Reimplemented in casacore::VirtualColumnEngine, casacore::MSMBase, casacore::ISMBase, casacore::ForwardColumnEngine, and casacore::SSMBase.

◆ reopenRW()

virtual void casacore::DataManager::reopenRW ( )

virtual

Reopen the data manager for read/write access.

By default it is assumed that a reopen for read/write does not have to do anything.

Reimplemented in dyscostman::DyscoStMan, casacore::TiledStMan, casacore::StManAipsIO, casacore::SSMBase, casacore::ISMBase, casacore::ForwardColumnIndexedRowEngine, casacore::ForwardColumnEngine, casacore::CompressFloat, and casacore::CompressComplex.

◆ resync()

virtual void casacore::DataManager::resync ( uInt nrrow )

privatevirtual

◆ resync1()

virtual uInt casacore::DataManager::resync1 ( uInt nrrow )

privatevirtual

◆ resync64()

virtual rownr_t casacore::DataManager::resync64 ( rownr_t nrrow )

privatevirtual

Resync the data by rereading cached data from the file.

This is called when a lock is acquired on the file and it appears that data in this data manager has been changed by another process.
The data manager returns 0 or the number of rows it thinks there are. This is particularly useful for data managers like LofarStMan whose data are written outside the table system, thus for which no rows have been added.
The default implementation calls the uInt version of resync and resync1.

Reimplemented in casacore::VirtualColumnEngine, casacore::TiledStMan, casacore::StManAipsIO, casacore::MSMBase, casacore::ISMBase, casacore::SSMBase, and casacore::Adios2StMan.

◆ sequenceNr()

uInt casacore::DataManager::sequenceNr ( ) const

inline

Get the (unique) sequence nr of this data manager.

Definition at line 281 of file DataManager.h.

References seqnr_p.

Referenced by casacore::RODataManAccessor::dataManagerSeqNr().

◆ setClone()

void casacore::DataManager::setClone ( DataManager * clone ) const

inline

Set the pointer to the clone.

Definition at line 532 of file DataManager.h.

References clone(), and clone_p.

◆ setEndian()

void casacore::DataManager::setEndian ( Bool bigEndian )

inlineprotected

Tell the data manager if big or little endian format is needed.

Definition at line 383 of file DataManager.h.

References asBigEndian_p.

◆ setMaximumCacheSize()

virtual void casacore::DataManager::setMaximumCacheSize ( uInt nMiB )

virtual

Set the maximum cache size (in bytes) to be used by a storage manager.

The default implementation does nothing.

Reimplemented in casacore::TiledStMan.

◆ setMultiFile()

void casacore::DataManager::setMultiFile ( MultiFileBase * mfile )

protected

Tell the data manager that MultiFile can be used.

Because MultiFile cannot be used with mmapped files, it sets the TSMOption accordingly.

◆ setProperties()

virtual void casacore::DataManager::setProperties ( const Record & spec )

virtual

Modify data manager properties given in record fields.

Only the properties as returned by getProperties are used, others are ignored. The default implementation does nothing.

Reimplemented in casacore::TiledStMan, casacore::SSMBase, casacore::ISMBase, and casacore::BitFlagsEngine< StoredType >.

◆ setSeqnr()

void casacore::DataManager::setSeqnr ( uInt nr )

inlineprivate

Set the sequence number of this data manager.

Definition at line 464 of file DataManager.h.

References seqnr_p.

◆ setTsmOption()

void casacore::DataManager::setTsmOption ( const TSMOption & tsmOption )

protected

Tell the data manager which TSM option to use.

◆ showCacheStatistics()

virtual void casacore::DataManager::showCacheStatistics ( std::ostream & ) const

virtual

Show the data manager's IO statistics.

By default it does nothing.

Referenced by casacore::RODataManAccessor::showCacheStatistics().

◆ table()

Table& casacore::DataManager::table ( ) const

inline

Get the table this object is associated with.

Definition at line 318 of file DataManager.h.

References table_p.

◆ throwDataTypeOther()

void casacore::DataManager::throwDataTypeOther	(	const String &	columnName,
		int	dataType
	)		const

protected

Throw an exception in case data type is TpOther, because the storage managers (and maybe other data managers) do not support such columns.

◆ tsmOption()

const TSMOption& casacore::DataManager::tsmOption ( ) const

inline

Get the TSM option.

Definition at line 293 of file DataManager.h.

References tsmOption_p.

◆ unknownDataManager()

static DataManager* casacore::DataManager::unknownDataManager	(	const String &	dataManagerType,
		const Record &	spec
	)

static

Serve as default function for theirRegisterMap, which catches all unknown data manager types.

Thrown Exceptions

TableUnknownDataManager

Friends And Related Function Documentation

◆ ColumnSet

friend class ColumnSet

friend

Definition at line 223 of file DataManager.h.

◆ SetupNewTable

friend class SetupNewTable

friend

Definition at line 222 of file DataManager.h.

Member Data Documentation

◆ asBigEndian_p

Bool casacore::DataManager::asBigEndian_p

private

Definition at line 408 of file DataManager.h.

Referenced by asBigEndian(), and setEndian().

◆ clone_p

DataManager* casacore::DataManager::clone_p

mutableprivate

Definition at line 412 of file DataManager.h.

Referenced by getClone(), and setClone().

◆ MAXROWNR32

rownr_t casacore::DataManager::MAXROWNR32

static

Define the highest row number that can be represented as signed 32-bit.

In principle it is the maximum uInt number, but for test purposes it can be reset (to a lower number).

Definition at line 556 of file DataManager.h.

◆ multiFile_p

MultiFileBase* casacore::DataManager::multiFile_p

private

Definition at line 410 of file DataManager.h.

Referenced by multiFile().

◆ nrcol_p

uInt casacore::DataManager::nrcol_p

private

Definition at line 406 of file DataManager.h.

Referenced by decrementNcolumn(), and ncolumn().

◆ seqnr_p

uInt casacore::DataManager::seqnr_p

private

Definition at line 407 of file DataManager.h.

Referenced by sequenceNr(), and setSeqnr().

◆ table_p

Table* casacore::DataManager::table_p

private

Definition at line 411 of file DataManager.h.

Referenced by table().

◆ theirMutex

std::recursive_mutex casacore::DataManager::theirMutex

staticprivate

Definition at line 524 of file DataManager.h.

◆ theirRegisterMap

std::map<String,DataManagerCtor> casacore::DataManager::theirRegisterMap

staticprivate

Declare the mapping of the data manager type name to a static "makeObject" function.

Definition at line 523 of file DataManager.h.

◆ tsmOption_p

TSMOption casacore::DataManager::tsmOption_p

private

Definition at line 409 of file DataManager.h.

Referenced by tsmOption().

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

tables/DataMan/DataManager.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Intended use:

Review Status

Synopsis

Motivation

To Do

Constructor & Destructor Documentation

◆ DataManager() [1/2]

◆ ~DataManager()

◆ DataManager() [2/2]

Member Function Documentation

◆ addColumn()

◆ addRow()

◆ addRow64()

◆ asBigEndian()

◆ canAddColumn()

◆ canAddRow()

◆ canReallocateColumns()

◆ canRemoveColumn()

◆ canRemoveRow()

◆ canRenameColumn()

◆ checkDataType()

◆ clone()

◆ create()

◆ create64()

◆ createDirArrColumn()

◆ createIndArrColumn()

◆ createScalarColumn()

◆ dataManagerInfo()

◆ dataManagerName()

◆ dataManagerSpec()

◆ dataManagerType()

◆ decrementNcolumn()

◆ deleteManager()

◆ fileName()

◆ fileOption()

◆ flush()

◆ getClone()

◆ getCtor()

◆ getProperties()

◆ hasMultiFileSupport()

◆ initRegisterMap()

◆ isRegistered()

◆ isRegular()

◆ isStorageManager()

◆ keywordName()

◆ linkToTable()

◆ makeDirArrColumn()

◆ makeIndArrColumn()

◆ makeScalarColumn()

◆ multiFile()

◆ ncolumn()

◆ open()

◆ open1()

◆ open64()

◆ operator=()

◆ prepare()

◆ reallocateColumn()

◆ registerCtor()

◆ removeColumn()

◆ removeRow()

◆ removeRow64()

◆ reopenRW()

◆ resync()

◆ resync1()

◆ resync64()

◆ sequenceNr()

◆ setClone()

◆ setEndian()

◆ setMaximumCacheSize()

◆ setMultiFile()