casacore
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
casacore::AipsrcVector< T > Class Template Reference

More...

#include <AipsrcVector.h>

Public Member Functions

 AipsrcVector ()
 Default constructor See a note in AipsrcValue. More...
 
 ~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. More...
 
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. More...
 
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(). More...
 
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. More...
 
static void set (uInt keyword, const Vector< T > &deflt)
 Sets allow registered values to be set. More...
 
static void save (uInt keyword)
 Save registered value to $HOME/.aipsrc More...
 

Private Member Functions

AipsrcVector< T > & operator= (const AipsrcVector< T > &other)
 Copy constructor (not implemented) More...
 
 AipsrcVector (const AipsrcVector< T > &other)
 

Private Attributes

Block< Vector< T > > tlst
 register list More...
 
Block< Stringntlst
 

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

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

Example

Motivation

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

Thrown Exceptions

Definition at line 86 of file AipsrcVector.h.

Constructor & Destructor Documentation

◆ AipsrcVector() [1/2]

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

Default constructor See a note in AipsrcValue.

◆ ~AipsrcVector()

template<class T >
casacore::AipsrcVector< T >::~AipsrcVector ( )

◆ AipsrcVector() [2/2]

template<class T >
casacore::AipsrcVector< T >::AipsrcVector ( const AipsrcVector< T > &  other)
private

Member Function Documentation

◆ find() [1/4]

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.

◆ find() [2/4]

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).

◆ find() [3/4]

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

◆ find() [4/4]

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

◆ get()

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.

◆ operator=()

template<class T >
AipsrcVector<T>& casacore::AipsrcVector< T >::operator= ( const AipsrcVector< T > &  other)
private

Copy constructor (not implemented)

◆ registerRC() [1/2]

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

◆ registerRC() [2/2]

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().

◆ save()

template<class T >
static void casacore::AipsrcVector< T >::save ( uInt  keyword)
static

Save registered value to $HOME/.aipsrc

◆ set()

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

◆ myp_p

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

Definition at line 142 of file AipsrcVector.h.

◆ ntlst

template<class T >
Block<String> casacore::AipsrcVector< T >::ntlst
private

Definition at line 147 of file AipsrcVector.h.

◆ theirMutex

template<class T >
Mutex casacore::AipsrcVector< T >::theirMutex
staticprivate

Definition at line 143 of file AipsrcVector.h.

◆ tlst

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 files: