Specialization of AipsrcValue for Bool. More...

#include <AipsrcValue.h>

Public Member Functions
	AipsrcValue ()

	~AipsrcValue ()

Static Public Member Functions
static Bool	find (Bool &value, const String &keyword)

static Bool	find (Bool &value, const String &keyword, const Bool &deflt)

static uInt	registerRC (const String &keyword, const Bool &deflt)

static const Bool &	get (uInt keyword)

static void	set (uInt keyword, const Bool &deflt)

static void	save (uInt keyword)

Static Public Member Functions inherited from casacore::Aipsrc
static Bool	find (String &value, const String &keyword)

static Bool	findNoHome (String &value, const String &keyword)

static Bool	find (uInt &value, const String &keyword, Int Nname, const String tname[])
	These finds check a (possible) value of the keyword against a list of coded values provided, and return an index into the list (N if not found).

static Bool	find (uInt &value, const String &keyword, const Vector< String > &tname)

static Bool	find (String &value, const String &keyword, const String &deflt)
	This find usually saves you some lines of code, since you can supply the default you want to use when no such keyword is defined.

static Bool	findNoHome (String &value, const String &keyword, const String &deflt)

static Bool	find (uInt &value, const String &keyword, Int Nname, const String tname[], const String &deflt)

static Bool	find (uInt &value, const String &keyword, const Vector< String > &tname, const String &deflt)

static Bool	findDir (String &foundDir, const String &lastPart="", const Vector< String > &prepends=Vector< String >(), const Vector< String > &appends=Vector< String >(), Bool useStds=True)
	Sets foundDir to the first /firstPart/lastPart path that it finds present on the system, where /firstPart comes from, in order, this list: contents of prepends.

static uInt	registerRC (const String &keyword, const String &deflt)
	Functions to register keywords for later use in get() and set().

static uInt	registerRC (const String &keyword, Int Nname, const String tname[], const String &deflt)

static uInt	registerRC (const String &keyword, const Vector< String > &tname, const String &deflt)

static const String &	get (uInt keyword)
	Gets are like find, but using registered integers rather than names.

static const uInt &	get (uInt &code, uInt keyword)
	get for code

static void	set (uInt keyword, const String &deflt)
	Sets allow registered values to be set.

static void	set (uInt keyword, Int Nname, const String tname[], const String &deflt)

static void	set (uInt keyword, const Vector< String > &tname, const String &deflt)

static void	save (uInt keyword)
	Save a registered keyword value to `$HOME/.aipsrc`

static void	save (uInt keyword, const String tname[])

static void	save (uInt keyword, const Vector< String > &tname)

static void	setAipsPath (const String &path=String())
	Set an AIPSPATH that should be used in stead of a global AIPSPATH.

static const String &	aipsRoot ()
	Returns the appropriate Casacore or system variable values.

static const String &	aipsArch ()

static const String &	aipsSite ()

static const String &	aipsHost ()

static const String &	aipsHome ()
	Returns: `~/aips++`

static void	reRead ()
	The `reRead()` function will reinitialise the static maps and read the aipsrc files again.

static Double	lastRead ()

static const Block< String > &	values ()
	The following functions return the full lists of available data.

static const Block< String > &	patterns ()

static void	show (ostream &oStream)
	The following `show()` function, useful for debugging, outputs all keyword/value pairs found.

static void	show ()
	Prints all info on cout.

static uInt	genRestore (Vector< String > &namlst, Vector< String > &vallst, const String &fileList)
	The following set is a general set of functions.

static void	genSave (Vector< String > &namlst, Vector< String > &vallst, const String &fnam)
	Save the names/values in file.

static void	genSet (Vector< String > &namlst, Vector< String > &vallst, const String &nam, const String &val)
	Set (new or overwrite) keyword/value pair.

static Bool	genUnSet (Vector< String > &namlst, Vector< String > &vallst, const String &nam)
	Remove a keyword from list (False if not in list)

static Bool	genGet (String &val, Vector< String > &namlst, Vector< String > &vallst, const String &nam)
	Get the value of a keyword.

Private Member Functions
AipsrcValue< Bool > &	operator= (const AipsrcValue< Bool > &other)

	AipsrcValue (const AipsrcValue< Bool > &other)

Private Attributes
Block< Bool >	tlst

Block< String >	ntlst

Static Private Attributes
static AipsrcValue	myp_p

static std::mutex	theirMutex

Additional Inherited Members
Static Protected Member Functions inherited from casacore::Aipsrc
static Bool	find (String &value, const String &keyword, uInt start)
	Actual find function.

static Bool	findNoParse (String &value, const String &keyword, uInt start)
	Actual find function to use during parse() without recursing into parse()

static uInt	registerRC (const String &keyword, Block< String > &nlst)
	The registration function.

static void	save (const String keyword, const String val)
	Actual saving.

Detailed Description

Specialization of AipsrcValue for Bool.

Synopsis

Definition at line 251 of file AipsrcValue.h.

Constructor & Destructor Documentation

◆ AipsrcValue() [1/2]

casacore::AipsrcValue< Bool >::AipsrcValue ( )

◆ ~AipsrcValue()

casacore::AipsrcValue< Bool >::~AipsrcValue ( )

◆ AipsrcValue() [2/2]

casacore::AipsrcValue< Bool >::AipsrcValue ( const AipsrcValue< Bool > & other )

private

Member Function Documentation

◆ find() [1/2]

static Bool casacore::AipsrcValue< Bool >::find	(	Bool &	value,
		const String &	keyword
	)

static

◆ find() [2/2]

static Bool casacore::AipsrcValue< Bool >::find	(	Bool &	value,
		const String &	keyword,
		const Bool &	deflt
	)

static

◆ get()

static const Bool & casacore::AipsrcValue< Bool >::get ( uInt keyword )

static

◆ operator=()

AipsrcValue< Bool > & casacore::AipsrcValue< Bool >::operator= ( const AipsrcValue< Bool > & other )

private

◆ registerRC()

static uInt casacore::AipsrcValue< Bool >::registerRC	(	const String &	keyword,
		const Bool &	deflt
	)

static

◆ save()

static void casacore::AipsrcValue< Bool >::save ( uInt keyword )

static

◆ set()

static void casacore::AipsrcValue< Bool >::set	(	uInt	keyword,
		const Bool &	deflt
	)

static

Member Data Documentation

◆ myp_p

AipsrcValue casacore::AipsrcValue< Bool >::myp_p

staticprivate

Definition at line 262 of file AipsrcValue.h.

◆ ntlst

Block<String> casacore::AipsrcValue< Bool >::ntlst

private

Definition at line 265 of file AipsrcValue.h.

◆ theirMutex

std::mutex casacore::AipsrcValue< Bool >::theirMutex

staticprivate

Definition at line 263 of file AipsrcValue.h.

◆ tlst

Block<Bool> casacore::AipsrcValue< Bool >::tlst

private

Definition at line 264 of file AipsrcValue.h.

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

casa/System/AipsrcValue.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Synopsis

Constructor & Destructor Documentation

◆ AipsrcValue() [1/2]

◆ ~AipsrcValue()

◆ AipsrcValue() [2/2]

Member Function Documentation

◆ find() [1/2]

◆ find() [2/2]

◆ get()

◆ operator=()

◆ registerRC()

◆ save()

◆ set()

Member Data Documentation

◆ myp_p

◆ ntlst

◆ theirMutex

◆ tlst