A IPage is an interface base class for reading and/or writing a page of option in a file. More...

#include <STK_IPage.h>

Inheritance diagram for STK::IPage:

Public Types
typedef std::vector< Option >	ContOption
	Container for the options.

Public Member Functions
	IPage (String const &name, int const &level, bool isOptional)
	Constructor.

	IPage (IPage const &page)
	Copy constructor.

virtual	~IPage ()
	Destructor.

String const &	name () const
	name of the IPage.

bool	isOptional () const
	is this Option optional ?.

ContOption const &	options () const
	get the options of the IPage

String const &	msg_error () const
	name of the IPage.

Option &	option (String const &name)
	bookkeeping function.

Option const &	option (String const &name) const
	bookkeeping function.

Option const &	option (int const &pos) const
	get the ith constant option of the IPage

Option &	option (int const &pos)
	get the ith option of the IPage

Option const &	operator[] (int const &pos) const
	get the ith constant option of the IPage

Option &	operator[] (int const &pos)
	get the ith option of the IPage

void	addOption (Option const &opt)
	add an option to the page

void	addPage (IPage const &page)
	add a sub-page as an option to the page

void	read (istream &is)
	read in options from an input steam stream

void	write (ostream &os) const
	write out options in a stream

virtual bool	validate ()
	validate the page.

virtual IPage *	clone () const

Protected Attributes
bool	isOptional_
	`true` if the Page is optinal, `false` otherwise

ContOption	options_
	array of the options

String	msg_error_
	Contain the last error message.

Private Member Functions
bool	findKeyword (istream &is) const
	process the input stream until the keyword is encountered.

bool	processLine (String const &line)
	process the input line and set the value of the option.

Private Attributes
String	name_
	name of the page of options

int	level_
	level of the Page.

String	keyword_
	keyword of the page of options.

Detailed Description

A IPage is an interface base class for reading and/or writing a page of option in a file.

A page of option have the form

 # My favorites
[Favorites]
computer = fruit
color = vaguely grey
 
  [[softwares]]
  os  = linux    # error else ?
  ide = eclipse

The 'Favorites' page has a 'softwares' subpage. Pages are indicated using the page name in square brackets. Subpage are made by increasing the number of matching square brackets around the page name.

Note that the whitespace are not significants in this example, but as with code indentation visually shows the structure of the information.

Comments can be added using the symbol '#'. All remaining character on the same line are ignored.

Every Page of options of a STK program should derive from the IPage class as in the following example:

class Page2: public IPage
{
  public:
   Page2(): IPage("test2", 1, false)
   {
     options_.push_back(Option("opt1", real_, false));
     options_.push_back(Option("opt2", string_, false));
     options_.push_back(Option("opt3", lreal_, false));
     options_.push_back(Option("opt4", lstring_, true));
     options_.push_back(Option("opt5", lstring_, false));
   }
   Real   const& opt1() const { return options_[0].get(Real()); }
   String const& opt2() const { return options_[1].get(String()); }
   std::list<Real> const& opt3() const
   { return options_[2].get(std::list<Real>()); }
 
 };

Definition at line 93 of file STK_IPage.h.

Member Typedef Documentation

◆ ContOption

typedef std::vector<Option> STK::IPage::ContOption

Container for the options.

Definition at line 97 of file STK_IPage.h.

Constructor & Destructor Documentation

◆ IPage() [1/2]

STK::IPage::IPage	(	String const &	name,
		int const &	level,
		bool	isOptional
	)

Constructor.

The constructor will initialize the name of the page (in upper case), and the keyword usign the form [...[NAME]...] where the number of open/closing bracket are given by the level.

Parameters

name	name of the page
level	level of the page
isOptional	`true` if the page is optional, `false` otherwise

Definition at line 72 of file STK_IPage.cpp.

            : isOptional_(isOptional)
            , name_(name)
            , level_(level)
            , keyword_(name_)
{
  toUpperString(name_);
  toUpperString(keyword_);
  createKeyWord(keyword_, level);
}

References keyword_, name_, and STK::toUpperString().

◆ IPage() [2/2]

STK::IPage::IPage ( IPage const & page )

Copy constructor.

Parameters

page	the page to copy

Definition at line 89 of file STK_IPage.cpp.

{
  name_ = page.name_;
  level_ = page.level_;
  isOptional_ = page.isOptional_;
  keyword_ = page.keyword_;
  options_ = page.options_;
}

References isOptional_, keyword_, level_, name_, and options_.

◆ ~IPage()

STK::IPage::~IPage ( )

virtual

Destructor.

Definition at line 84 of file STK_IPage.cpp.

84{ }

Member Function Documentation

◆ addOption()

void STK::IPage::addOption ( Option const & opt )

inline

add an option to the page

Parameters

opt	the option to add

Definition at line 177 of file STK_IPage.h.

178 { return options_.push_back(opt);}

References options_.

Referenced by addPage().

◆ addPage()

void STK::IPage::addPage ( IPage const & page )

add a sub-page as an option to the page

Parameters

page	the option to add

Definition at line 101 of file STK_IPage.cpp.

{
  // look how many bracket
  page.level_ = level_ +1;
  createKeyWord(page.keyword_, page.level_);
  addOption(Option(page));
}

References addOption(), and level_.

◆ clone()

virtual IPage * STK::IPage::clone ( ) const

inlinevirtual

Returns: a clone of this. Overload this method if you add members

Reimplemented in STK::AdditiveBSplineRegressionPage, and STK::LocalVariancePage.

Definition at line 195 of file STK_IPage.h.

195{ return new IPage(*this); }

STK::IPage::IPage

IPage(String const &name, int const &level, bool isOptional)

Constructor.

Definition STK_IPage.cpp:72

Referenced by STK::Option::setPage().

◆ findKeyword()

bool STK::IPage::findKeyword ( istream & is ) const

private

process the input stream until the keyword is encountered.

Parameters

is	input stream to process

Returns: true if the keyword have been found, false otherwise

Definition at line 228 of file STK_IPage.cpp.

{
  // Reading lines
  String  line;
  // search page
  while (std::getline(is, line))
  {
    // remove comments and space characters before and after
    removeComments(line, CHAR_COMMENT);
    DManager::removeCharBeforeAndAfter(line, CHAR_BLANK);
    DManager::removeCharBeforeAndAfter(line, CHAR_TAB);
    toUpperString(line);
    // check if the the keyword_ is encountered
    if (line == keyword_) return true ;
  }
  // the keyword_ have not been found
  return false;
}

References keyword_, STK::DManager::removeCharBeforeAndAfter(), and STK::toUpperString().

Referenced by read().

◆ isOptional()

bool STK::IPage::isOptional ( ) const

inline

is this Option optional ?.

Returns: true if the Option is optional, false otherwise

Definition at line 124 of file STK_IPage.h.

124{ return isOptional_;}

References isOptional_.

◆ msg_error()

String const & STK::IPage::msg_error ( ) const

inline

name of the IPage.

Returns: the name of the IPage

Definition at line 132 of file STK_IPage.h.

132{ return msg_error_;}

STK::IPage::msg_error_

String msg_error_

Contain the last error message.

Definition STK_IPage.h:204

References msg_error_.

Referenced by STK::Option::read().

◆ name()

String const & STK::IPage::name ( ) const

inline

name of the IPage.

Returns: the name of the IPage

Definition at line 120 of file STK_IPage.h.

120{ return name_;}

References name_.

Referenced by option(), and option().

◆ operator[]() [1/2]

Option & STK::IPage::operator[] ( int const & pos )

inline

get the ith option of the IPage

Parameters

pos	the position of the option we want to get

Returns: the pos-th Option

Definition at line 171 of file STK_IPage.h.

172 { return options_.at(ContOption::size_type(pos));}

References options_.

◆ operator[]() [2/2]

Option const & STK::IPage::operator[] ( int const & pos ) const

inline

get the ith constant option of the IPage

Parameters

pos	the position of the option we want to get

Returns: the pos-th Option

Definition at line 164 of file STK_IPage.h.

165 { return options_.at(ContOption::size_type(pos));}

References options_.

◆ option() [1/4]

Option & STK::IPage::option ( int const & pos )

inline

get the ith option of the IPage

Parameters

pos	the position of the option we want to get

Returns: the pos-th Option

Definition at line 157 of file STK_IPage.h.

158 { return options_.at(ContOption::size_type(pos));}

References options_.

◆ option() [2/4]

Option const & STK::IPage::option ( int const & pos ) const

inline

get the ith constant option of the IPage

Parameters

pos	the position of the option we want to get

Returns: the pos-th Option

Definition at line 150 of file STK_IPage.h.

151 { return options_.at(ContOption::size_type(pos));}

References options_.

◆ option() [3/4]

Option & STK::IPage::option ( String const & name )

bookkeeping function.

Find an Option given its name

Parameters

name	name of the Option to find

Returns: NULL if the variable is not found, the page otherwise

Definition at line 211 of file STK_IPage.cpp.

{
  String Uname = toUpperString(name);
  // read all pages
  for (ContOption::iterator it = options_.begin(); it != options_.end(); it++)
  {
    // read curent page
    if (it->name() == Uname) return *it;
  }
  msg_error_ = _T("In IPage::option(");
  msg_error_ += name;
  msg_error_ +=_T("); Option not found\n");
  STKRUNTIME_ERROR_NO_ARG(Ipage::option, msg_error_);
}

References _T, msg_error_, name(), options_, STKRUNTIME_ERROR_NO_ARG, and STK::toUpperString().

◆ option() [4/4]

Option const & STK::IPage::option ( String const & name ) const

bookkeeping function.

Find an Option given its name

Parameters

name	name of the Option to find

Returns: NULL if the variable is not found, the page otherwise

Definition at line 192 of file STK_IPage.cpp.

{
  String Uname = toUpperString(name);
  // read all pages
  for (ContOption::const_iterator it = options_.begin(); it != options_.end(); it++)
  {
    // read curent page
    if (it->name() == Uname) return *it;
  }
  msg_error_ = _T("In Ipage::Option(");
  msg_error_ += name;
  msg_error_ +=_T(") const; Option not found\n");
  STKRUNTIME_ERROR_NO_ARG(Ipage::option, msg_error_);
}

References _T, msg_error_, name(), options_, STKRUNTIME_ERROR_NO_ARG, and STK::toUpperString().

◆ options()

ContOption const & STK::IPage::options ( ) const

inline

get the options of the IPage

Returns: the container with the options

Definition at line 128 of file STK_IPage.h.

128{ return options_;};

References options_.

◆ processLine()

bool STK::IPage::processLine ( String const & line )

private

process the input line and set the value of the option.

Parameters

line	input string to process

Returns: true if the keyword have been found, false otherwise

Definition at line 251 of file STK_IPage.cpp.

{
  String::size_type pos = line.find_first_of(CHAR_EQUAL);
  // get the option name before '='
  String optName = line.substr(0,pos);
  DManager::removeCharBeforeAndAfter(optName, CHAR_BLANK);
  DManager::removeCharBeforeAndAfter(optName, CHAR_TAB);
  toUpperString(optName);
  // get the option value after character '='
  String optValue = line.substr(pos+1);
  DManager::removeCharBeforeAndAfter(optValue, CHAR_BLANK);
  DManager::removeCharBeforeAndAfter(optValue, CHAR_TAB);
  // iterate among all the options and find the option
  for( ContOption::iterator it = options_.begin(); it != options_.end(); it++)
  {
    // compare the name of the option with those into the page
    if (it->name().compare(optName) == 0)
    {
      it->setValue(optValue);
      return true;
    }
  }
  // the option name is not in the page
  msg_error_ = "ERROR. In " + name_ + ", option: " + optName
             + " is unknown.\n";
  return false;
}

References msg_error_, name_, options_, STK::DManager::removeCharBeforeAndAfter(), and STK::toUpperString().

Referenced by read().

◆ read()

void STK::IPage::read ( istream & is )

read in options from an input steam stream

Parameters

is	input stream

Definition at line 113 of file STK_IPage.cpp.

{
  // find page
  if (!findKeyword(is))
  {
    if ( !isOptional_ ) // throw error message if the page is not optional
    {
      msg_error_ = "Page " + std::string(_T(keyword_.c_str())) + " not found \n";
      STKRUNTIME_ERROR_NO_ARG(IPage::read, msg_error_);
    }
    else return;
  }
  // get current position of the stream as we will need to pass twice
  istream::pos_type pos = is.tellg();
 
  // read standard options for that page until eof or a new option is discovered
  String  line;
  while (std::getline(is, line))
  {
    // remove comments
    removeComments(line, CHAR_COMMENT);
    DManager::removeCharBeforeAndAfter(line, CHAR_BLANK);
    DManager::removeCharBeforeAndAfter(line, CHAR_TAB);
    // nothing to do
    if (line.empty()) continue;
    // we encounter a page name
    if (line.at(0) == CHAR_OPENBRACKET) break;
    // ignore line if it is not an option
    if (line.find_first_of(CHAR_EQUAL) != line.npos)
    {
      if (!processLine(line))
        STKRUNTIME_ERROR_NO_ARG(Ipage::Read, msg_error_);
    }
    else
    {
      msg_error_ = "ERROR. In page " + std::string(_T(name_.c_str()))
                 + ". Incorrect line.\n";
      STKRUNTIME_ERROR_NO_ARG(Ipage::Read, msg_error_);
    }
  }
  // clear states
  is.clear();
  // read sub-option pages
  for( ContOption::iterator it = options_.begin(); it != options_.end(); it++)
  {
    if (it->type() == Option::page_)
    { // set back iostream
      is.seekg(pos);
      // and read the sub-page
      it->read(is);
    }
  }
  // validate reading
  validate();
}

References _T, findKeyword(), isOptional_, keyword_, msg_error_, name_, options_, STK::Option::page_, processLine(), read(), STK::DManager::removeCharBeforeAndAfter(), STKRUNTIME_ERROR_NO_ARG, and validate().

Referenced by read(), and STK::Option::read().

◆ validate()

virtual bool STK::IPage::validate ( )

inlinevirtual

validate the page.

Check if the options are coherent.

Reimplemented in STK::AdditiveBSplineRegressionPage, and STK::LocalVariancePage.

Definition at line 193 of file STK_IPage.h.

193{ return true; }

Referenced by read(), and STK::Option::read().

◆ write()

void STK::IPage::write ( ostream & os ) const

write out options in a stream

Parameters

os	output stream

Definition at line 172 of file STK_IPage.cpp.

{
  // padding
  const int nbWhiteSpace = 2*(level_-1);
  const String padding = String((int)nbWhiteSpace, CHAR_BLANK);
  // write keyword
  os << padding << keyword_ << _T("\n");
  // write options
  for( ContOption::const_iterator it = options_.begin(); it != options_.end(); it++)
  {
    os << padding; it->write(os);
    if (it->type() != Option::page_) os << _T("\n");
  }
  os.flush();
}

References _T, keyword_, level_, options_, and STK::Option::page_.

Referenced by STK::Option::write().

Member Data Documentation

◆ isOptional_

bool STK::IPage::isOptional_

protected

true if the Page is optinal, false otherwise

Definition at line 199 of file STK_IPage.h.

Referenced by IPage(), isOptional(), and read().

◆ keyword_

String STK::IPage::keyword_

mutableprivate

keyword of the page of options.

The keyword is constructed using the level_ and the name_. It is of the form [...[name_]...] where the number of open/closing bracket is given by level_.

Definition at line 218 of file STK_IPage.h.

Referenced by findKeyword(), IPage(), IPage(), read(), and write().

◆ level_

int STK::IPage::level_

mutableprivate

level of the Page.

This is a mutable element as it depends only of its position in the Option file and not of the values.

Definition at line 212 of file STK_IPage.h.

Referenced by addPage(), IPage(), and write().

◆ msg_error_

String STK::IPage::msg_error_

mutableprotected

Contain the last error message.

Definition at line 204 of file STK_IPage.h.

Referenced by msg_error(), option(), option(), processLine(), read(), STK::AdditiveBSplineRegressionPage::validate(), and STK::LocalVariancePage::validate().

◆ name_

String STK::IPage::name_

private

name of the page of options

Definition at line 208 of file STK_IPage.h.

Referenced by IPage(), IPage(), name(), processLine(), and read().

◆ options_

ContOption STK::IPage::options_

protected

array of the options

Definition at line 201 of file STK_IPage.h.

Referenced by STK::AdditiveBSplineRegressionPage::AdditiveBSplineRegressionPage(), addOption(), IPage(), STK::LocalVariancePage::LocalVariancePage(), STK::LocalVariancePage::LocalVariancePage(), operator[](), operator[](), option(), option(), option(), option(), options(), processLine(), read(), STK::AdditiveBSplineRegressionPage::validate(), STK::LocalVariancePage::validate(), and write().

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

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ContOption

Constructor & Destructor Documentation

◆ IPage() [1/2]

◆ IPage() [2/2]

◆ ~IPage()

Member Function Documentation

◆ addOption()

◆ addPage()

◆ clone()

◆ findKeyword()

◆ isOptional()

◆ msg_error()

◆ name()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ option() [1/4]

◆ option() [2/4]

◆ option() [3/4]

◆ option() [4/4]

◆ options()

◆ processLine()

◆ read()

◆ validate()

◆ write()

Member Data Documentation

◆ isOptional_

◆ keyword_

◆ level_

◆ msg_error_

◆ name_

◆ options_