casacore
Public Member Functions | Protected Member Functions | List of all members
casacore::ArrayColumnDescBase Class Reference

More...

#include <ArrColDesc.h>

Public Member Functions

 ArrayColumnDescBase (const String &name, const String &comment, const String &dataManagerType, const String &dataManagerGroup, DataType, const String &dataTypeId, Int options, uInt ndim, const IPosition &shape)
 Construct with given parameters. More...
 
 ArrayColumnDescBase (const ArrayColumnDescBase &)
 Copy constructor (copy semantics);. More...
 
 ~ArrayColumnDescBase ()
 
ArrayColumnDescBaseoperator= (const ArrayColumnDescBase &)
 Assignment (copy semantics);. More...
 
String className () const
 Get the name of this class. More...
 
virtual PlainColumnmakeColumn (ColumnSet *) const
 Create a Column object out of this. More...
 
void show (ostream &os) const
 Show the column. More...
 
- Public Member Functions inherited from casacore::BaseColumnDesc
 BaseColumnDesc (const String &name, const String &comment, const String &dataManagerType, const String &dataManagerGroup, DataType, const String &dataTypeId, Int options, uInt ndim, const IPosition &shape, Bool isScalar, Bool isArray, Bool isTable)
 Construct the column base object. More...
 
 BaseColumnDesc (const BaseColumnDesc &)
 Copy constructor (copy semantics). More...
 
virtual ~BaseColumnDesc ()
 
TableRecordrwKeywordSet ()
 Get access to the set of keywords. More...
 
const TableRecordkeywordSet () const
 
const Stringname () const
 Get the name of the column. More...
 
DataType dataType () const
 Get the data type of the column. More...
 
const StringdataTypeId () const
 Get the type id for non-standard data types (i.e. More...
 
const StringdataManagerType () const
 Get the type name of the default data manager. More...
 
StringdataManagerType ()
 Get the type name of the default data manager. More...
 
const StringdataManagerGroup () const
 Get the data manager group. More...
 
StringdataManagerGroup ()
 Get the data manager group. More...
 
void setDefaultDataManager (Bool always)
 Set the data manager type and group to the default. More...
 
const Stringcomment () const
 Get comment string. More...
 
Stringcomment ()
 Get comment string (allowing it to be changed). More...
 
Int options () const
 Get the options. More...
 
Bool isScalar () const
 Test if column is scalar, array or table. More...
 
Bool isArray () const
 
Bool isTable () const
 
Int ndim () const
 Get the number of dimensions. More...
 
const IPositionshape () const
 Get the predefined shape. More...
 
void setNdim (uInt ndim)
 Set the number of dimensions. More...
 
void setShape (const IPosition &shape)
 Set the predefined shape. More...
 
void setShape (const IPosition &shape, Bool directOption)
 
void setOptions (Int options)
 Set the options to the given value. More...
 
uInt maxLength () const
 Get the maximum value length. More...
 
void setMaxLength (uInt maxLength)
 Set the maximum value length. More...
 
const TableDesctableDesc () const
 Get table description (in case column contains subtables). More...
 
virtual TableDesctableDesc ()
 
virtual BaseColumnDescclone () const =0
 Clone a column description (creating a new column description object). More...
 
void setName (const String &name)
 Set the name of the column (for a rename). More...
 

Protected Member Functions

virtual void putDesc (AipsIO &) const
 Put the object. More...
 
virtual void getDesc (AipsIO &)
 Get the object. More...
 
- Protected Member Functions inherited from casacore::BaseColumnDesc
BaseColumnDescoperator= (const BaseColumnDesc &)
 Assignment (copy semantics). More...
 
void putFile (AipsIO &, const TableAttr &) const
 Put the object. More...
 
void getFile (AipsIO &, const TableAttr &)
 Get the object. More...
 
RefColumnmakeRefColumn (RefTable *, BaseColumn *) const
 Make a RefColumn object out of the description. More...
 
virtual ConcatColumnmakeConcatColumn (ConcatTable *) const
 Make a ConcatColumn object out of the description. More...
 

Additional Inherited Members

- Protected Attributes inherited from casacore::BaseColumnDesc
String colName_p
 
String comment_p
 
String dataManType_p
 
String dataManGroup_p
 
DataType dtype_p
 
String dtypeId_p
 
Int option_p
 
Int nrdim_p
 
IPosition shape_p
 
uInt maxLength_p
 
TableRecordkeySetPtr_p
 
Bool isScalar_p
 
Bool isArray_p
 
Bool isTable_p
 

Detailed Description

Abstract base class for description of table array columns

Intended use:

Internal

Review Status

Reviewed By:
Gareth Hunt
Date Reviewed:
94Nov17

Prerequisite

Synopsis

This class contains the common functionality for the templated class ArrayColumnDesc which describes an array column.

Definition at line 63 of file ArrColDesc.h.

Constructor & Destructor Documentation

◆ ArrayColumnDescBase() [1/2]

casacore::ArrayColumnDescBase::ArrayColumnDescBase ( const String name,
const String comment,
const String dataManagerType,
const String dataManagerGroup,
DataType  ,
const String dataTypeId,
Int  options,
uInt  ndim,
const IPosition shape 
)

Construct with given parameters.

◆ ArrayColumnDescBase() [2/2]

casacore::ArrayColumnDescBase::ArrayColumnDescBase ( const ArrayColumnDescBase )

Copy constructor (copy semantics);.

◆ ~ArrayColumnDescBase()

casacore::ArrayColumnDescBase::~ArrayColumnDescBase ( )

Member Function Documentation

◆ className()

String casacore::ArrayColumnDescBase::className ( ) const
virtual

Get the name of this class.

It is used by the registration process. The template argument gets part of the name.

Implements casacore::BaseColumnDesc.

◆ getDesc()

virtual void casacore::ArrayColumnDescBase::getDesc ( AipsIO )
protectedvirtual

Get the object.

Implements casacore::BaseColumnDesc.

◆ makeColumn()

virtual PlainColumn* casacore::ArrayColumnDescBase::makeColumn ( ColumnSet ) const
virtual

Create a Column object out of this.

This is used by class ColumnSet to construct a table column object.

Implements casacore::BaseColumnDesc.

◆ operator=()

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

Assignment (copy semantics);.

◆ putDesc()

virtual void casacore::ArrayColumnDescBase::putDesc ( AipsIO ) const
protectedvirtual

Put the object.

Implements casacore::BaseColumnDesc.

◆ show()

void casacore::ArrayColumnDescBase::show ( ostream &  os) const
virtual

Show the column.

Implements casacore::BaseColumnDesc.


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