casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
casacore::MemoryStMan Class Reference

Memory-based table storage manager class. More...

#include <MemoryStMan.h>

Inheritance diagram for casacore::MemoryStMan:
casacore::MSMBase casacore::DataManager

Public Member Functions

 MemoryStMan ()
 Create an Memory storage manager. More...
 
 MemoryStMan (const String &storageManagerName)
 Create an Memory storage manager with the given name. More...
 
 ~MemoryStMan ()
 
- Public Member Functions inherited from casacore::MSMBase
 MSMBase ()
 Create a memory storage manager. More...
 
 MSMBase (const String &storageManagerName)
 Create a memory storage manager with the given name. More...
 
 MSMBase (const String &storageManagerName, const Record &)
 
 ~MSMBase ()
 
DataManagerclone () const
 Clone this object. More...
 
String dataManagerType () const
 Get the type name of the data manager (i.e. More...
 
String dataManagerName () const
 Get the name given to this storage manager. More...
 
uInt nrow () const
 Get the nr of rows in this storage manager. More...
 
Bool canAddRow () const
 Does the storage manager allow to add rows? (yes) More...
 
Bool canRemoveRow () const
 Does the storage manager allow to delete rows? (yes) More...
 
Bool canAddColumn () const
 Does the storage manager allow to add columns? (yes) More...
 
Bool canRemoveColumn () const
 Does the storage manager allow to delete columns? (yes) More...
 
- Public Member Functions inherited from casacore::DataManager
 DataManager ()
 Default constructor. More...
 
virtual ~DataManager ()
 
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...
 
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 TSMOptiontsmOption () const
 Get the TSM option. More...
 
MultiFileBasemultiFile ()
 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...
 
Tabletable () const
 Get the table this object is associated with. More...
 
virtual void reopenRW ()
 Reopen the data manager for read/write access. More...
 
virtual Bool canRenameColumn () const
 Does the data manager allow to rename columns? (default yes) More...
 
virtual void setMaximumCacheSize (uInt nbytes)
 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...
 
DataManagerColumncreateScalarColumn (const String &columnName, int dataType, const String &dataTypeId)
 Create a column in the data manager on behalf of a table column. More...
 
DataManagerColumncreateDirArrColumn (const String &columnName, int dataType, const String &dataTypeId)
 Create a direct array column. More...
 
DataManagerColumncreateIndArrColumn (const String &columnName, int dataType, const String &dataTypeId)
 Create an indirect array column. More...
 
DataManagergetClone () const
 Has the object already been cloned? More...
 
void setClone (DataManager *clone) const
 Set the pointer to the clone. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from casacore::MSMBase
static DataManagermakeObject (const String &dataManagerType, const Record &spec)
 Make the object from the string. More...
 
- Static Public Member Functions inherited from casacore::DataManager
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 DataManagerunknownDataManager (const String &dataManagerType, const Record &spec)
 Serve as default function for theirRegisterMap, which catches all unknown data manager types. More...
 
- Protected Member Functions inherited from casacore::DataManager
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...
 

Detailed Description

Memory-based table storage manager class.

Intended use:

Public interface

Review Status

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

Prerequisite

Synopsis

MemoryStMan is a table storage manager based in memory. It holds all data in the columns in memory and deletes them when the table gets closed. It contains pointers to the underlying MSMColumn objects, which do the actual data handling.

The Memory storage manager does fully support addition and removal of rows and columns.

The primary use of this storage manager is for a memory-based table, but it can also be used for temporary columns in disk-based tables. When reopening a disk-based table, possible columns stored with MemoryStMan will be initialized to 0. An important issue is synchronizing tables containing MemoryStMan storage managers in case of concurrent access. Because its data are not stored on disk, there is no way to synchronize the data if another process changed data or added or deleted rows. If the number or rows has changed, rows will be added or deleted as needed. Row deletion will be done at the end of the table.

Definition at line 81 of file MemoryStMan.h.

Constructor & Destructor Documentation

casacore::MemoryStMan::MemoryStMan ( )

Create an Memory storage manager.

Its name will be blank.

casacore::MemoryStMan::MemoryStMan ( const String storageManagerName)

Create an Memory storage manager with the given name.

Its name can be used later in e.g. Table::addColumn to add a column to this storage manager.

casacore::MemoryStMan::~MemoryStMan ( )

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