casacore::ValueHolder Class Reference

A holder for a value of any basic Casacore data type. More...

#include <ValueHolder.h>

Public Member Functions
	ValueHolder ()
	Construct a null object.
	ValueHolder (Bool value)
	Create the object for the given value.
	ValueHolder (uChar value)
	ValueHolder (Short value)
	ValueHolder (uShort value)
	ValueHolder (Int value)
	ValueHolder (uInt value)
	ValueHolder (Int64 value)
	ValueHolder (Float value)
	ValueHolder (Double value)
	ValueHolder (const Complex &value)
	ValueHolder (const DComplex &value)
	ValueHolder (const Char *value)
	ValueHolder (const String &value)
	ValueHolder (const Array< Bool > &value)
	ValueHolder (const Array< uChar > &value)
	ValueHolder (const Array< Short > &value)
	ValueHolder (const Array< uShort > &value)
	ValueHolder (const Array< Int > &value)
	ValueHolder (const Array< uInt > &value)
	ValueHolder (const Array< Int64 > &value)
	ValueHolder (const Array< Float > &value)
	ValueHolder (const Array< Double > &value)
	ValueHolder (const Array< Complex > &value)
	ValueHolder (const Array< DComplex > &value)
	ValueHolder (const Array< String > &value)
	ValueHolder (const Record &value)
	ValueHolder (uInt ndim, Bool dummy)
	Create an empty N-dim array (gets type TpOther).
	ValueHolder (ValueHolderRep *rep)
	Create a ValueHolder from a ValueHolderRep.
	ValueHolder (const ValueHolder &)
	Copy constructor (reference semantics).
	~ValueHolder ()
	Destructor.
ValueHolder &	operator= (const ValueHolder &)
	Assignment (reference semantics).
Bool	isNull () const
	Is this a null object?
DataType	dataType () const
	Get the data type (as defined in DataType.h).
Bool	asBool () const
	Get the value.
uChar	asuChar () const
Short	asShort () const
uShort	asuShort () const
Int	asInt () const
uInt	asuInt () const
Int64	asInt64 () const
Float	asFloat () const
Double	asDouble () const
Complex	asComplex () const
DComplex	asDComplex () const
const String &	asString () const
const Array< Bool >	asArrayBool () const
const Array< uChar >	asArrayuChar () const
const Array< Short >	asArrayShort () const
const Array< uShort >	asArrayuShort () const
const Array< Int >	asArrayInt () const
const Array< uInt >	asArrayuInt () const
const Array< Int64 >	asArrayInt64 () const
const Array< Float >	asArrayFloat () const
const Array< Double >	asArrayDouble () const
const Array< Complex >	asArrayComplex () const
const Array< DComplex >	asArrayDComplex () const
const Array< String >	asArrayString () const
const Record &	asRecord () const
void	getValue (Bool &value) const
	Get the data in a way useful for templates.
void	getValue (uChar &value) const
void	getValue (Short &value) const
void	getValue (uShort &value) const
void	getValue (Int &value) const
void	getValue (uInt &value) const
void	getValue (Int64 &value) const
void	getValue (Float &value) const
void	getValue (Double &value) const
void	getValue (Complex &value) const
void	getValue (DComplex &value) const
void	getValue (String &value) const
void	getValue (Array< Bool > &value) const
void	getValue (Array< uChar > &value) const
void	getValue (Array< Short > &value) const
void	getValue (Array< uShort > &value) const
void	getValue (Array< Int > &value) const
void	getValue (Array< uInt > &value) const
void	getValue (Array< Int64 > &value) const
void	getValue (Array< Float > &value) const
void	getValue (Array< Double > &value) const
void	getValue (Array< Complex > &value) const
void	getValue (Array< DComplex > &value) const
void	getValue (Array< String > &value) const
void	toRecord (Record &, const RecordFieldId &) const
	Put the value as a field in a record.
bool	operator< (const ValueHolder &right) const
	Compare two ValueHolder objects.
Static Public Member Functions
static ValueHolder	fromRecord (const Record &, const RecordFieldId &)
	Construct the object from the value in a record.
Private Attributes
CountedPtr< ValueHolderRep >	itsRep
Friends
std::ostream &	operator<< (std::ostream &os, const ValueHolder &vh)
	Write the ValueHolder to an output stream.

Detailed Description

A holder for a value of any basic Casacore data type.

Intended use:

Public interface

Review Status

Test programs:: tValueHolder

Synopsis

Class ValueHolder is meant to be used for holding a single Casacore value. The value can be scalar or an array of any basic type (including complex and string). Also a Record value is possible. In this way varying typed data (e.g. the result of getCell in the table DO) can be packed in a strongly typed variable.
All unsigned integer type values are kept as signed 32-bit integers because scripting languages usually only support those types.

ValueHolder is an envelope class that holds a counted-referenced letter object ValueHolderRep .

Motivation

This class comes handy in passing arbitrary values from a DO to its environment.

Definition at line 67 of file ValueHolder.h.

Constructor & Destructor Documentation

casacore::ValueHolder::ValueHolder ( ) [inline]

Construct a null object.

Definition at line 71 of file ValueHolder.h.

Referenced by fromRecord().

casacore::ValueHolder::ValueHolder ( Bool value ) [explicit]

Create the object for the given value.

casacore::ValueHolder::ValueHolder ( uChar value ) [explicit]

casacore::ValueHolder::ValueHolder ( Short value ) [explicit]

casacore::ValueHolder::ValueHolder ( uShort value ) [explicit]

casacore::ValueHolder::ValueHolder ( Int value ) [explicit]

casacore::ValueHolder::ValueHolder ( uInt value ) [explicit]

casacore::ValueHolder::ValueHolder ( Int64 value ) [explicit]

casacore::ValueHolder::ValueHolder ( Float value ) [explicit]

casacore::ValueHolder::ValueHolder ( Double value ) [explicit]

casacore::ValueHolder::ValueHolder ( const Complex & value ) [explicit]

casacore::ValueHolder::ValueHolder ( const DComplex & value ) [explicit]

casacore::ValueHolder::ValueHolder ( const Char * value ) [explicit]

casacore::ValueHolder::ValueHolder ( const String & value ) [explicit]

casacore::ValueHolder::ValueHolder ( const Array< Bool > & value ) [explicit]

casacore::ValueHolder::ValueHolder ( const Array< uChar > & value ) [explicit]

casacore::ValueHolder::ValueHolder ( const Array< Short > & value ) [explicit]

casacore::ValueHolder::ValueHolder ( const Array< uShort > & value ) [explicit]

casacore::ValueHolder::ValueHolder ( const Array< Int > & value ) [explicit]

casacore::ValueHolder::ValueHolder ( const Array< uInt > & value ) [explicit]

casacore::ValueHolder::ValueHolder ( const Array< Int64 > & value ) [explicit]

casacore::ValueHolder::ValueHolder ( const Array< Float > & value ) [explicit]

casacore::ValueHolder::ValueHolder ( const Array< Double > & value ) [explicit]

casacore::ValueHolder::ValueHolder ( const Array< Complex > & value ) [explicit]

casacore::ValueHolder::ValueHolder ( const Array< DComplex > & value ) [explicit]

casacore::ValueHolder::ValueHolder ( const Array< String > & value ) [explicit]

casacore::ValueHolder::ValueHolder ( const Record & value ) [explicit]

casacore::ValueHolder::ValueHolder	(	uInt	ndim,
		Bool	dummy
	)

Create an empty N-dim array (gets type TpOther).

casacore::ValueHolder::ValueHolder ( ValueHolderRep * rep ) [inline, explicit]

Create a ValueHolder from a ValueHolderRep.

It takes over the pointer and deletes it in the destructor.

Definition at line 109 of file ValueHolder.h.

casacore::ValueHolder::ValueHolder ( const ValueHolder & )

Copy constructor (reference semantics).

casacore::ValueHolder::~ValueHolder ( ) [inline]

Destructor.

Definition at line 117 of file ValueHolder.h.

Member Function Documentation

const Array< Bool > casacore::ValueHolder::asArrayBool ( ) const [inline]

Definition at line 254 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

const Array< Complex > casacore::ValueHolder::asArrayComplex ( ) const [inline]

Definition at line 272 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

const Array< DComplex > casacore::ValueHolder::asArrayDComplex ( ) const [inline]

Definition at line 274 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

const Array< Double > casacore::ValueHolder::asArrayDouble ( ) const [inline]

Definition at line 270 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

const Array< Float > casacore::ValueHolder::asArrayFloat ( ) const [inline]

Definition at line 268 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

const Array< Int > casacore::ValueHolder::asArrayInt ( ) const [inline]

Definition at line 262 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

const Array< Int64 > casacore::ValueHolder::asArrayInt64 ( ) const [inline]

Definition at line 266 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

const Array< Short > casacore::ValueHolder::asArrayShort ( ) const [inline]

Definition at line 258 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

const Array< String > casacore::ValueHolder::asArrayString ( ) const [inline]

Definition at line 276 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

const Array< uChar > casacore::ValueHolder::asArrayuChar ( ) const [inline]

Definition at line 256 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

const Array< uInt > casacore::ValueHolder::asArrayuInt ( ) const [inline]

Definition at line 264 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

const Array< uShort > casacore::ValueHolder::asArrayuShort ( ) const [inline]

Definition at line 260 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

Bool casacore::ValueHolder::asBool ( ) const [inline]

Get the value.

If possible, it converts the data as needed.

Definition at line 230 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

Complex casacore::ValueHolder::asComplex ( ) const [inline]

Definition at line 248 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

DComplex casacore::ValueHolder::asDComplex ( ) const [inline]

Definition at line 250 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

Double casacore::ValueHolder::asDouble ( ) const [inline]

Definition at line 246 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

Float casacore::ValueHolder::asFloat ( ) const [inline]

Definition at line 244 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

Int casacore::ValueHolder::asInt ( ) const [inline]

Definition at line 238 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

Int64 casacore::ValueHolder::asInt64 ( ) const [inline]

Definition at line 242 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

const Record & casacore::ValueHolder::asRecord ( ) const [inline]

Definition at line 278 of file ValueHolder.h.

References itsRep.

Short casacore::ValueHolder::asShort ( ) const [inline]

Definition at line 234 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

const String & casacore::ValueHolder::asString ( ) const [inline]

Definition at line 252 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

uChar casacore::ValueHolder::asuChar ( ) const [inline]

Definition at line 232 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

uInt casacore::ValueHolder::asuInt ( ) const [inline]

Definition at line 240 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

uShort casacore::ValueHolder::asuShort ( ) const [inline]

Definition at line 236 of file ValueHolder.h.

References itsRep.

Referenced by getValue().

DataType casacore::ValueHolder::dataType ( ) const [inline]

Get the data type (as defined in DataType.h).

Definition at line 223 of file ValueHolder.h.

References itsRep.

ValueHolder casacore::ValueHolder::fromRecord	(	const Record &	rec,
		const RecordFieldId &	id
	)			`[inline, static]`

Construct the object from the value in a record.

Definition at line 227 of file ValueHolder.h.

References casacore::ValueHolderRep::fromRecord(), and ValueHolder().

void casacore::ValueHolder::getValue ( Array< String > & value ) const [inline]

Definition at line 197 of file ValueHolder.h.

References asArrayString(), and casacore::Array< T >::reference().

void casacore::ValueHolder::getValue ( Array< DComplex > & value ) const [inline]

Definition at line 195 of file ValueHolder.h.

References asArrayDComplex(), and casacore::Array< T >::reference().

void casacore::ValueHolder::getValue ( Array< Complex > & value ) const [inline]

Definition at line 193 of file ValueHolder.h.

References asArrayComplex(), and casacore::Array< T >::reference().

void casacore::ValueHolder::getValue ( Array< Double > & value ) const [inline]

Definition at line 191 of file ValueHolder.h.

References asArrayDouble(), and casacore::Array< T >::reference().

void casacore::ValueHolder::getValue ( Array< Float > & value ) const [inline]

Definition at line 189 of file ValueHolder.h.

References asArrayFloat(), and casacore::Array< T >::reference().

void casacore::ValueHolder::getValue ( Array< Int64 > & value ) const [inline]

Definition at line 187 of file ValueHolder.h.

References asArrayInt64(), and casacore::Array< T >::reference().

void casacore::ValueHolder::getValue ( Array< uInt > & value ) const [inline]

Definition at line 185 of file ValueHolder.h.

References asArrayuInt(), and casacore::Array< T >::reference().

void casacore::ValueHolder::getValue ( Array< Int > & value ) const [inline]

Definition at line 183 of file ValueHolder.h.

References asArrayInt(), and casacore::Array< T >::reference().

void casacore::ValueHolder::getValue ( Array< uShort > & value ) const [inline]

Definition at line 181 of file ValueHolder.h.

References asArrayuShort(), and casacore::Array< T >::reference().

void casacore::ValueHolder::getValue ( Array< Short > & value ) const [inline]

Definition at line 179 of file ValueHolder.h.

References asArrayShort(), and casacore::Array< T >::reference().

void casacore::ValueHolder::getValue ( Array< uChar > & value ) const [inline]

Definition at line 177 of file ValueHolder.h.

References asArrayuChar(), and casacore::Array< T >::reference().

void casacore::ValueHolder::getValue ( Array< Bool > & value ) const [inline]

Definition at line 175 of file ValueHolder.h.

References asArrayBool(), and casacore::Array< T >::reference().

void casacore::ValueHolder::getValue ( String & value ) const [inline]

Definition at line 174 of file ValueHolder.h.

References asString().

void casacore::ValueHolder::getValue ( DComplex & value ) const [inline]

Definition at line 173 of file ValueHolder.h.

References asDComplex().

void casacore::ValueHolder::getValue ( Complex & value ) const [inline]

Definition at line 172 of file ValueHolder.h.

References asComplex().

void casacore::ValueHolder::getValue ( Double & value ) const [inline]

Definition at line 171 of file ValueHolder.h.

References asDouble().

void casacore::ValueHolder::getValue ( Float & value ) const [inline]

Definition at line 170 of file ValueHolder.h.

References asFloat().

void casacore::ValueHolder::getValue ( Int64 & value ) const [inline]

Definition at line 169 of file ValueHolder.h.

References asInt64().

void casacore::ValueHolder::getValue ( uInt & value ) const [inline]

Definition at line 168 of file ValueHolder.h.

References asuInt().

void casacore::ValueHolder::getValue ( Int & value ) const [inline]

Definition at line 167 of file ValueHolder.h.

References asInt().

void casacore::ValueHolder::getValue ( uShort & value ) const [inline]

Definition at line 166 of file ValueHolder.h.

References asuShort().

void casacore::ValueHolder::getValue ( Short & value ) const [inline]

Definition at line 165 of file ValueHolder.h.

References asShort().

void casacore::ValueHolder::getValue ( uChar & value ) const [inline]

Definition at line 164 of file ValueHolder.h.

References asuChar().

void casacore::ValueHolder::getValue ( Bool & value ) const [inline]

Get the data in a way useful for templates.

If possible, it converts the the data as needed.

Definition at line 163 of file ValueHolder.h.

References asBool().

Bool casacore::ValueHolder::isNull ( ) const [inline]

Is this a null object?

Definition at line 124 of file ValueHolder.h.

References itsRep, and casacore::CountedPtr< t >::null().

bool casacore::ValueHolder::operator< ( const ValueHolder & right ) const [inline]

Compare two ValueHolder objects.

They must have the same data type.

Definition at line 209 of file ValueHolder.h.

References itsRep.

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

Assignment (reference semantics).

void casacore::ValueHolder::toRecord	(	Record &	rec,
		const RecordFieldId &	id
	)			const `[inline]`

Put the value as a field in a record.

Definition at line 225 of file ValueHolder.h.

References itsRep.

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const ValueHolder &	vh
	)			`[friend]`

Write the ValueHolder to an output stream.

Arrays are written as normal arrays using ArrayIO.h.

Definition at line 214 of file ValueHolder.h.

Member Data Documentation

CountedPtr<ValueHolderRep> casacore::ValueHolder::itsRep [private]

Definition at line 219 of file ValueHolder.h.

Referenced by asArrayBool(), asArrayComplex(), asArrayDComplex(), asArrayDouble(), asArrayFloat(), asArrayInt(), asArrayInt64(), asArrayShort(), asArrayString(), asArrayuChar(), asArrayuInt(), asArrayuShort(), asBool(), asComplex(), asDComplex(), asDouble(), asFloat(), asInt(), asInt64(), asRecord(), asShort(), asString(), asuChar(), asuInt(), asuShort(), dataType(), isNull(), operator<(), and toRecord().

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

casacore/casa/Containers/ValueHolder.h

casacore::ValueHolder Class Reference

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Detailed Description

Intended use:

Review Status

Synopsis

Motivation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation