casa::vi::VbCacheItem< T, IsComputed > Class Template Reference

#include <VisBufferImpl2Internal.h>

Inheritance diagram for casa::vi::VbCacheItem< T, IsComputed >:

Public Types
typedef T	DataType
typedef void(VisBufferImpl2::*	Filler )(T &) const
Public Member Functions
	VbCacheItem (bool isMutable=false)
virtual	~VbCacheItem ()
virtual void	appendRows (Int, Bool)
virtual void	clear (Bool clearStatusOnly)
virtual void	clearDirty ()
virtual void	copyRowElement (Int, Int)
virtual void	fill () const
const T &	get () const
T &	getRef (Bool fillIfAbsent=True)
void	initialize (VisBufferCache cache, VisBufferImpl2 vb, Filler filler, VisBufferComponent2 component=VisBufferComponent2::Unknown, Bool isKey=True)
Bool	isArray () const
Bool	isDirty () const
Bool	isPresent () const
virtual Bool	isShapeOk () const
virtual void	set (const T &newItem)
template<typename U >
void	set (const U &newItem)
template<typename U >
void	setSpecial (const U &newItem)
virtual void	setDirty ()
virtual String	shapeErrorMessage () const
Protected Member Functions
void	assign (T &lhs, const T &rhs)
virtual void	copy (const VbCacheItemBase *otherRaw, Bool fetchIfNeeded)
	virtual void copy (const VbCacheItemBase * otherRaw, Bool markAsCached) { Convert generic pointer to one pointint to this cache item type.
void	copyAux (const VbCacheItem< T, IsComputed > *other, bool fetchIfNeeded)
T &	getItem () const
void	setAsPresent (Bool isPresent=True) const
Static Protected Member Functions
template<typename E >
static void	clearValue (Array< E > &value)
static void	clearValue (Int &value)
static void	clearValue (MDirection &value)
Private Attributes
Filler	filler_p
Bool	isDirty_p
Bool	isPresent_p
T	item_p
Friends
class	VisBufferImpl2
	Provides a common base class for all of the cached value classes.

Detailed Description

template<typename T, Bool IsComputed = False>
class casa::vi::VbCacheItem< T, IsComputed >

Definition at line 108 of file VisBufferImpl2Internal.h.

Member Typedef Documentation

template<typename T, Bool IsComputed = False>

typedef T casa::vi::VbCacheItem< T, IsComputed >::DataType

Definition at line 114 of file VisBufferImpl2Internal.h.

template<typename T, Bool IsComputed = False>

typedef void(VisBufferImpl2::* casa::vi::VbCacheItem< T, IsComputed >::Filler)(T &) const

Definition at line 115 of file VisBufferImpl2Internal.h.

Constructor & Destructor Documentation

template<typename T, Bool IsComputed = False>

casa::vi::VbCacheItem< T, IsComputed >::VbCacheItem ( bool isMutable = false ) [inline]

Definition at line 117 of file VisBufferImpl2Internal.h.

template<typename T, Bool IsComputed = False>

virtual casa::vi::VbCacheItem< T, IsComputed >::~VbCacheItem ( ) [inline, virtual]

Definition at line 121 of file VisBufferImpl2Internal.h.

Member Function Documentation

template<typename T, Bool IsComputed = False>

virtual void casa::vi::VbCacheItem< T, IsComputed >::appendRows	(	Int	,
		Bool
	)			`[inline, virtual]`

Noop for scalars

Implements casa::vi::VbCacheItemBase.

Definition at line 123 of file VisBufferImpl2Internal.h.

template<typename T, Bool IsComputed = False>

void casa::vi::VbCacheItem< T, IsComputed >::assign	(	T &	lhs,
		const T &	rhs
	)			`[inline, protected]`

Definition at line 299 of file VisBufferImpl2Internal.h.

Referenced by casa::vi::VbCacheItem< Cube< Complex >, False >::set().

template<typename T, Bool IsComputed = False>

virtual void casa::vi::VbCacheItem< T, IsComputed >::clear ( Bool clearStatusOnly ) [inline, virtual]

Implements casa::vi::VbCacheItemBase.

Definition at line 129 of file VisBufferImpl2Internal.h.

template<typename T, Bool IsComputed = False>

virtual void casa::vi::VbCacheItem< T, IsComputed >::clearDirty ( ) [inline, virtual]

Implements casa::vi::VbCacheItemBase.

Definition at line 139 of file VisBufferImpl2Internal.h.

Referenced by casa::vi::VbCacheItem< Cube< Complex >, False >::clear().

template<typename T, Bool IsComputed = False>

static void casa::vi::VbCacheItem< T, IsComputed >::clearValue ( MDirection & value ) [inline, static, protected]

Definition at line 313 of file VisBufferImpl2Internal.h.

template<typename T, Bool IsComputed = False>

static void casa::vi::VbCacheItem< T, IsComputed >::clearValue ( Int & value ) [inline, static, protected]

Definition at line 309 of file VisBufferImpl2Internal.h.

template<typename T, Bool IsComputed = False>

template<typename E >

static void casa::vi::VbCacheItem< T, IsComputed >::clearValue ( Array< E > & value ) [inline, static, protected]

Definition at line 305 of file VisBufferImpl2Internal.h.

Referenced by casa::vi::VbCacheItem< Cube< Complex >, False >::clear().

template<typename T, Bool IsComputed = False>

virtual void casa::vi::VbCacheItem< T, IsComputed >::copy	(	const VbCacheItemBase *	otherRaw,
		Bool	fetchIfNeeded
	)			`[inline, protected, virtual]`

virtual void copy (const VbCacheItemBase * otherRaw, Bool markAsCached) { Convert generic pointer to one pointint to this cache item type.

const VbCacheItem * other = dynamic_cast <const VbCacheItem *> (otherRaw); Assert (other != 0);

Capture the cached status of the other item

isPresent_p = other->isPresent_p;

If the other item was cached then copy it over otherwise clear out this item.

if (isPresent_p){ item_p = other->item_p; } else { item_p = T ();

if (markAsCached){ isPresent_p = True; } } }

Definition at line 347 of file VisBufferImpl2Internal.h.

template<typename T, Bool IsComputed = False>

void casa::vi::VbCacheItem< T, IsComputed >::copyAux	(	const VbCacheItem< T, IsComputed > *	other,
		bool	fetchIfNeeded
	)			`[inline, protected]`

Definition at line 355 of file VisBufferImpl2Internal.h.

Referenced by casa::vi::VbCacheItem< Cube< Complex >, False >::copy().

template<typename T, Bool IsComputed = False>

virtual void casa::vi::VbCacheItem< T, IsComputed >::copyRowElement	(	Int	,
		Int
	)			`[inline, virtual]`

Implements casa::vi::VbCacheItemBase.

Definition at line 144 of file VisBufferImpl2Internal.h.

template<typename T, Bool IsComputed = False>

virtual void casa::vi::VbCacheItem< T, IsComputed >::fill ( ) const [inline, virtual]

Implements casa::vi::VbCacheItemBase.

Definition at line 148 of file VisBufferImpl2Internal.h.

Referenced by casa::vi::VbCacheItem< Cube< Complex >, False >::get(), and casa::vi::VbCacheItem< Cube< Complex >, False >::getRef().

template<typename T, Bool IsComputed = False>

const T& casa::vi::VbCacheItem< T, IsComputed >::get ( ) const [inline]

Definition at line 165 of file VisBufferImpl2Internal.h.

Referenced by casa::vi::VbCacheItem< Cube< Complex >, False >::copyAux().

template<typename T, Bool IsComputed = False>

T& casa::vi::VbCacheItem< T, IsComputed >::getItem ( ) const [inline, protected]

Definition at line 374 of file VisBufferImpl2Internal.h.

Referenced by casa::vi::VbCacheItemArray< Vector< SquareMatrix< Complex, 2 > >, True >::appendRows(), casa::vi::VbCacheItemArray< Vector< SquareMatrix< Complex, 2 > >, True >::copyRowElement(), casa::vi::VbCacheItemArray< Vector< SquareMatrix< Complex, 2 > >, True >::getShape(), casa::vi::VbCacheItemArray< Vector< SquareMatrix< Complex, 2 > >, True >::isShapeOk(), casa::vi::VbCacheItemArray< Vector< SquareMatrix< Complex, 2 > >, True >::resize(), casa::vi::VbCacheItemArray< Vector< SquareMatrix< Complex, 2 > >, True >::resizeRows(), and casa::vi::VbCacheItemArray< Vector< SquareMatrix< Complex, 2 > >, True >::shapeErrorMessage().

template<typename T, Bool IsComputed = False>

T& casa::vi::VbCacheItem< T, IsComputed >::getRef ( Bool fillIfAbsent = True ) [inline]

Caller is getting a modifiabled reference to the datum (otherwise they would use "get"): assume that it will be used to modify the datum and mark it as dirty.

Definition at line 177 of file VisBufferImpl2Internal.h.

Referenced by casa::vi::VisBufferCache::sortCorrelationItem().

template<typename T, Bool IsComputed = False>

void casa::vi::VbCacheItem< T, IsComputed >::initialize	(	VisBufferCache *	cache,
		VisBufferImpl2 *	vb,
		Filler	filler,
		VisBufferComponent2	component = `VisBufferComponent2::Unknown`,
		Bool	isKey = `True`
	)			`[inline]`

Definition at line 195 of file VisBufferImpl2Internal.h.

Referenced by casa::vi::VbCacheItem< Cube< Complex >, False >::initialize().

template<typename T, Bool IsComputed = False>

Bool casa::vi::VbCacheItem< T, IsComputed >::isArray ( ) const [inline, virtual]

Implements casa::vi::VbCacheItemBase.

Definition at line 203 of file VisBufferImpl2Internal.h.

template<typename T, Bool IsComputed = False>

Bool casa::vi::VbCacheItem< T, IsComputed >::isDirty ( ) const [inline, virtual]

Implements casa::vi::VbCacheItemBase.

Definition at line 209 of file VisBufferImpl2Internal.h.

template<typename T, Bool IsComputed = False>

Bool casa::vi::VbCacheItem< T, IsComputed >::isPresent ( ) const [inline, virtual]

Implements casa::vi::VbCacheItemBase.

Definition at line 215 of file VisBufferImpl2Internal.h.

Referenced by casa::vi::VbCacheItem< Cube< Complex >, False >::copyAux(), casa::vi::VbCacheItem< Cube< Complex >, False >::get(), casa::vi::VbCacheItem< Cube< Complex >, False >::getRef(), casa::vi::VbCacheItemArray< Vector< SquareMatrix< Complex, 2 > >, True >::set(), casa::vi::VbCacheItem< Cube< Complex >, False >::setAsPresent(), and casa::vi::VisBufferCache::sortCorrelationItem().

template<typename T, Bool IsComputed = False>

virtual Bool casa::vi::VbCacheItem< T, IsComputed >::isShapeOk ( ) const [inline, virtual]

Implements casa::vi::VbCacheItemBase.

Definition at line 221 of file VisBufferImpl2Internal.h.

Referenced by casa::vi::VbCacheItem< Cube< Complex >, False >::set().

template<typename T, Bool IsComputed = False>

template<typename U >

void casa::vi::VbCacheItem< T, IsComputed >::set ( const U & newItem ) [inline]

Definition at line 256 of file VisBufferImpl2Internal.h.

template<typename T, Bool IsComputed = False>

virtual void casa::vi::VbCacheItem< T, IsComputed >::set ( const T & newItem ) [inline, virtual]

Set operations to a rekeyable VB are allowed to change the shapes of the values. When T derives from Array, the assign method will use Array::assign which resizes the destination value to match the source value. For nonkeyable VBs, the normal operator= method is used which for Arrays will throw an exception when a shape incompatibility exists between the source and destination.