JLANG::JEquationParameters Class Reference

Simple data structure to support I/O of equations (see class JLANG::JEquation). More...

#include <JEquationParameters.hh>

Inheritance diagram for JLANG::JEquationParameters:

Public Member Functions
	JEquationParameters ()
	Default constructor. More...
	JEquationParameters (const std::string &sep, const std::string &eol, const std::string &div, const std::string &skip, const char left= '(', const char right= ')', const std::string &ws=" \t\n\v\f\r", const std::string &comment="")
	Constructor. More...
const JEquationParameters &	getEquationParameters () const
	Get equation parameters. More...
void	setEquationParameters (const JEquationParameters &buffer)
	Set equation parameters. More...
const char	getDefaultSeparator () const
	Get default separator character. More...
const std::string &	getSeparator () const
	Get separator characters. More...
std::string &	getSeparator ()
	Get separator characters. More...
void	setSeparator (const std::string &sep)
	Set separator character(s). More...
const char	getDefaultEndOfLine () const
	Get default end of line character. More...
const char	getPreferredEndOfLine (const unsigned int index) const
	Get preferred end of line character. More...
const std::string &	getEndOfLine () const
	Get end of line characters. More...
std::string &	getEndOfLine ()
	Get end of line characters. More...
void	setEndOfLine (const std::string &eol)
	Set end of line characters. More...
const char	getDefaultDivision () const
	Get default division character. More...
const std::string &	getDivision () const
	Get division characters. More...
std::string &	getDivision ()
	Get division characters. More...
void	setDivision (const std::string &div)
	Set division characters. More...
const char	getDefaultSkipLine () const
	Get default skip line character. More...
const std::string &	getSkipLine () const
	Get skip line characters. More...
std::string &	getSkipLine ()
	Get skip line characters. More...
void	setSkipLine (const std::string &skip)
	Set skip line characters. More...
void	setBrackets (const char left, const char right)
	Set brackets. More...
char	getLeftBracket () const
	Get left bracket. More...
char &	getLeftBracket ()
	Get left bracket. More...
char	getRightBracket () const
	Get right bracket. More...
char &	getRightBracket ()
	Get right bracket. More...
const char	getDefaultWhiteSpace () const
	Get default white space character. More...
const std::string &	getWhiteSpace () const
	Get white space characters. More...
std::string &	getWhiteSpace ()
	Get white space characters. More...
void	setWhiteSpace (const std::string &ws)
	Set white space characters. More...
const std::string &	getComment () const
	Get comment string. More...
std::string &	getComment ()
	Get comment string. More...
void	setComment (const std::string &comment)
	Set comment string. More...
JEquationParameters &	join (const JEquationParameters &value)
	Join equation parameters. More...
bool	isSeparator (const char c) const
	Test for separator character. More...
bool	isEndOfLine (const char c) const
	Test for end of line character. More...
bool	isDivision (const char c) const
	Test for division character. More...
bool	isSkipLine (const char c) const
	Test for skip line character. More...
bool	isLeftBracket (const char c) const
	Test for left bracket character. More...
bool	isRightBracket (const char c) const
	Test for right bracket character. More...
bool	isWhiteSpace (const char c) const
	Test for white space character. More...

Protected Attributes
std::string	sep
std::string	eol
std::string	div
std::string	skip
char	left
char	right
std::string	ws
std::string	comment

Detailed Description

Simple data structure to support I/O of equations (see class JLANG::JEquation).

Definition at line 20 of file JEquationParameters.hh.

Constructor & Destructor Documentation

JLANG::JEquationParameters::JEquationParameters ( )

inline

Default constructor.

Definition at line 25 of file JEquationParameters.hh.

    {
      this->sep     = "=";
      this->eol     = "\n\r;";
      this->div     = "./";
      this->skip    = "#";
      this->left    = '(';
      this->right   = ')';
      this->ws      = " \t\n\v\f\r";
      this->comment = "";
    }

JLANG::JEquationParameters::JEquationParameters ( const std::string &  sep, const std::string &  eol, const std::string &  div, const std::string &  skip, const char  left = '(', const char  right = ')', const std::string &  ws = " \t\n\v\f\r", const std::string &  comment = ""  )

inline

Constructor.

Parameters

sep	separator characters
eol	end of line characters
div	division characters
skip	skip line characters
left	left bracket
right	right bracket
ws	white space characters

Definition at line 49 of file JEquationParameters.hh.

    {
      this->sep     = sep;
      this->eol     = eol;
      this->div     = div;
      this->skip    = skip;
      this->left    = left;
      this->right   = right;
      this->ws      = ws;
      this->comment = comment;
    }

Member Function Documentation

const JEquationParameters& JLANG::JEquationParameters::getEquationParameters ( ) const

inline

Get equation parameters.

Returns

equation parameters

Definition at line 74 of file JEquationParameters.hh.

    {
      return *this;
    }

void JLANG::JEquationParameters::setEquationParameters ( const JEquationParameters &  buffer )

inline

Set equation parameters.

Parameters

buffer

equation parameters

Definition at line 85 of file JEquationParameters.hh.

    {
      static_cast<JEquationParameters&>(*this) = buffer;
    }

const char JLANG::JEquationParameters::getDefaultSeparator ( ) const

inline

Get default separator character.

Returns

separator between parameter and its value

Definition at line 96 of file JEquationParameters.hh.

    { 
      if (sep.empty())
        return '=';
      else
        return sep[0];
    }

const std::string& JLANG::JEquationParameters::getSeparator ( ) const

inline

Get separator characters.

Returns

separator between parameter and its value

Definition at line 110 of file JEquationParameters.hh.

    { 
      return sep;
    }

std::string& JLANG::JEquationParameters::getSeparator ( )

inline

Get separator characters.

Returns

separator between parameter and its value

Definition at line 121 of file JEquationParameters.hh.

    { 
      return sep;
    }

void JLANG::JEquationParameters::setSeparator ( const std::string &  sep )

inline

Set separator character(s).

Parameters

sep	separator between parameter and its value

Definition at line 132 of file JEquationParameters.hh.

    { 
      this->sep = sep; 
    }

const char JLANG::JEquationParameters::getDefaultEndOfLine ( ) const

inline

Get default end of line character.

Returns

end of line character

Definition at line 143 of file JEquationParameters.hh.

    { 
      if (eol.empty())
        return '\n';
      else
        return eol[0];
    }

const char JLANG::JEquationParameters::getPreferredEndOfLine ( const unsigned int  index ) const

inline

Get preferred end of line character.

Parameters

index

index

Returns

end of line character

Definition at line 158 of file JEquationParameters.hh.

    { 
      if      (eol.empty())
        return '\n';
      else if (index < eol.size())
        return eol[index];
      else
        return eol[0];
    }

const std::string& JLANG::JEquationParameters::getEndOfLine ( ) const

inline

Get end of line characters.

Returns

end of line characters

Definition at line 174 of file JEquationParameters.hh.

    { 
      return eol;
    }

std::string& JLANG::JEquationParameters::getEndOfLine ( )

inline

Get end of line characters.

Returns

end of line characters

Definition at line 185 of file JEquationParameters.hh.

    { 
      return eol;
    }

void JLANG::JEquationParameters::setEndOfLine ( const std::string &  eol )

inline

Set end of line characters.

Parameters

eol	end of line character

Definition at line 196 of file JEquationParameters.hh.

    { 
      this->eol = eol;
    }

const char JLANG::JEquationParameters::getDefaultDivision ( ) const

inline

Get default division character.

Returns

division character

Definition at line 207 of file JEquationParameters.hh.

    { 
      if (div.empty())
        return '.';
      else
        return div[0];
    }

const std::string& JLANG::JEquationParameters::getDivision ( ) const

inline

Get division characters.

Returns

division characters

Definition at line 221 of file JEquationParameters.hh.

    { 
      return div;
    }

std::string& JLANG::JEquationParameters::getDivision ( )

inline

Get division characters.

Returns

division characters

Definition at line 232 of file JEquationParameters.hh.

    { 
      return div;
    }

void JLANG::JEquationParameters::setDivision ( const std::string &  div )

inline

Set division characters.

Parameters

div	division characters

Definition at line 243 of file JEquationParameters.hh.

    { 
      this->div = div;
    }

const char JLANG::JEquationParameters::getDefaultSkipLine ( ) const

inline

Get default skip line character.

Returns

skip line character

Definition at line 254 of file JEquationParameters.hh.

    { 
      if (skip.empty())
        return '#';
      else
        return skip[0];
    }

const std::string& JLANG::JEquationParameters::getSkipLine ( ) const

inline

Get skip line characters.

Returns

skip line characters

Definition at line 268 of file JEquationParameters.hh.

    { 
      return skip;
    }

std::string& JLANG::JEquationParameters::getSkipLine ( )

inline

Get skip line characters.

Returns

skip line characters

Definition at line 279 of file JEquationParameters.hh.

    { 
      return skip;
    }

void JLANG::JEquationParameters::setSkipLine ( const std::string &  skip )

inline

Set skip line characters.

Parameters

skip	skip line characters

Definition at line 290 of file JEquationParameters.hh.

    { 
      this->skip = skip;
    }

void JLANG::JEquationParameters::setBrackets ( const char  left, const char  right  )

inline

Set brackets.

Parameters

left	left bracket
right	right bracket

Definition at line 302 of file JEquationParameters.hh.

    {
      this->left  = left;
      this->right = right;
    }

char JLANG::JEquationParameters::getLeftBracket ( ) const

inline

Get left bracket.

Returns

left bracket

Definition at line 314 of file JEquationParameters.hh.

    {
      return left;
    }

char& JLANG::JEquationParameters::getLeftBracket ( )

inline

Get left bracket.

Returns

left bracket

Definition at line 325 of file JEquationParameters.hh.

    {
      return left;
    }

char JLANG::JEquationParameters::getRightBracket ( ) const

inline

Get right bracket.

Returns

right bracket

Definition at line 336 of file JEquationParameters.hh.

    {
      return right;
    }

char& JLANG::JEquationParameters::getRightBracket ( )

inline

Get right bracket.

Returns

right bracket

Definition at line 347 of file JEquationParameters.hh.

    {
      return right;
    }

const char JLANG::JEquationParameters::getDefaultWhiteSpace ( ) const

inline

Get default white space character.

Returns

white space character

Definition at line 358 of file JEquationParameters.hh.

    { 
      if (ws.empty())
        return ' ';
      else
        return ws[0];
    }

const std::string& JLANG::JEquationParameters::getWhiteSpace ( ) const

inline

Get white space characters.

Returns

white space characters

Definition at line 372 of file JEquationParameters.hh.

    { 
      return ws;
    }

std::string& JLANG::JEquationParameters::getWhiteSpace ( )

inline

Get white space characters.

Returns

white space characters

Definition at line 383 of file JEquationParameters.hh.

    { 
      return ws;
    }

void JLANG::JEquationParameters::setWhiteSpace ( const std::string &  ws )

inline

Set white space characters.

Parameters

ws	white space characters

Definition at line 394 of file JEquationParameters.hh.

    { 
      this->ws = ws;
    }

const std::string& JLANG::JEquationParameters::getComment ( ) const

inline

Get comment string.

Returns

comment string

Definition at line 405 of file JEquationParameters.hh.

    { 
      return comment;
    }

std::string& JLANG::JEquationParameters::getComment ( )

inline

Get comment string.

Returns

comment string

Definition at line 416 of file JEquationParameters.hh.

    { 
      return comment;
    }

void JLANG::JEquationParameters::setComment ( const std::string &  comment )

inline

Set comment string.

Parameters

comment

comment string

Definition at line 427 of file JEquationParameters.hh.

    { 
      this->comment = comment;
    }

JEquationParameters& JLANG::JEquationParameters::join ( const JEquationParameters &  value )

inline

Join equation parameters.

Parameters

value

equation parameters

Definition at line 438 of file JEquationParameters.hh.

    { 
      using namespace std;

      for (string::const_iterator i = value.sep.begin(); i != value.sep.end(); ++i) {
        if (!isSeparator(*i)) {
          sep += *i;
        }
      }

      for (string::const_iterator i = value.eol.begin(); i != value.eol.end(); ++i) {
        if (!isEndOfLine(*i)) {
          eol += *i;
        }
      }

      for (string::const_iterator i = value.div.begin(); i != value.div.end(); ++i) {
        if (!isDivision(*i)) {
          div += *i;
        }
      }

      for (string::const_iterator i = value.skip.begin(); i != value.skip.end(); ++i) {
        if (!isSkipLine(*i)) {
          skip += *i;
        }
      }

      for (string::const_iterator i = value.ws.begin(); i != value.ws.end(); ++i) {
        if (!isWhiteSpace(*i)) {
          ws += *i;
        }
      }

      return *this;
    }

bool JLANG::JEquationParameters::isSeparator ( const char  c ) const

inline

Test for separator character.

Parameters

c

character

Returns

true if separator; else false

Definition at line 482 of file JEquationParameters.hh.

    { 
      return sep .find(c) != std::string::npos;
    }

bool JLANG::JEquationParameters::isEndOfLine ( const char  c ) const

inline

Test for end of line character.

Parameters

c

character

Returns

true if end of line; else false

Definition at line 494 of file JEquationParameters.hh.

{ return eol .find(c) != std::string::npos; }

bool JLANG::JEquationParameters::isDivision ( const char  c ) const

inline

Test for division character.

Parameters

c

character

Returns

true if division; else false

Definition at line 503 of file JEquationParameters.hh.

    { 
      return div .find(c) != std::string::npos;
    }

bool JLANG::JEquationParameters::isSkipLine ( const char  c ) const

inline

Test for skip line character.

Parameters

c

character

Returns

true if skip line; else false

Definition at line 515 of file JEquationParameters.hh.

    { 
      return skip.find(c) != std::string::npos;
    }

bool JLANG::JEquationParameters::isLeftBracket ( const char  c ) const

inline

Test for left bracket character.

Parameters

c

character

Returns

true if left bracket; else false

Definition at line 527 of file JEquationParameters.hh.

    { 
      return c == left;
    }

bool JLANG::JEquationParameters::isRightBracket ( const char  c ) const

inline

Test for right bracket character.

Parameters

c

character

Returns

true if right bracket; else false

Definition at line 539 of file JEquationParameters.hh.

    { 
      return c == right;
    }

bool JLANG::JEquationParameters::isWhiteSpace ( const char  c ) const

inline

Test for white space character.

Parameters

c

character

Returns

true if white space; else false

Definition at line 551 of file JEquationParameters.hh.

    { 
      return ws  .find(c) != std::string::npos;
    }

Member Data Documentation

std::string JLANG::JEquationParameters::sep

protected

Definition at line 557 of file JEquationParameters.hh.

std::string JLANG::JEquationParameters::eol

protected

Definition at line 558 of file JEquationParameters.hh.

std::string JLANG::JEquationParameters::div

protected

Definition at line 559 of file JEquationParameters.hh.

std::string JLANG::JEquationParameters::skip

protected

Definition at line 560 of file JEquationParameters.hh.

char JLANG::JEquationParameters::left

protected

Definition at line 561 of file JEquationParameters.hh.

char JLANG::JEquationParameters::right

protected

Definition at line 562 of file JEquationParameters.hh.

std::string JLANG::JEquationParameters::ws

protected

Definition at line 563 of file JEquationParameters.hh.

std::string JLANG::JEquationParameters::comment

protected

Definition at line 564 of file JEquationParameters.hh.

---

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

• JEquationParameters.hh