Jpp 21.0.0-rc.3
the software that should make you happy
Loading...
Searching...
No Matches
JCOMPAREHISTOGRAMS::JTestSummary::JTestSummaryHelper Class Reference

Auxiliary class for I/O of test result message. More...

Inheritance diagram for JCOMPAREHISTOGRAMS::JTestSummary::JTestSummaryHelper:
JEEP::JProperties std::map< std::string, JPropertiesElement > JLANG::JEquationParameters JEEP::JMessage< JProperties >

Public Types

typedef std::map< std::string, JPropertiesElement > JMap_t
 

Public Member Functions

template<class JTestSummary_t >
 JTestSummaryHelper (JTestSummary_t &object, const JEquationParameters &equation)
 Constructor.
 
template<class T >
void put (const std::string &key, T &object)
 Put object at given key.
 
JPropertiesjoin (const JProperties &properties)
 Join properties objects.
 
JEquationParametersjoin (const JEquationParameters &value)
 Join equation parameters.
 
bool read (const JEquation &equation)
 Read equation.
 
bool read (const std::string &buffer)
 Read from input string.
 
std::istream & read (std::istream &in)
 Read from input stream.
 
std::istream & read (std::istream &in, const std::string &format)
 Read from input stream according given format.
 
template<class T >
std::istream & read (std::istream &in, T __begin, T __end)
 Read from input stream according given format.
 
std::ostream & write (std::ostream &out) const
 Write the current parameter values.
 
std::ostream & write (std::ostream &out, const std::string &format) const
 Write to output stream according given format.
 
template<class T >
std::ostream & write (std::ostream &out, T __begin, T __end) const
 Write to output stream according given format.
 
std::string sed (const std::string &format, const std::string &prefix="", const std::string &postfix="")
 Stream editing of input format.
 
template<class T >
const T & getValue (const std::string &key) const
 Get value.
 
template<class T >
T & getValue (const std::string &key)
 Get value.
 
template<class T >
void setValue (const std::string &key, const T &value)
 Set value.
 
std::string getString (const std::string &key) const
 Get string value.
 
std::ostream & print (std::ostream &out) const
 Print the current parameter values.
 
const JEquationParametersgetEquationParameters () 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_typegetEndOfLine () const
 Get end of line characters.
 
string_typegetEndOfLine ()
 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_typegetWhiteSpace () const
 Get white space characters.
 
string_typegetWhiteSpace ()
 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.
 
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.
 

Static Public Member Functions

static std::string getKey (const std::string &buffer, const std::string &sep)
 Utility method to strip off all leading characters from a string until specified character(s).
 

Static Public Attributes

static int debug
 debug level (default is off).
 

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

Auxiliary class for I/O of test result message.

Definition at line 186 of file JTestSummary.hh.

Member Typedef Documentation

◆ JMap_t

std::map<std::string, JPropertiesElement> JEEP::JProperties::JMap_t
inherited

Definition at line 504 of file JProperties.hh.

Constructor & Destructor Documentation

◆ JTestSummaryHelper()

template<class JTestSummary_t >
JCOMPAREHISTOGRAMS::JTestSummary::JTestSummaryHelper::JTestSummaryHelper ( JTestSummary_t & object,
const JEquationParameters & equation )
inline

Constructor.

Parameters
objecttest result message
equationequation parameters

Definition at line 197 of file JTestSummary.hh.

198 :
199 JProperties(equation, 1)
200 {
201 insert(gmake_property(object.testName));
202 insert(gmake_property(object.histogramA));
203 insert(gmake_property(object.histogramB));
204 insert(gmake_property(object.parameterName));
205 insert(gmake_property(object.parameterValue));
206 insert(gmake_property(object.parameterThreshold));
207 insert(gmake_property(object.passed_h));
208 }
#define gmake_property(A)
macros to convert (template) parameter to JPropertiesElement object
Utility class to parse parameter values.

Member Function Documentation

◆ getKey()

static std::string JEEP::JProperties::getKey ( const std::string & buffer,
const std::string & sep )
inlinestaticinherited

Utility method to strip off all leading characters from a string until specified character(s).

Parameters
bufferinput string
seplast character(s) to strip
Returns
modified string

Definition at line 516 of file JProperties.hh.

517 {
518 using namespace std;
519
520 const size_type pos = buffer.find_last_of(sep);
521
522 if (pos != string::npos)
523 return buffer.substr(pos + 1);
524 else
525 return buffer;
526 }

◆ put()

template<class T >
void JEEP::JProperties::put ( const std::string & key,
T & object )
inlineinherited

Put object at given key.

Parameters
keykey
objectobject

Definition at line 564 of file JProperties.hh.

565 {
566 this->insert(value_type(key, JPropertiesElement(object)));
567 }

◆ join() [1/2]

JProperties & JEEP::JProperties::join ( const JProperties & properties)
inlineinherited

Join properties objects.

Parameters
propertiesproperties
Returns
properties

Definition at line 576 of file JProperties.hh.

577 {
578 JEquationParameters::join(properties);
579
580 insert(properties.begin(), properties.end());
581
582 return *this;
583 }
JEquationParameters & join(const JEquationParameters &value)
Join equation parameters.

◆ join() [2/2]

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

Join equation parameters.

Parameters
valueequation parameters

Definition at line 514 of file JEquationParameters.hh.

515 {
516 using namespace std;
517
518 for (string::const_iterator i = value.sep.begin(); i != value.sep.end(); ++i) {
519 if (!isSeparator(*i)) {
520 sep += *i;
521 }
522 }
523
524 for (string::const_iterator i = value.eol.begin(); i != value.eol.end(); ++i) {
525 if (!isEndOfLine(*i)) {
526 eol += *i;
527 }
528 }
529
530 for (string::const_iterator i = value.div.begin(); i != value.div.end(); ++i) {
531 if (!isDivision(*i)) {
532 div += *i;
533 }
534 }
535
536 for (string::const_iterator i = value.skip.begin(); i != value.skip.end(); ++i) {
537 if (!isSkipLine(*i)) {
538 skip += *i;
539 }
540 }
541
542 for (string::const_iterator i = value.ws.begin(); i != value.ws.end(); ++i) {
543 if (!isWhiteSpace(*i)) {
544 ws += *i;
545 }
546 }
547
548 return *this;
549 }
bool isSeparator(const char c) const
Test for separator character.
bool isDivision(const char c) const
Test for division character.
bool isEndOfLine(const char c) const
Test for end of line character.
bool isSkipLine(const char c) const
Test for skip line character.
bool isWhiteSpace(const char c) const
Test for white space character.

◆ read() [1/5]

bool JEEP::JProperties::read ( const JEquation & equation)
inlineinherited

Read equation.

Parameters
equationequation
Returns
status

Definition at line 592 of file JProperties.hh.

593 {
594 using namespace std;
595
596 iterator p = find(equation.getKey());
597
598 DEBUG("Processing key: " << equation.getKey() << ' ' << (p != end()) << endl);
599
600 if (p != end()) {
601
602 istringstream is(equation.getValue());
603
604 if (isDivision(equation.getSeparator())) {
605
606 if (p->second->is_properties()) {
607
608 p->second->read(is);
609
610 } else {
611
612 ERROR("JProperties::read(): no properties object after division <" << equation.getKey() << ">" << endl);
613 }
614
615 } else if (isSeparator(equation.getSeparator())) {
616
617 try {
618 p->second->read(is);
619 }
620 catch(const exception& error) {
621 ERROR("JProperties::read(): read error at key <" << equation.getKey() << "> " << error.what() << endl);
622 }
623
624 } else {
625
626 ERROR("JProperties::read(): illegal character following key <" << equation.getKey() << "> " << equation.getSeparator() << endl);
627 }
628
629 if (p->second.getEndMarker()) {
630 return false;
631 }
632
633 if (fail(is)) {
634
635 ERROR("JProperties::read(): error reading data for key <" << equation.getKey() << "> " << equation.getValue() << endl);
636 }
637
638 } else {
639
640 WARNING("JProperties::read(): unknown key <" << equation.getKey() << ">" << endl);
641 }
642
643 return true;
644 }
#define DEBUG(A)
Message macros.
Definition JMessage.hh:62
#define ERROR(A)
Definition JMessage.hh:66
#define WARNING(A)
Definition JMessage.hh:65
bool fail(std::istream &in)
Check for stream state.

◆ read() [2/5]

bool JEEP::JProperties::read ( const std::string & buffer)
inlineinherited

Read from input string.

Parameters
bufferinput string
Returns
read status

Definition at line 653 of file JProperties.hh.

654 {
655 std::istringstream in(buffer);
656
657 return !fail(read(in));
658 }
bool read(const JEquation &equation)
Read equation.

◆ read() [3/5]

std::istream & JEEP::JProperties::read ( std::istream & in)
inlineinherited

Read from input stream.

The input format is:

   [<key><sub>]<key><sep><value><eol>
   [<key><sub>]<key><sep><value><eol>

In this, white spaces are ignored. The reading of key and value pairs is controlled by the JLANG::JEquationFacet class.

Parameters
ininput stream
Returns
input stream

Definition at line 675 of file JProperties.hh.

676 {
677 using namespace std;
678 using namespace JPP;
679
680 JStringStream is(in);
681
682 if (getFileStatus(is.str().c_str())) {
683 is.load();
684 }
685
686 is.imbue(locale(is.getloc(), new JEquationFacet(*this)));
687
688 for (JEquation equation; is >> equation && read(equation); ) {}
689
690 return in;
691 }
Facet class to specify parsing of equations in currect locale (see class JLANG::JEquation).
General purpose equation class.
Definition JEquation.hh:47
Wrapper class around STL stringstream class to facilitate optional loading of data from file.
This name space includes all other name spaces (except KM3NETDAQ, KM3NET and ANTARES).

◆ read() [4/5]

std::istream & JEEP::JProperties::read ( std::istream & in,
const std::string & format )
inlineinherited

Read from input stream according given format.

For each key in the format specification, a corresponding value will be read from the input stream.

Parameters
ininput stream
formatformat
Returns
input stream

Definition at line 704 of file JProperties.hh.

705 {
706 using namespace std;
707
708 istringstream is(format);
709
710 vector<string> buffer;
711
712 for (string key; is >> key; ) {
713 buffer.push_back(key);
714 }
715
716 return read(in, buffer.begin(), buffer.end());
717 }

◆ read() [5/5]

template<class T >
std::istream & JEEP::JProperties::read ( std::istream & in,
T __begin,
T __end )
inlineinherited

Read from input stream according given format.

For each key in the format specification, a corresponding value will be read from the input stream.

Parameters
ininput stream
__beginbegin of format
__endend of format
Returns
input stream

Definition at line 732 of file JProperties.hh.

733 {
734 using namespace std;
735
736 for (T i = __begin; i != __end; ++i) {
737
738 iterator p = find(*i);
739
740 if (p != end()) {
741
742 p->second->read(in);
743
744 } else {
745
746 WARNING("JProperties::read(): unknown key <" << *i << ">" << endl);
747 }
748 }
749
750 return in;
751 }

◆ write() [1/3]

std::ostream & JEEP::JProperties::write ( std::ostream & out) const
inlineinherited

Write the current parameter values.

The output format is

[<key><sub>]<key><sep><value><eol> [<key><sub>]<key><sep><value><eol>

in this, white spaces are omitted.

Parameters
outoutput stream
Returns
output stream

Definition at line 767 of file JProperties.hh.

768 {
769 using namespace std;
770
771 for (const_iterator i = begin(); i != end(); ++i) {
772
773 char c = ' ';
774
775 if (i->second->is_properties()) {
776 c = getDefaultDivision ();
777 } else {
779 }
780
781 i->second->write(out, (i->first + c).c_str(), getDefaultEndOfLine());
782 }
783
784 out << flush;
785
786 return out;
787 }
const char getDefaultSeparator() const
Get default separator character.
const char getDefaultEndOfLine() const
Get default end of line character.
const char getDefaultDivision() const
Get default division character.

◆ write() [2/3]

std::ostream & JEEP::JProperties::write ( std::ostream & out,
const std::string & format ) const
inlineinherited

Write to output stream according given format.

For each key in the format specification, a corresponding value will be written to the output stream.

Parameters
outoutput stream
formatformat
Returns
output stream

Definition at line 800 of file JProperties.hh.

801 {
802 using namespace std;
803
804 istringstream is(format);
805
806 vector<string> buffer;
807
808 for (string key; is >> key; ) {
809 buffer.push_back(key);
810 }
811
812 return write(out, buffer.begin(), buffer.end());
813 }
std::ostream & write(std::ostream &out) const
Write the current parameter values.

◆ write() [3/3]

template<class T >
std::ostream & JEEP::JProperties::write ( std::ostream & out,
T __begin,
T __end ) const
inlineinherited

Write to output stream according given format.

For each key in the format specification, a corresponding value will be written to the output stream.

Parameters
outoutput stream
__beginbegin of format
__endend of format
Returns
output stream

Definition at line 828 of file JProperties.hh.

829 {
830 using namespace std;
831
832 for (T i = __begin; i != __end; ++i) {
833
834 const_iterator p = find(*i);
835
836 if (p != end()) {
837
838 out << getDefaultWhiteSpace();
839
840 p->second->write(out);
841
842 } else {
843
844 WARNING("JProperties::write(): unknown key <" << *i << ">" << endl);
845 }
846 }
847
848 return out;
849 }
const char getDefaultWhiteSpace() const
Get default white space character.

◆ sed()

std::string JEEP::JProperties::sed ( const std::string & format,
const std::string & prefix = "",
const std::string & postfix = "" )
inlineinherited

Stream editing of input format.

For each key in the format specification, a corresponding value will be written to the output stream.

Parameters
formatformat
prefixprefix key word
postfixpostfix key word
Returns
output stream

Definition at line 863 of file JProperties.hh.

866 {
867 using namespace std;
868
869 string buffer = format;
870
871 for (iterator i = begin(); i != end(); ++i) {
872
873 string::size_type ipos = 0;
874
875 while ((ipos = buffer.find(prefix + i->first + postfix, ipos)) != string::npos) {
876
877 ostringstream out;
878
879 i->second->write(out);
880
881 buffer.replace(ipos, prefix.length() + i->first.length() + postfix.length(), out.str());
882 }
883 }
884
885 return buffer;
886 }

◆ getValue() [1/2]

template<class T >
const T & JEEP::JProperties::getValue ( const std::string & key) const
inlineinherited

Get value.

Parameters
keykey
Returns
value of this JPropertiesElement

Definition at line 896 of file JProperties.hh.

897 {
898 const_iterator i = find(key);
899
900 if (i != end())
901 return i->second.getValue<T>();
902 else
903 THROW(JPropertiesException, "Key <" << key << "> not found at JPropertiesElement::getValue()");
904 }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.

◆ getValue() [2/2]

template<class T >
T & JEEP::JProperties::getValue ( const std::string & key)
inlineinherited

Get value.

Parameters
keykey
Returns
value of this JPropertiesElement

Definition at line 914 of file JProperties.hh.

915 {
916 iterator i = find(key);
917
918 if (i != end())
919 return i->second.getValue<T>();
920 else
921 THROW(JPropertiesException, "Key <" << key << "> not found at JPropertiesElement::getValue()");
922 }

◆ setValue()

template<class T >
void JEEP::JProperties::setValue ( const std::string & key,
const T & value )
inlineinherited

Set value.

Parameters
keykey
valuevalue

Definition at line 932 of file JProperties.hh.

933 {
934 iterator i = find(key);
935
936 if (i != end())
937 return i->second.setValue<T>(value);
938 else
939 THROW(JPropertiesException, "Key <" << key << "> not found at JPropertiesElement::setValue()");
940 }

◆ getString()

std::string JEEP::JProperties::getString ( const std::string & key) const
inlineinherited

Get string value.

Parameters
keykey
Returns
value

Definition at line 949 of file JProperties.hh.

950 {
951 const_iterator i = find(key);
952
953 if (i != end())
954 return i->second.toString();
955 else
956 THROW(JPropertiesException, "Key <" << key << "> not found at JPropertiesElement::getString()");
957 }

◆ print()

std::ostream & JEEP::JProperties::print ( std::ostream & out) const
inlineinherited

Print the current parameter values.

Parameters
outoutput stream
Returns
output stream

Definition at line 966 of file JProperties.hh.

967 {
968 write(out);
969
970 return out;
971 }

◆ getEquationParameters()

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

Get equation parameters.

Returns
equation parameters

Definition at line 150 of file JEquationParameters.hh.

151 {
152 return *this;
153 }

◆ setEquationParameters()

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

Set equation parameters.

Parameters
bufferequation parameters

Definition at line 161 of file JEquationParameters.hh.

162 {
163 static_cast<JEquationParameters&>(*this) = buffer;
164 }
JEquationParameters()
Default constructor.

◆ getDefaultSeparator()

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

Get default separator character.

Returns
separator between parameter and its value

Definition at line 172 of file JEquationParameters.hh.

173 {
174 if (sep.empty())
175 return '=';
176 else
177 return sep[0];
178 }

◆ getSeparator() [1/2]

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

Get separator characters.

Returns
separator between parameter and its value

Definition at line 186 of file JEquationParameters.hh.

187 {
188 return sep;
189 }

◆ getSeparator() [2/2]

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

Get separator characters.

Returns
separator between parameter and its value

Definition at line 197 of file JEquationParameters.hh.

198 {
199 return sep;
200 }

◆ setSeparator()

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

Set separator character(s).

Parameters
sepseparator between parameter and its value

Definition at line 208 of file JEquationParameters.hh.

209 {
210 this->sep = sep;
211 }

◆ getDefaultEndOfLine()

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

Get default end of line character.

Returns
end of line character

Definition at line 219 of file JEquationParameters.hh.

220 {
221 if (eol.empty())
222 return '\n';
223 else
224 return eol[0];
225 }

◆ getPreferredEndOfLine()

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

Get preferred end of line character.

Parameters
indexindex
Returns
end of line character

Definition at line 234 of file JEquationParameters.hh.

235 {
236 if (eol.empty())
237 return '\n';
238 else if (index < eol.size())
239 return eol[index];
240 else
241 return eol[0];
242 }

◆ getEndOfLine() [1/2]

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

Get end of line characters.

Returns
end of line characters

Definition at line 250 of file JEquationParameters.hh.

251 {
252 return eol;
253 }

◆ getEndOfLine() [2/2]

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

Get end of line characters.

Returns
end of line characters

Definition at line 261 of file JEquationParameters.hh.

262 {
263 return eol;
264 }

◆ setEndOfLine()

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

Set end of line characters.

Parameters
eolend of line character

Definition at line 272 of file JEquationParameters.hh.

273 {
274 this->eol = eol;
275 }

◆ getDefaultDivision()

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

Get default division character.

Returns
division character

Definition at line 283 of file JEquationParameters.hh.

284 {
285 if (div.empty())
286 return '.';
287 else
288 return div[0];
289 }

◆ getDivision() [1/2]

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

Get division characters.

Returns
division characters

Definition at line 297 of file JEquationParameters.hh.

298 {
299 return div;
300 }

◆ getDivision() [2/2]

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

Get division characters.

Returns
division characters

Definition at line 308 of file JEquationParameters.hh.

309 {
310 return div;
311 }

◆ setDivision()

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

Set division characters.

Parameters
divdivision characters

Definition at line 319 of file JEquationParameters.hh.

320 {
321 this->div = div;
322 }

◆ getDefaultSkipLine()

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

Get default skip line character.

Returns
skip line character

Definition at line 330 of file JEquationParameters.hh.

331 {
332 if (skip.empty())
333 return '#';
334 else
335 return skip[0];
336 }

◆ getSkipLine() [1/2]

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

Get skip line characters.

Returns
skip line characters

Definition at line 344 of file JEquationParameters.hh.

345 {
346 return skip;
347 }

◆ getSkipLine() [2/2]

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

Get skip line characters.

Returns
skip line characters

Definition at line 355 of file JEquationParameters.hh.

356 {
357 return skip;
358 }

◆ setSkipLine()

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

Set skip line characters.

Parameters
skipskip line characters

Definition at line 366 of file JEquationParameters.hh.

367 {
368 this->skip = skip;
369 }

◆ setBrackets()

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

Set brackets.

Parameters
leftleft bracket
rightright bracket

Definition at line 378 of file JEquationParameters.hh.

◆ getLeftBracket() [1/2]

char JLANG::JEquationParameters::getLeftBracket ( ) const
inlineinherited

Get left bracket.

Returns
left bracket

Definition at line 390 of file JEquationParameters.hh.

391 {
392 return left;
393 }

◆ getLeftBracket() [2/2]

char & JLANG::JEquationParameters::getLeftBracket ( )
inlineinherited

Get left bracket.

Returns
left bracket

Definition at line 401 of file JEquationParameters.hh.

402 {
403 return left;
404 }

◆ getRightBracket() [1/2]

char JLANG::JEquationParameters::getRightBracket ( ) const
inlineinherited

Get right bracket.

Returns
right bracket

Definition at line 412 of file JEquationParameters.hh.

413 {
414 return right;
415 }

◆ getRightBracket() [2/2]

char & JLANG::JEquationParameters::getRightBracket ( )
inlineinherited

Get right bracket.

Returns
right bracket

Definition at line 423 of file JEquationParameters.hh.

424 {
425 return right;
426 }

◆ getDefaultWhiteSpace()

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

Get default white space character.

Returns
white space character

Definition at line 434 of file JEquationParameters.hh.

435 {
436 if (ws.empty())
437 return ' ';
438 else
439 return ws[0];
440 }

◆ getWhiteSpace() [1/2]

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

Get white space characters.

Returns
white space characters

Definition at line 448 of file JEquationParameters.hh.

449 {
450 return ws;
451 }

◆ getWhiteSpace() [2/2]

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

Get white space characters.

Returns
white space characters

Definition at line 459 of file JEquationParameters.hh.

460 {
461 return ws;
462 }

◆ setWhiteSpace()

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

Set white space characters.

Parameters
wswhite space characters

Definition at line 470 of file JEquationParameters.hh.

471 {
472 this->ws = ws;
473 }

◆ getComment() [1/2]

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

Get comment string.

Returns
comment string

Definition at line 481 of file JEquationParameters.hh.

482 {
483 return comment;
484 }

◆ getComment() [2/2]

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

Get comment string.

Returns
comment string

Definition at line 492 of file JEquationParameters.hh.

493 {
494 return comment;
495 }

◆ setComment()

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

Set comment string.

Parameters
commentcomment string

Definition at line 503 of file JEquationParameters.hh.

504 {
505 this->comment = comment;
506 }

◆ isSeparator()

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

Test for separator character.

Parameters
ccharacter
Returns
true if separator; else false

Definition at line 558 of file JEquationParameters.hh.

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

◆ isEndOfLine()

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

Test for end of line character.

Parameters
ccharacter
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
inlineinherited

Test for division character.

Parameters
ccharacter
Returns
true if division; else false

Definition at line 579 of file JEquationParameters.hh.

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

◆ isSkipLine()

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

Test for skip line character.

Parameters
ccharacter
Returns
true if skip line; else false

Definition at line 591 of file JEquationParameters.hh.

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

◆ isLeftBracket()

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

Test for left bracket character.

Parameters
ccharacter
Returns
true if left bracket; else false

Definition at line 603 of file JEquationParameters.hh.

604 {
605 return c == left;
606 }

◆ isRightBracket()

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

Test for right bracket character.

Parameters
ccharacter
Returns
true if right bracket; else false

Definition at line 615 of file JEquationParameters.hh.

616 {
617 return c == right;
618 }

◆ isWhiteSpace()

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

Test for white space character.

Parameters
ccharacter
Returns
true if white space; else false

Definition at line 627 of file JEquationParameters.hh.

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

Member Data Documentation

◆ sep

std::string JLANG::JEquationParameters::sep
protectedinherited

Definition at line 633 of file JEquationParameters.hh.

◆ eol

string_type JLANG::JEquationParameters::eol
protectedinherited

Definition at line 634 of file JEquationParameters.hh.

◆ div

std::string JLANG::JEquationParameters::div
protectedinherited

Definition at line 635 of file JEquationParameters.hh.

◆ skip

std::string JLANG::JEquationParameters::skip
protectedinherited

Definition at line 636 of file JEquationParameters.hh.

◆ left

char JLANG::JEquationParameters::left
protectedinherited

Definition at line 637 of file JEquationParameters.hh.

◆ right

char JLANG::JEquationParameters::right
protectedinherited

Definition at line 638 of file JEquationParameters.hh.

◆ ws

string_type JLANG::JEquationParameters::ws
protectedinherited

Definition at line 639 of file JEquationParameters.hh.

◆ comment

std::string JLANG::JEquationParameters::comment
protectedinherited

Definition at line 640 of file JEquationParameters.hh.

◆ debug

int JEEP::JMessage< JProperties >::debug
staticinherited

debug level (default is off).

Definition at line 45 of file JMessage.hh.


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