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

ROCalHistoryColumns: Read-only cal_history calibration table column access. More...

#include <CalHistoryColumns.h>

Public Member Functions

 ROCalHistoryColumns (const CalTable &calTable)
 Construct from a cal_history calibration sub-table. More...
 
virtual ~ROCalHistoryColumns ()
 Default destructor. More...
 
const casacore::ScalarColumn
< casacore::String > & 
calParms () const
 Read-only column accessors. More...
 
const casacore::ScalarColumn
< casacore::String > & 
calTables () const
 
const casacore::ScalarColumn
< casacore::String > & 
calSelect () const
 
const casacore::ScalarColumn
< casacore::String > & 
calNotes () const
 

Protected Member Functions

 ROCalHistoryColumns ()
 Prohibit public use of the null constructor, which does not produce a usable object. More...
 
const casacore::TablecalHistoryAsTable (const CalTable &calTable)
 Return a CalTable cal_history subtable as a casacore::Table reference. More...
 
void attach (const CalTable &calTable, casacore::TableColumn &tabCol, MSCalEnums::colDef colEnum, const casacore::Bool &optional=false)
 Attach a table column accessor. More...
 

Private Member Functions

 ROCalHistoryColumns (const ROCalHistoryColumns &)
 Prohibit copy constructor and assignment operator. More...
 
ROCalHistoryColumnsoperator= (const ROCalHistoryColumns &)
 

Private Attributes

casacore::ScalarColumn
< casacore::String
calParms_p
 Private column accessors. More...
 
casacore::ScalarColumn
< casacore::String
calTables_p
 
casacore::ScalarColumn
< casacore::String
calSelect_p
 
casacore::ScalarColumn
< casacore::String
calNotes_p
 

Detailed Description

ROCalHistoryColumns: Read-only cal_history calibration table column access.

Intended use:

Public interface

Prerequisite

Etymology

From "read-only", "calibration history table" and "columns".

Synopsis

The ROCalHistoryColumns class allows read-only access to columns in the cal_history calibration sub-table.

Example

Motivation

Encapsulate read-only access to cal_history calibration sub-table columns.

Definition at line 75 of file CalHistoryColumns.h.

Constructor & Destructor Documentation

casa::ROCalHistoryColumns::ROCalHistoryColumns ( const CalTable calTable)

Construct from a cal_history calibration sub-table.

virtual casa::ROCalHistoryColumns::~ROCalHistoryColumns ( )
inlinevirtual

Default destructor.

Definition at line 82 of file CalHistoryColumns.h.

casa::ROCalHistoryColumns::ROCalHistoryColumns ( )
inlineprotected

Prohibit public use of the null constructor, which does not produce a usable object.

Definition at line 93 of file CalHistoryColumns.h.

casa::ROCalHistoryColumns::ROCalHistoryColumns ( const ROCalHistoryColumns )
private

Prohibit copy constructor and assignment operator.

Member Function Documentation

void casa::ROCalHistoryColumns::attach ( const CalTable calTable,
casacore::TableColumn tabCol,
MSCalEnums::colDef  colEnum,
const casacore::Bool optional = false 
)
protected

Attach a table column accessor.

const casacore::Table& casa::ROCalHistoryColumns::calHistoryAsTable ( const CalTable calTable)
inlineprotected

Return a CalTable cal_history subtable as a casacore::Table reference.

Utilizes friendship relationship with class CalTable.

Definition at line 97 of file CalHistoryColumns.h.

References casa::CalTable::calHistoryAsTable().

const casacore::ScalarColumn<casacore::String>& casa::ROCalHistoryColumns::calNotes ( ) const
inline

Definition at line 88 of file CalHistoryColumns.h.

References calNotes_p.

const casacore::ScalarColumn<casacore::String>& casa::ROCalHistoryColumns::calParms ( ) const
inline

Read-only column accessors.

Definition at line 85 of file CalHistoryColumns.h.

References calParms_p.

const casacore::ScalarColumn<casacore::String>& casa::ROCalHistoryColumns::calSelect ( ) const
inline

Definition at line 87 of file CalHistoryColumns.h.

References calSelect_p.

const casacore::ScalarColumn<casacore::String>& casa::ROCalHistoryColumns::calTables ( ) const
inline

Definition at line 86 of file CalHistoryColumns.h.

References calTables_p.

ROCalHistoryColumns& casa::ROCalHistoryColumns::operator= ( const ROCalHistoryColumns )
private

Member Data Documentation

casacore::ScalarColumn<casacore::String> casa::ROCalHistoryColumns::calNotes_p
private

Definition at line 113 of file CalHistoryColumns.h.

Referenced by calNotes().

casacore::ScalarColumn<casacore::String> casa::ROCalHistoryColumns::calParms_p
private

Private column accessors.

Definition at line 110 of file CalHistoryColumns.h.

Referenced by calParms().

casacore::ScalarColumn<casacore::String> casa::ROCalHistoryColumns::calSelect_p
private

Definition at line 112 of file CalHistoryColumns.h.

Referenced by calSelect().

casacore::ScalarColumn<casacore::String> casa::ROCalHistoryColumns::calTables_p
private

Definition at line 111 of file CalHistoryColumns.h.

Referenced by calTables().


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