casa::RefRows Class Reference
[Tables_internal_classes]

#include <RefRows.h>

Collaboration diagram for casa::RefRows:

[legend]List of all members.

---

Detailed Description

Class holding the row numbers in a RefTable.

Intended use:

Internal

Review Status

Reviewed By:

UNKNOWN

Date Reviewed:

before2004/08/25

Test programs:

tRefRows

Prerequisite

• Vector

Synopsis

RefRows is used to hold the row numbers forming a view on another table. It contains a vector which can hold the row numbers in 2 ways:

1. As a normal series of row numbers. This is used by e.g. class RefTable
2. As a series of Slices. In this case 3 subsequent entries in the vector are used to represent start, end, and increment. This is used by a function like ScalarColumn::getColumnRange.

Class RefRowsSliceIter can be used to iterate through a RefRows object. Each step in the iteration goes to the next a slice. If the RefRows objct contains a simple series of row numbers, each slice contains only one row number. This can degrade performance, so it is possible to use shortcuts by testing if the object contains slices (using isSliced()) and getting the row number vector directly (using rowVector()).

Motivation

RefRows is meant to have one class representing the various ways of picking row numbers. This simplifies the interface of the table and data manager classes dealing with getting/putting the data.

Definition at line 84 of file RefRows.h.

Public Member Functions
	RefRows (const Vector< uInt > &rowNumbers, Bool isSliced=False, Bool collapse=False)
	Create the object from a Vector containing the row numbers.
	RefRows (uInt start, uInt end, uInt incr=1)
	Create the object from a single start,end,incr slice.
	RefRows (const RefRows &other)
	Copy constructor (reference semantics).
RefRows &	operator= (const RefRows &other)
	Assignment (copy semantics).
	~RefRows ()
Bool	operator== (const RefRows &other) const
	Do this and the other object reference the same rows?
Vector< uInt >	convert (const Vector< uInt > &rootRownrs) const
	Convert this object to a Vector<uInt> by applying the given row numbers.
uInt	firstRow () const
	Return the first row in the object.
Bool	isSliced () const
	Represents the vector a slice?
const Vector< uInt > &	rowVector () const
	Get the row vector as is (thus sliced if the object contains slices).
uInt	nrows () const
	Return the number of rows given by this object.
uInt	nrow () const
Private Member Functions
uInt	fillNrows () const
	Fill the itsNrows variable.
Private Attributes
Vector< uInt >	itsRows
uInt	itsNrows
Bool	itsSliced

---

Constructor & Destructor Documentation

casa::RefRows::RefRows	(	const Vector< uInt > &	rowNumbers,
		Bool	isSliced = False,
		Bool	collapse = False
	)

Create the object from a Vector containing the row numbers.

When isSliced==False, the vector is treated as containing individual row numbers, otherwise as containing slices in the form start,end,incr. When collapse==True, it will try to collapse the individual row numbers to the slice form (to save memory).

casa::RefRows::RefRows	(	uInt	start,
		uInt	end,
		uInt	incr = 1
	)

Create the object from a single start,end,incr slice.

casa::RefRows::RefRows

(

const RefRows &

other

)

Copy constructor (reference semantics).

casa::RefRows::~RefRows

(

)

---

Member Function Documentation

RefRows& casa::RefRows::operator=

(

const RefRows &

other

)

Assignment (copy semantics).

Bool casa::RefRows::operator==

(

const RefRows &

other

)

const

Do this and the other object reference the same rows?

Vector<uInt> casa::RefRows::convert

(

const Vector< uInt > &

rootRownrs

)

const

Convert this object to a Vector<uInt> by applying the given row numbers.

It is used to convert the RefRows object with row numbers in a RefTable to row numbers in the original root table.

uInt casa::RefRows::nrows

(

)

const [inline]

Return the number of rows given by this object.

If the object contains slices, it counts the number of rows represented by each slice.

Definition at line 120 of file RefRows.h.

References fillNrows(), and itsNrows.

uInt casa::RefRows::nrow

(

)

const [inline]

Definition at line 122 of file RefRows.h.

References fillNrows(), and itsNrows.

uInt casa::RefRows::firstRow

(

)

const [inline]

Return the first row in the object.

Definition at line 127 of file RefRows.h.

References itsRows.

Bool casa::RefRows::isSliced

(

)

const [inline]

Represents the vector a slice?

Definition at line 131 of file RefRows.h.

References itsSliced.

const Vector<uInt>& casa::RefRows::rowVector

(

)

const [inline]

Get the row vector as is (thus sliced if the object contains slices).

It is mainly useful to get all row numbers when the object does not contain slices.

Definition at line 137 of file RefRows.h.

References itsRows.

uInt casa::RefRows::fillNrows

(

)

const [private]

Fill the itsNrows variable.

Referenced by nrow(), and nrows().

---

Member Data Documentation

Vector<uInt> casa::RefRows::itsRows [private]

Definition at line 144 of file RefRows.h.

Referenced by firstRow(), and rowVector().

uInt casa::RefRows::itsNrows [private]

Definition at line 145 of file RefRows.h.

Referenced by nrow(), and nrows().

Bool casa::RefRows::itsSliced [private]

Definition at line 146 of file RefRows.h.

Referenced by isSliced().

---

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

• tables/implement/Tables/RefRows.h

---