casa::AipsrcVector< T > Class Template Reference
[System]

#include <AipsrcVector.h>

Inheritance diagram for casa::AipsrcVector< T >:

[legend]Collaboration diagram for casa::AipsrcVector< T >:

[legend]List of all members.

---

Detailed Description

template<class T>
class casa::AipsrcVector< T >

Read multiple values from the Aipsrc resource files.

Intended use:

Part of API

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.

To Do

Definition at line 85 of file AipsrcVector.h.

Public Member Functions
	AipsrcVector ()
	Default constructor See a note in AipsrcValue .
	~AipsrcVector ()
Static Public Member Functions
static void	save (uInt keyword)
	Save registered value to $HOME/.aipsrc.
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.
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

---

Constructor & Destructor Documentation

template<class T>

casa::AipsrcVector< T >::AipsrcVector

(

)

Default constructor See a note in AipsrcValue .

template<class T>

casa::AipsrcVector< T >::~AipsrcVector

(

)

template<class T>

casa::AipsrcVector< T >::AipsrcVector

(

const AipsrcVector< T > &

other

)

[private]

---

Member Function Documentation

template<class T>

static Bool casa::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 Bool casa::AipsrcVector< T >::find	(	Vector< T > &	value,
		const String &	keyword,
		const Vector< T > &	deflt
	)			[static]

template<class T>

static Bool casa::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 casa::AipsrcVector< T >::find	(	Vector< T > &	value,
		const String &	keyword,
		const Unit &	defun,
		const Unit &	resun,
		const Vector< T > &	deflt
	)			[static]

template<class T>

static uInt casa::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 uInt casa::AipsrcVector< T >::registerRC	(	const String &	keyword,
		const Unit &	defun,
		const Unit &	resun,
		const Vector< T > &	deflt
	)			[static]

template<class T>

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

(

uInt

keyword

)

[static]

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

Reimplemented from casa::Aipsrc.

template<class T>

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

Sets allow registered values to be set.

template<class T>

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

(

uInt

keyword

)

[static]

Save registered value to $HOME/.aipsrc.

Reimplemented from casa::Aipsrc.

template<class T>

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

(

const AipsrcVector< T > &

other

)

[private]

Copy constructor (not implemented).

---

Member Data Documentation

template<class T>

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

Definition at line 141 of file AipsrcVector.h.

template<class T>

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

register list

Definition at line 144 of file AipsrcVector.h.

template<class T>

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

Definition at line 145 of file AipsrcVector.h.

---

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

• casa/implement/System/AipsrcVector.h

---