asdm::ASDMParseOptions Class Reference

A class to define a collection of options regarding the way to consider an ASDM dataset especially when it's about to be read on disk, parsed and transformed into its representation in memory. More...

#include <Misc.h>

Public Member Functions
	ASDMParseOptions ()
	A null constructor. More...
	ASDMParseOptions (const ASDMParseOptions &x)
	A copy constructor. More...
virtual	~ASDMParseOptions ()
	The destructor. More...
ASDMParseOptions &	operator= (const ASDMParseOptions &rhs)
	= operator. More...
ASDMParseOptions &	asALMA ()
	This is an ALMA dataset. More...
ASDMParseOptions &	asIRAM_PDB ()
	This is an IRAM / Plateau de Bure dataset. More...
ASDMParseOptions &	asEVLA ()
	This is an EVLA dataset. More...
ASDMParseOptions &	asV2 ()
	This is a V2 dataset. More...
ASDMParseOptions &	asV3 ()
	This is a V3 dataset. More...
ASDMParseOptions &	loadTablesOnDemand (bool b)
	Load all the tables in memory or only those which are required by the code. More...
ASDMParseOptions &	checkRowUniqueness (bool b)
	Determines if a control of the uniqueness is performed (b==true) or not (b==false) for each row of each table converted and loaded into memory. More...
std::string	toString () const

Private Attributes
ASDMUtils::Origin	origin_
bool	detectOrigin_
std::string	version_
bool	detectVersion_
bool	loadTablesOnDemand_
bool	checkRowUniqueness_

Friends
class	ASDM
std::ostream &	operator<< (std::ostream &output, const ASDMParseOptions &p)
	Defines how an instance of ASDMParseOptions is output on an ostream. More...

Detailed Description

A class to define a collection of options regarding the way to consider an ASDM dataset especially when it's about to be read on disk, parsed and transformed into its representation in memory.

The options that can be set with instances of this class are :

• The origin of the dataset , i.e. the location where it's been produced. Currently three locations are known : ALMA, EVLA and IRAM at its Plateau de Bure.
• The version of the dataset. At present time version 2 or version 3 are known.
• The fact that all the tables of a dataset are expected to be present in memory or only those which are referenced by the code which needs to acces them

The method setFromFile defined in the class ASDM is the principal (not to say only) user of instances of this class.

It should be noticed that all the methods defined to set the options return a reference onto the instance of ASDMParseOptions they are applied. This technique facilitates the definition of a collection of options in one single statement, e.g. :

ASDMParseOptions parse; parse.asALMA().asV2().loadTablesOnDemand(true);

Definition at line 303 of file Misc.h.

Constructor & Destructor Documentation

asdm::ASDMParseOptions::ASDMParseOptions

(

)

A null constructor.

The instance built by this constructor defines the instances as follows :

• The origin is UNKNOWN.
• The version is UNKNOWN.
• All the tables are to be loaded in memory.

asdm::ASDMParseOptions::ASDMParseOptions

(

const ASDMParseOptions &

x

)

A copy constructor.

virtual asdm::ASDMParseOptions::~ASDMParseOptions ( )

virtual

The destructor.

Does nothing special.

Member Function Documentation

ASDMParseOptions& asdm::ASDMParseOptions::asALMA

(

)

This is an ALMA dataset.

ASDMParseOptions& asdm::ASDMParseOptions::asEVLA

(

)

This is an EVLA dataset.

ASDMParseOptions& asdm::ASDMParseOptions::asIRAM_PDB

(

)

This is an IRAM / Plateau de Bure dataset.

ASDMParseOptions& asdm::ASDMParseOptions::asV2

(

)

This is a V2 dataset.

ASDMParseOptions& asdm::ASDMParseOptions::asV3

(

)

This is a V3 dataset.

ASDMParseOptions& asdm::ASDMParseOptions::checkRowUniqueness

(

bool

b

)

Determines if a control of the uniqueness is performed (b==true) or not (b==false) for each row of each table converted and loaded into memory.

Parameters

bool

b

ASDMParseOptions& asdm::ASDMParseOptions::loadTablesOnDemand

(

bool

b

)

Load all the tables in memory or only those which are required by the code.

Parameters

b	a boolean value. true <-> load only the table which are required by the code when they are referred, false <-> load all the code.

ASDMParseOptions& asdm::ASDMParseOptions::operator=

(

const ASDMParseOptions &

rhs

)

= operator.

std::string asdm::ASDMParseOptions::toString

(

)

const

Friends And Related Function Documentation

friend class ASDM

friend

Definition at line 304 of file Misc.h.

std::ostream& operator<< ( std::ostream &  output, const ASDMParseOptions &  p  )

friend

Defines how an instance of ASDMParseOptions is output on an ostream.

Member Data Documentation

bool asdm::ASDMParseOptions::checkRowUniqueness_

private

Definition at line 391 of file Misc.h.

bool asdm::ASDMParseOptions::detectOrigin_

private

Definition at line 387 of file Misc.h.

bool asdm::ASDMParseOptions::detectVersion_

private

Definition at line 389 of file Misc.h.

bool asdm::ASDMParseOptions::loadTablesOnDemand_

private

Definition at line 390 of file Misc.h.

ASDMUtils::Origin asdm::ASDMParseOptions::origin_

private

Definition at line 386 of file Misc.h.

std::string asdm::ASDMParseOptions::version_

private

Definition at line 388 of file Misc.h.

---

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

• casa/code/alma/ASDM/Misc.h