casa::AttributeValueBase Class Reference

Base class for values of Attributes used in the display classes. More...

#include <AttValBase.h>

Inheritance diagram for casa::AttributeValueBase:

Public Member Functions
	AttributeValueBase (AttValue::ValueType type, Bool strict)
	Constructor.
	AttributeValueBase (const AttributeValueBase &other)
	Copy constructor.
virtual	~AttributeValueBase ()
	Destructor.
const AttributeValueBase &	operator= (const AttributeValueBase &other)
	Copy assignment.
AttValue::ValueType	getType () const
	Get the type of the value stored.
Bool	operator== (const AttributeValueBase &other) const
	Check for equality (and inequality) of two objects derived from AttributeValueBase.
Bool	operator!= (const AttributeValueBase &other) const
virtual AttributeValueBase *	clone () const =0
	Return a new copy of the AttributeValueBase.
virtual void	setStrictness (const Bool &newStrict)
	Set/get the strictness state of this AttributeValue.
virtual Bool	getStrictness () const
virtual void	operator+= (const AttributeValueBase &other)=0
	Add `other` to `*this`.
virtual String	className () const
	Return class name.
virtual void	print (ostream &os)=0
Protected Member Functions
virtual Bool	matches (const AttributeValueBase &other) const =0
	Calculate whether `*this` matches `other`.
virtual void	setType (const AttValue::ValueType &newType)
	Set the type of the value stored.
Bool	myMatch (const AttributeValueBase &other) const
	Check that private data match.
Protected Attributes
AttValue::ValueType	itsValueType
	The type of what is stored.
Bool	itsStrictness
	Whether the match is strict or not.

Detailed Description

Base class for values of Attributes used in the display classes.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd
Test programs:: tAttribute

Etymology

"AttributeValueBase" is a concatenation, representing a "Base" class for "Attribute Values."

Synopsis

This class is the base for storing Attribute values. Attributes are simple name-value pairs, where the name is a String, and the value can be a scalar or Array.

This class defines the type-independent interface for Attribute values, and the type-dependent interface and implementation is provided in AttributeValue . This type independent interface allows comparison of Attributes of different types.

Motivation

To provide the non-templated (ie. type-independent) interface of AttributeValues in a single place, thus enabling the hiding of the templated aspect of Attributes from the end-user. In particular it allows implementation of the comparison operators in the base class, regardless of type.

Definition at line 182 of file AttValBase.h.

Constructor & Destructor Documentation

casa::AttributeValueBase::AttributeValueBase	(	AttValue::ValueType	type,
		Bool	strict
	)

Constructor.

casa::AttributeValueBase::AttributeValueBase ( const AttributeValueBase & other )

Copy constructor.

virtual casa::AttributeValueBase::~AttributeValueBase ( ) [virtual]

Destructor.

Member Function Documentation

virtual String casa::AttributeValueBase::className ( ) const [inline, virtual]

Return class name.

Reimplemented in casa::AttributeValue< T >, casa::AttributeValuePoi< T >, casa::AttributeValuePoiTol< T >, and casa::AttributeValueTol< T >.

Definition at line 230 of file AttValBase.h.

References String.

virtual AttributeValueBase* casa::AttributeValueBase::clone ( ) const [pure virtual]

Return a new copy of the AttributeValueBase.

Implemented in casa::AttributeValue< T >, casa::AttributeValuePoi< T >, casa::AttributeValuePoiTol< T >, and casa::AttributeValueTol< T >.

virtual Bool casa::AttributeValueBase::getStrictness ( ) const [virtual]

AttValue::ValueType casa::AttributeValueBase::getType ( ) const

Get the type of the value stored.

virtual Bool casa::AttributeValueBase::matches ( const AttributeValueBase & other ) const [protected, pure virtual]

Calculate whether *this matches other.

Since the meaning of "match" can be different for different types, it is left to the derived class to define this method.

Bool casa::AttributeValueBase::myMatch ( const AttributeValueBase & other ) const [protected]

Check that private data match.

Reimplemented in casa::AttributeValue< T >.

Bool casa::AttributeValueBase::operator!= ( const AttributeValueBase & other ) const

virtual void casa::AttributeValueBase::operator+= ( const AttributeValueBase & other ) [pure virtual]

Add other to *this.

const AttributeValueBase& casa::AttributeValueBase::operator= ( const AttributeValueBase & other )

Copy assignment.

Reimplemented in casa::AttributeValue< T >, casa::AttributeValuePoi< T >, casa::AttributeValuePoiTol< T >, and casa::AttributeValueTol< T >.

Bool casa::AttributeValueBase::operator== ( const AttributeValueBase & other ) const

Check for equality (and inequality) of two objects derived from AttributeValueBase.

It is implemented in terms of the pure virtual method matches, which must be implemented in derived classes. The operator== only returns True if this->matches(other) and other.matches(*this) are both True. This guarantees that if a == b it follows that b == a (this is enforced this way because a and b can be classes derived differently from AttributeValueBase which can therefore have a different implementation of match()).

virtual void casa::AttributeValueBase::print ( ostream & os ) [pure virtual]

Implemented in casa::AttributeValue< T >.

virtual void casa::AttributeValueBase::setStrictness ( const Bool & newStrict ) [virtual]

Set/get the strictness state of this AttributeValue.

virtual void casa::AttributeValueBase::setType ( const AttValue::ValueType & newType ) [protected, virtual]

Set the type of the value stored.

Member Data Documentation

Bool casa::AttributeValueBase::itsStrictness [protected]

Whether the match is strict or not.

Definition at line 242 of file AttValBase.h.

AttValue::ValueType casa::AttributeValueBase::itsValueType [protected]

The type of what is stored.

Definition at line 239 of file AttValBase.h.

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

code/display/Display/AttValBase.h