casa::ValueHolderRep Class Reference

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

#include <ValueHolderRep.h>

List of all members.

Public Member Functions
	ValueHolderRep (Bool value)
	Create the object for the given value.
	ValueHolderRep (uChar value)
	ValueHolderRep (Short value)
	ValueHolderRep (uShort value)
	ValueHolderRep (Int value)
	ValueHolderRep (uInt value)
	ValueHolderRep (Int64 value)
	ValueHolderRep (Float value)
	ValueHolderRep (Double value)
	ValueHolderRep (const Complex &value)
	ValueHolderRep (const DComplex &value)
	ValueHolderRep (const Char *value)
	ValueHolderRep (const String &value)
	ValueHolderRep (const Array< Bool > &value)
	ValueHolderRep (const Array< uChar > &value)
	ValueHolderRep (const Array< Short > &value)
	ValueHolderRep (const Array< uShort > &value)
	ValueHolderRep (const Array< Int > &value)
	ValueHolderRep (const Array< uInt > &value)
	ValueHolderRep (const Array< Int64 > &value)
	ValueHolderRep (const Array< Float > &value)
	ValueHolderRep (const Array< Double > &value)
	ValueHolderRep (const Array< Complex > &value)
	ValueHolderRep (const Array< DComplex > &value)
	ValueHolderRep (const Array< String > &value)
	ValueHolderRep (const Record &value)
	ValueHolderRep (uInt ndim, Bool dummy)
	Create an empty N-dim array.
	~ValueHolderRep ()
	Destructor.
void	link ()
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	toRecord (Record &, const RecordFieldId &) const
	Put the value as a field in a record.
std::ostream &	write (std::ostream &os) const
	Write the ValueHolderRep to an output stream.
Static Public Member Functions
static void	unlink (ValueHolderRep *rep)
static ValueHolderRep *	fromRecord (const Record &rec, const RecordFieldId &)
	Construct the object from the value in a record.
Private Member Functions
	ValueHolderRep (const ValueHolderRep &)
	Forbid copy ctor and assignment.
ValueHolderRep &	operator= (const ValueHolderRep &)
Private Attributes
Int	itsCount
uInt	itsNdim
DataType	itsType
union {
Bool   itsBool
uChar   itsUChar
Short   itsShort
Int   itsInt
Int64   itsInt64
Float   itsFloat
Double   itsDouble
void *   itsPtr
};

---

Detailed Description

A holder for a value of any basic type.

Intended use:

Internal

Review Status

Test programs:

tValueHolder

Synopsis

Class ValueHolderRep is the letter class for the envelope class ValueHolder. See that class for more information.

Motivation

Copying ValueHolders should be as cheap as possible, so a counted referenced letter class is used.

Definition at line 65 of file ValueHolderRep.h.

---

Constructor & Destructor Documentation

casa::ValueHolderRep::ValueHolderRep

(

Bool

value

)

[explicit]

Create the object for the given value.

casa::ValueHolderRep::ValueHolderRep

(

uChar

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

Short

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

uShort

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

Int

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

uInt

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

Int64

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

Float

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

Double

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const Complex &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const DComplex &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const Char *

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const String &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const Array< Bool > &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const Array< uChar > &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const Array< Short > &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const Array< uShort > &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const Array< Int > &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const Array< uInt > &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const Array< Int64 > &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const Array< Float > &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const Array< Double > &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const Array< Complex > &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const Array< DComplex > &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const Array< String > &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep

(

const Record &

value

)

[explicit]

casa::ValueHolderRep::ValueHolderRep	(	uInt	ndim,
		Bool	dummy
	)

Create an empty N-dim array.

casa::ValueHolderRep::~ValueHolderRep

(

)

Destructor.

casa::ValueHolderRep::ValueHolderRep

(

const ValueHolderRep &

)

[private]

Forbid copy ctor and assignment.

---

Member Function Documentation

const Array<Bool> casa::ValueHolderRep::asArrayBool

(

)

const

Referenced by casa::ValueHolder::asArrayBool().

const Array<Complex> casa::ValueHolderRep::asArrayComplex

(

)

const

Referenced by casa::ValueHolder::asArrayComplex().

const Array<DComplex> casa::ValueHolderRep::asArrayDComplex

(

)

const

Referenced by casa::ValueHolder::asArrayDComplex().

const Array<Double> casa::ValueHolderRep::asArrayDouble

(

)

const

Referenced by casa::ValueHolder::asArrayDouble().

const Array<Float> casa::ValueHolderRep::asArrayFloat

(

)

const

Referenced by casa::ValueHolder::asArrayFloat().

const Array<Int> casa::ValueHolderRep::asArrayInt

(

)

const

Referenced by casa::ValueHolder::asArrayInt().

const Array<Int64> casa::ValueHolderRep::asArrayInt64

(

)

const

Referenced by casa::ValueHolder::asArrayInt64().

const Array<Short> casa::ValueHolderRep::asArrayShort

(

)

const

Referenced by casa::ValueHolder::asArrayShort().

const Array<String> casa::ValueHolderRep::asArrayString

(

)

const

Referenced by casa::ValueHolder::asArrayString().

const Array<uChar> casa::ValueHolderRep::asArrayuChar

(

)

const

Referenced by casa::ValueHolder::asArrayuChar().

const Array<uInt> casa::ValueHolderRep::asArrayuInt

(

)

const

Referenced by casa::ValueHolder::asArrayuInt().

const Array<uShort> casa::ValueHolderRep::asArrayuShort

(

)

const

Referenced by casa::ValueHolder::asArrayuShort().

Bool casa::ValueHolderRep::asBool

(

)

const

Get the value.

It throws an exception if the data type is incorrect.

Referenced by casa::ValueHolder::asBool().

Complex casa::ValueHolderRep::asComplex

(

)

const

Referenced by casa::ValueHolder::asComplex().

DComplex casa::ValueHolderRep::asDComplex

(

)

const

Referenced by casa::ValueHolder::asDComplex().

Double casa::ValueHolderRep::asDouble

(

)

const

Referenced by casa::ValueHolder::asDouble().

Float casa::ValueHolderRep::asFloat

(

)

const

Referenced by casa::ValueHolder::asFloat().

Int casa::ValueHolderRep::asInt

(

)

const

Referenced by casa::ValueHolder::asInt().

Int64 casa::ValueHolderRep::asInt64

(

)

const

Referenced by casa::ValueHolder::asInt64().

const Record& casa::ValueHolderRep::asRecord

(

)

const

Referenced by casa::ValueHolder::asRecord().

Short casa::ValueHolderRep::asShort

(

)

const

Referenced by casa::ValueHolder::asShort().

const String& casa::ValueHolderRep::asString

(

)

const

Referenced by casa::ValueHolder::asString().

uChar casa::ValueHolderRep::asuChar

(

)

const

Referenced by casa::ValueHolder::asuChar().

uInt casa::ValueHolderRep::asuInt

(

)

const

Referenced by casa::ValueHolder::asuInt().

uShort casa::ValueHolderRep::asuShort

(

)

const

Referenced by casa::ValueHolder::asuShort().

DataType casa::ValueHolderRep::dataType

(

)

const [inline]

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

Definition at line 179 of file ValueHolderRep.h.

References itsType.

Referenced by casa::ValueHolder::dataType().

static ValueHolderRep* casa::ValueHolderRep::fromRecord	(	const Record &	rec,
		const RecordFieldId &
	)		[static]

Construct the object from the value in a record.

Referenced by casa::ValueHolder::fromRecord().

void casa::ValueHolderRep::link

(

)

[inline]

Definition at line 104 of file ValueHolderRep.h.

References itsCount.

ValueHolderRep& casa::ValueHolderRep::operator=

(

const ValueHolderRep &

)

[private]

void casa::ValueHolderRep::toRecord	(	Record &	,
		const RecordFieldId &
	)		const

Put the value as a field in a record.

Referenced by casa::ValueHolder::toRecord().

static void casa::ValueHolderRep::unlink

(

ValueHolderRep *

rep

)

[inline, static]

Definition at line 107 of file ValueHolderRep.h.

References itsCount.

std::ostream& casa::ValueHolderRep::write

(

std::ostream &

os

)

const

Write the ValueHolderRep to an output stream.

Arrays are written as normal arrays using ArrayIO.h.

---

Member Data Documentation

union { ... } [private]

Bool casa::ValueHolderRep::itsBool

Definition at line 167 of file ValueHolderRep.h.

Int casa::ValueHolderRep::itsCount [private]

Definition at line 163 of file ValueHolderRep.h.

Referenced by link(), and unlink().

Double casa::ValueHolderRep::itsDouble

Definition at line 173 of file ValueHolderRep.h.

Float casa::ValueHolderRep::itsFloat

Definition at line 172 of file ValueHolderRep.h.

Int casa::ValueHolderRep::itsInt

Definition at line 170 of file ValueHolderRep.h.

Int64 casa::ValueHolderRep::itsInt64

Definition at line 171 of file ValueHolderRep.h.

uInt casa::ValueHolderRep::itsNdim [private]

Definition at line 164 of file ValueHolderRep.h.

void* casa::ValueHolderRep::itsPtr

Definition at line 174 of file ValueHolderRep.h.

Short casa::ValueHolderRep::itsShort

Definition at line 169 of file ValueHolderRep.h.

DataType casa::ValueHolderRep::itsType [private]

Definition at line 165 of file ValueHolderRep.h.

Referenced by dataType().

uChar casa::ValueHolderRep::itsUChar

Definition at line 168 of file ValueHolderRep.h.

---

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

• casacore/casa/Containers/ValueHolderRep.h