CommonEnviromentParser Class Reference
[C++/Common/Enviroment]

This class is the interface to the parser for the CommonEnviroment class. More...

#include <CommonEnviromentParser.h>

Inheritance diagram for CommonEnviromentParser:

Inheritance graph
[legend]
Collaboration diagram for CommonEnviromentParser:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 CommonEnviromentParser (const std::string &file)
 Ctor.
 ~CommonEnviromentParser ()
 Dtor.
bool Parse ()
 Perform the parse.
const std::string & DatasetBase () const
 Give the value of the base of the current dataset.
int DefaultThreeDXSize () const
 Give the value of the three dimensional panels default x size.
int DefaultThreeDYSize () const
 Give the value of the three dimensional panels default x size.
const std::string & InstrumentType () const
 Give the value of the Instrument Type name.
int DefaultPingsPerSwath () const
 Give the number of pings per swath.
int DefaultSwathsToFilter () const
 Give the number of swaths to filter.

Protected Member Functions

bool Find (const std::string &lvalue)
 Test for the existance of a variable.
int Type (const std::string &lvalue)
 Test the type of a variable.
double Nargument (const std::string &lvalue)
 Give the numeric argument of a variable.
std::string Aargument (const std::string &lvalue)
 Give the alpha argument of a variable.

Detailed Description

This class is the interface to the parser for the CommonEnviroment class.

Definition at line 17 of file C++/Common/Enviroment/CommonEnviromentParser.h.


Constructor & Destructor Documentation

CommonEnviromentParser::CommonEnviromentParser ( const std::string &  file  ) 

Ctor.

Parameters:
file The FQPN of the input file.

CommonEnviromentParser::~CommonEnviromentParser (  ) 

Dtor.


Member Function Documentation

bool CommonEnviromentParser::Parse (  )  [virtual]

Perform the parse.

Returns:
If the parse proceeded without errors return true.

Reimplemented from FileParser.

const std::string& CommonEnviromentParser::DatasetBase (  )  const

Give the value of the base of the current dataset.

Returns:
The argument of the DatasetBase enviroment variable.

int CommonEnviromentParser::DefaultThreeDXSize (  )  const

Give the value of the three dimensional panels default x size.

Returns:
X sixe in pixels.

int CommonEnviromentParser::DefaultThreeDYSize (  )  const

Give the value of the three dimensional panels default x size.

Returns:
Y size in pixels.

const std::string& CommonEnviromentParser::InstrumentType (  )  const

Give the value of the Instrument Type name.

Returns:
The Instrument Type.

int CommonEnviromentParser::DefaultPingsPerSwath (  )  const

Give the number of pings per swath.

Returns:
The pings per swath.

int CommonEnviromentParser::DefaultSwathsToFilter (  )  const

Give the number of swaths to filter.

Returns:
The number of swaths to filter.

bool CommonEnviromentParser::Find ( const std::string &  lvalue  )  [protected]

Test for the existance of a variable.

Parameters:
lvalue The name of the variable.
Returns:
If the variable exists return true.

int CommonEnviromentParser::Type ( const std::string &  lvalue  )  [protected]

Test the type of a variable.

This function assumes that the variable does exist.

Parameters:
lvalue Te name of the variable.
Returns:
The type of the variable argument. See CommonEnviromentParseElement.h for the definition of the types.

double CommonEnviromentParser::Nargument ( const std::string &  lvalue  )  [protected]

Give the numeric argument of a variable.

This function assumes that the variable does exist.

Parameters:
lvalue The name of the variable.
Returns:
The arguement.

std::string CommonEnviromentParser::Aargument ( const std::string &  lvalue  )  [protected]

Give the alpha argument of a variable.

This function assumes that the variable does exist.

Parameters:
lvalue The name of the variable.
Returns:
The arguement.


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