casacore::AipsrcVector< T > Class Template Reference

Read multiple values from the Aipsrc resource files. More...

#include <AipsrcVector.h>

Inheritance diagram for casacore::AipsrcVector< T >:

List of all members.

Public Member Functions
	AipsrcVector ()
	Default constructor See a note in AipsrcValue .
	~AipsrcVector ()
Static Public Member Functions
static Bool	find (Vector< T > &value, const String &keyword)
	The find() functions will, given a keyword, return the value of a matched keyword found in the files.
static Bool	find (Vector< T > &value, const String &keyword, const Vector< T > &deflt)
static Bool	find (Vector< T > &value, const String &keyword, const Unit &defun, const Unit &resun)
	These find() functions will, given a keyword, read the values of a matched keyword as a Quantity.
static Bool	find (Vector< T > &value, const String &keyword, const Unit &defun, const Unit &resun, const Vector< T > &deflt)
static uInt	registerRC (const String &keyword, const Vector< T > &deflt)
	Functions to register keywords for later use in get() and set().
static uInt	registerRC (const String &keyword, const Unit &defun, const Unit &resun, const Vector< T > &deflt)
static const Vector< T > &	get (uInt keyword)
	Gets are like find, but using registered integers rather than names.
static void	set (uInt keyword, const Vector< T > &deflt)
	Sets allow registered values to be set.
static void	save (uInt keyword)
	Save registered value to $HOME/.aipsrc.
Private Member Functions
AipsrcVector< T > &	operator= (const AipsrcVector< T > &other)
	Copy constructor (not implemented).
	AipsrcVector (const AipsrcVector< T > &other)
Private Attributes
Block< Vector< T > >	tlst
	register list
Block< String >	ntlst
Static Private Attributes
static AipsrcVector	myp_p
static Mutex	theirMutex

---

Detailed Description

template<class T>
class casacore::AipsrcVector< T >

Read multiple values from the Aipsrc resource files.

Intended use:

Public interface

Review Status

Reviewed By:

mhaller

Date Reviewed:

1997/10/08

Test programs:

tAipsrcValue

Prerequisite

• AipsrcValue

Etymology

A class for getting multiple values from the Aipsrc files

Synopsis

The available functions (and notes) are the same as in AipsrcValue , but with a Vector result.

Template Type Argument Requirements

• All types with a >> defined.
  Warning: Since interpretation of the keyword value string is done with the standard input right-shift operator, specialisations are necessary for non-standard cases like Bool and String; They are provided;
  

Example

Motivation

Programs need a way to get multi-valued keywords from the Aipsrc files.

Thrown Exceptions

• AipsError if the environment variables HOME and/or AIPSPATH not set.

Definition at line 86 of file AipsrcVector.h.

---

Constructor & Destructor Documentation

template<class T>

casacore::AipsrcVector< T >::AipsrcVector

(

)

Default constructor See a note in AipsrcValue .

template<class T>

casacore::AipsrcVector< T >::~AipsrcVector

(

)

template<class T>

casacore::AipsrcVector< T >::AipsrcVector

(

const AipsrcVector< T > &

other

)

[private]

---

Member Function Documentation

template<class T>

static Bool casacore::AipsrcVector< T >::find	(	Vector< T > &	value,
		const String &	keyword,
		const Unit &	defun,
		const Unit &	resun,
		const Vector< T > &	deflt
	)			[static]

template<class T>

static Bool casacore::AipsrcVector< T >::find	(	Vector< T > &	value,
		const String &	keyword,
		const Unit &	defun,
		const Unit &	resun
	)			[static]

These find() functions will, given a keyword, read the values of a matched keyword as a Quantity.

If no unit has been given in the keyword value, the defun Unit will be assumed. The value returned will be converted to the resun Unit. If no match found, the default value is returned (see example above).

template<class T>

static Bool casacore::AipsrcVector< T >::find	(	Vector< T > &	value,
		const String &	keyword,
		const Vector< T > &	deflt
	)			[static]

template<class T>

static Bool casacore::AipsrcVector< T >::find	(	Vector< T > &	value,
		const String &	keyword
	)			[static]

The find() functions will, given a keyword, return the value of a matched keyword found in the files.

If no match found the function will be False, and the default returned if specified.

template<class T>

static const Vector<T>& casacore::AipsrcVector< T >::get

(

uInt

keyword

)

[static]

Gets are like find, but using registered integers rather than names.

Reimplemented from casacore::Aipsrc.

template<class T>

AipsrcVector<T>& casacore::AipsrcVector< T >::operator=

(

const AipsrcVector< T > &

other

)

[private]

Copy constructor (not implemented).

template<class T>

static uInt casacore::AipsrcVector< T >::registerRC	(	const String &	keyword,
		const Unit &	defun,
		const Unit &	resun,
		const Vector< T > &	deflt
	)			[static]

template<class T>

static uInt casacore::AipsrcVector< T >::registerRC	(	const String &	keyword,
		const Vector< T > &	deflt
	)			[static]

Functions to register keywords for later use in get() and set().

The returned value is the index for get() and set().

template<class T>

static void casacore::AipsrcVector< T >::save

(

uInt

keyword

)

[static]

Save registered value to $HOME/.aipsrc.

Reimplemented from casacore::Aipsrc.

template<class T>

static void casacore::AipsrcVector< T >::set	(	uInt	keyword,
		const Vector< T > &	deflt
	)			[static]

Sets allow registered values to be set.

---

Member Data Documentation

template<class T>

AipsrcVector casacore::AipsrcVector< T >::myp_p [static, private]

Definition at line 142 of file AipsrcVector.h.

template<class T>

Block<String> casacore::AipsrcVector< T >::ntlst [private]

Definition at line 147 of file AipsrcVector.h.

template<class T>

Mutex casacore::AipsrcVector< T >::theirMutex [static, private]

Reimplemented from casacore::Aipsrc.

Definition at line 143 of file AipsrcVector.h.

template<class T>

Block<Vector<T> > casacore::AipsrcVector< T >::tlst [private]

register list

Definition at line 146 of file AipsrcVector.h.

---

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

• casacore/casa/System/AipsrcVector.h