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

#include <JEquationParameters.hh>

Inheritance diagram for JLANG::JEquationParameters:

Classes
struct	string_type
	Auxiliary data structure to handle I/O of escape characters. More...

Public Member Functions
	JEquationParameters ()
	Default constructor.

	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.

const JEquationParameters &	getEquationParameters () const
	Get equation parameters.

void	setEquationParameters (const JEquationParameters &buffer)
	Set equation parameters.

const char	getDefaultSeparator () const
	Get default separator character.

const std::string &	getSeparator () const
	Get separator characters.

std::string &	getSeparator ()
	Get separator characters.

void	setSeparator (const std::string &sep)
	Set separator character(s).

const char	getDefaultEndOfLine () const
	Get default end of line character.

const char	getPreferredEndOfLine (const unsigned int index) const
	Get preferred end of line character.

const string_type &	getEndOfLine () const
	Get end of line characters.

string_type &	getEndOfLine ()
	Get end of line characters.

void	setEndOfLine (const std::string &eol)
	Set end of line characters.

const char	getDefaultDivision () const
	Get default division character.

const std::string &	getDivision () const
	Get division characters.

std::string &	getDivision ()
	Get division characters.

void	setDivision (const std::string &div)
	Set division characters.

const char	getDefaultSkipLine () const
	Get default skip line character.

const std::string &	getSkipLine () const
	Get skip line characters.

std::string &	getSkipLine ()
	Get skip line characters.

void	setSkipLine (const std::string &skip)
	Set skip line characters.

void	setBrackets (const char left, const char right)
	Set brackets.

char	getLeftBracket () const
	Get left bracket.

char &	getLeftBracket ()
	Get left bracket.

char	getRightBracket () const
	Get right bracket.

char &	getRightBracket ()
	Get right bracket.

const char	getDefaultWhiteSpace () const
	Get default white space character.

const string_type &	getWhiteSpace () const
	Get white space characters.

string_type &	getWhiteSpace ()
	Get white space characters.

void	setWhiteSpace (const std::string &ws)
	Set white space characters.

const std::string &	getComment () const
	Get comment string.

std::string &	getComment ()
	Get comment string.

void	setComment (const std::string &comment)
	Set comment string.

JEquationParameters &	join (const JEquationParameters &value)
	Join equation parameters.

bool	isSeparator (const char c) const
	Test for separator character.

bool	isEndOfLine (const char c) const
	Test for end of line character.

bool	isDivision (const char c) const
	Test for division character.

bool	isSkipLine (const char c) const
	Test for skip line character.

bool	isLeftBracket (const char c) const
	Test for left bracket character.

bool	isRightBracket (const char c) const
	Test for right bracket character.

bool	isWhiteSpace (const char c) const
	Test for white space character.

Protected Attributes
std::string	sep

string_type	eol

std::string	div

std::string	skip

char	left

char	right

string_type	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

◆ JEquationParameters() [1/2]

JLANG::JEquationParameters::JEquationParameters ( )

inline

Default constructor.

Definition at line 100 of file JEquationParameters.hh.

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

◆ JEquationParameters() [2/2]

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
comment	inline comment characters

Definition at line 125 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

◆ getEquationParameters()

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

inline

Get equation parameters.

Returns: equation parameters

Definition at line 150 of file JEquationParameters.hh.

    {
      return *this;
    }

◆ setEquationParameters()

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

inline

Set equation parameters.

Parameters

buffer equation parameters

Definition at line 161 of file JEquationParameters.hh.

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

◆ getDefaultSeparator()

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

inline

Get default separator character.

Returns: separator between parameter and its value

Definition at line 172 of file JEquationParameters.hh.

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

◆ getSeparator() [1/2]

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

inline

Get separator characters.

Returns: separator between parameter and its value

Definition at line 186 of file JEquationParameters.hh.

    { 
      return sep;
    }

◆ getSeparator() [2/2]

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

inline

Get separator characters.

Returns: separator between parameter and its value

Definition at line 197 of file JEquationParameters.hh.

    { 
      return sep;
    }

◆ setSeparator()

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

inline

Set separator character(s).

Parameters

sep	separator between parameter and its value

Definition at line 208 of file JEquationParameters.hh.

    { 
      this->sep = sep; 
    }

◆ getDefaultEndOfLine()

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

inline

Get default end of line character.

Returns: end of line character

Definition at line 219 of file JEquationParameters.hh.

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

◆ getPreferredEndOfLine()

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 234 of file JEquationParameters.hh.

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

◆ getEndOfLine() [1/2]

const string_type & JLANG::JEquationParameters::getEndOfLine ( ) const

inline

Get end of line characters.

Returns: end of line characters

Definition at line 250 of file JEquationParameters.hh.

    { 
      return eol;
    }

◆ getEndOfLine() [2/2]

string_type & JLANG::JEquationParameters::getEndOfLine ( )

inline

Get end of line characters.

Returns: end of line characters

Definition at line 261 of file JEquationParameters.hh.

    { 
      return eol;
    }

◆ setEndOfLine()

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

inline

Set end of line characters.

Parameters

eol	end of line character

Definition at line 272 of file JEquationParameters.hh.

    { 
      this->eol = eol;
    }

◆ getDefaultDivision()

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

inline

Get default division character.

Returns: division character

Definition at line 283 of file JEquationParameters.hh.

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

◆ getDivision() [1/2]

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

inline

Get division characters.

Returns: division characters

Definition at line 297 of file JEquationParameters.hh.

    { 
      return div;
    }

◆ getDivision() [2/2]

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

inline

Get division characters.

Returns: division characters

Definition at line 308 of file JEquationParameters.hh.

    { 
      return div;
    }

◆ setDivision()

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

inline

Set division characters.

Parameters

div	division characters

Definition at line 319 of file JEquationParameters.hh.

    { 
      this->div = div;
    }

◆ getDefaultSkipLine()

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

inline

Get default skip line character.

Returns: skip line character

Definition at line 330 of file JEquationParameters.hh.

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

◆ getSkipLine() [1/2]

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

inline

Get skip line characters.

Returns: skip line characters

Definition at line 344 of file JEquationParameters.hh.

    { 
      return skip;
    }

◆ getSkipLine() [2/2]

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

inline

Get skip line characters.

Returns: skip line characters

Definition at line 355 of file JEquationParameters.hh.

    { 
      return skip;
    }

◆ setSkipLine()

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

inline

Set skip line characters.

Parameters

skip	skip line characters

Definition at line 366 of file JEquationParameters.hh.

    { 
      this->skip = skip;
    }

◆ setBrackets()

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

inline

Set brackets.

Parameters

left	left bracket
right	right bracket

Definition at line 378 of file JEquationParameters.hh.

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

◆ getLeftBracket() [1/2]

char JLANG::JEquationParameters::getLeftBracket ( ) const

inline

Get left bracket.

Returns: left bracket

Definition at line 390 of file JEquationParameters.hh.

    {
      return left;
    }

◆ getLeftBracket() [2/2]

char & JLANG::JEquationParameters::getLeftBracket ( )

inline

Get left bracket.

Returns: left bracket

Definition at line 401 of file JEquationParameters.hh.

    {
      return left;
    }

◆ getRightBracket() [1/2]

char JLANG::JEquationParameters::getRightBracket ( ) const

inline

Get right bracket.

Returns: right bracket

Definition at line 412 of file JEquationParameters.hh.

    {
      return right;
    }

◆ getRightBracket() [2/2]

char & JLANG::JEquationParameters::getRightBracket ( )

inline

Get right bracket.

Returns: right bracket

Definition at line 423 of file JEquationParameters.hh.

    {
      return right;
    }

◆ getDefaultWhiteSpace()

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

inline

Get default white space character.

Returns: white space character

Definition at line 434 of file JEquationParameters.hh.

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

◆ getWhiteSpace() [1/2]

const string_type & JLANG::JEquationParameters::getWhiteSpace ( ) const

inline

Get white space characters.

Returns: white space characters

Definition at line 448 of file JEquationParameters.hh.

    { 
      return ws;
    }

◆ getWhiteSpace() [2/2]

string_type & JLANG::JEquationParameters::getWhiteSpace ( )

inline

Get white space characters.

Returns: white space characters

Definition at line 459 of file JEquationParameters.hh.

    { 
      return ws;
    }

◆ setWhiteSpace()

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

inline

Set white space characters.

Parameters

ws	white space characters

Definition at line 470 of file JEquationParameters.hh.

    { 
      this->ws = ws;
    }

◆ getComment() [1/2]

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

inline

Get comment string.

Returns: comment string

Definition at line 481 of file JEquationParameters.hh.

    { 
      return comment;
    }

◆ getComment() [2/2]

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

inline

Get comment string.

Returns: comment string

Definition at line 492 of file JEquationParameters.hh.

    { 
      return comment;
    }

◆ setComment()

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

inline

Set comment string.

Parameters

comment comment string

Definition at line 503 of file JEquationParameters.hh.

    { 
      this->comment = comment;
    }

◆ join()

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

inline

Join equation parameters.

Parameters

value equation parameters

Definition at line 514 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;
    }

◆ isSeparator()

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 558 of file JEquationParameters.hh.

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

◆ isEndOfLine()

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 570 of file JEquationParameters.hh.

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

◆ isDivision()

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 579 of file JEquationParameters.hh.

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

◆ isSkipLine()

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 591 of file JEquationParameters.hh.

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

◆ isLeftBracket()

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 603 of file JEquationParameters.hh.

    { 
      return c == left;
    }

◆ isRightBracket()

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 615 of file JEquationParameters.hh.

    { 
      return c == right;
    }

◆ isWhiteSpace()

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 627 of file JEquationParameters.hh.

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

Member Data Documentation

◆ sep

std::string JLANG::JEquationParameters::sep

protected

Definition at line 633 of file JEquationParameters.hh.

◆ eol

string_type JLANG::JEquationParameters::eol

protected

Definition at line 634 of file JEquationParameters.hh.

◆ div

std::string JLANG::JEquationParameters::div

protected

Definition at line 635 of file JEquationParameters.hh.

◆ skip

std::string JLANG::JEquationParameters::skip

protected

Definition at line 636 of file JEquationParameters.hh.

◆ left

char JLANG::JEquationParameters::left

protected

Definition at line 637 of file JEquationParameters.hh.

◆ right

char JLANG::JEquationParameters::right

protected

Definition at line 638 of file JEquationParameters.hh.

◆ ws

string_type JLANG::JEquationParameters::ws

protected

Definition at line 639 of file JEquationParameters.hh.

◆ comment

std::string JLANG::JEquationParameters::comment

protected

Definition at line 640 of file JEquationParameters.hh.

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

JEquationParameters.hh

Classes

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JEquationParameters() [1/2]

◆ JEquationParameters() [2/2]

Member Function Documentation

◆ getEquationParameters()

◆ setEquationParameters()

◆ getDefaultSeparator()

◆ getSeparator() [1/2]

◆ getSeparator() [2/2]

◆ setSeparator()

◆ getDefaultEndOfLine()

◆ getPreferredEndOfLine()

◆ getEndOfLine() [1/2]

◆ getEndOfLine() [2/2]

◆ setEndOfLine()

◆ getDefaultDivision()

◆ getDivision() [1/2]

◆ getDivision() [2/2]

◆ setDivision()

◆ getDefaultSkipLine()

◆ getSkipLine() [1/2]

◆ getSkipLine() [2/2]

◆ setSkipLine()

◆ setBrackets()

◆ getLeftBracket() [1/2]

◆ getLeftBracket() [2/2]

◆ getRightBracket() [1/2]

◆ getRightBracket() [2/2]

◆ getDefaultWhiteSpace()

◆ getWhiteSpace() [1/2]

◆ getWhiteSpace() [2/2]

◆ setWhiteSpace()

◆ getComment() [1/2]

◆ getComment() [2/2]

◆ setComment()

◆ join()

◆ isSeparator()

◆ isEndOfLine()

◆ isDivision()

◆ isSkipLine()

◆ isLeftBracket()

◆ isRightBracket()

◆ isWhiteSpace()

Member Data Documentation

◆ sep

◆ eol

◆ div

◆ skip

◆ left

◆ right

◆ ws

◆ comment