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>

List of all members.

Public Member Functions

 ASDMParseOptions ()
 A null constructor.
 ASDMParseOptions (const ASDMParseOptions &x)
 A copy constructor.
virtual ~ASDMParseOptions ()
 The destructor.
ASDMParseOptionsoperator= (const ASDMParseOptions &rhs)
 = operator.
ASDMParseOptionsasALMA ()
 This is an ALMA dataset.
ASDMParseOptionsasIRAM_PDB ()
 This is an IRAM / Plateau de Bure dataset.
ASDMParseOptionsasEVLA ()
 This is an EVLA dataset.
ASDMParseOptionsasV2 ()
 This is a V2 dataset.
ASDMParseOptionsasV3 ()
 This is a V3 dataset.
ASDMParseOptionsloadTablesOnDemand (bool b)
 Load all the tables in memory or only those which are required by the code.
ASDMParseOptionscheckRowUniqueness (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.
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.

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 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 221 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 222 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

Definition at line 309 of file Misc.h.

Definition at line 305 of file Misc.h.

Definition at line 307 of file Misc.h.

Definition at line 308 of file Misc.h.

Definition at line 304 of file Misc.h.

std::string asdm::ASDMParseOptions::version_ [private]

Definition at line 306 of file Misc.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1