Jpp  18.2.0
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Attributes | Private Attributes | List of all members
JPARSER::JParserTemplateElement< bool > Class Template Reference

Template specialisation of JPARSER::JParserTemplateElement for type bool. More...

#include <JParser.hh>

Inheritance diagram for JPARSER::JParserTemplateElement< bool >:
JPARSER::JParserElementInterface JLANG::JStreamInput JLANG::JStreamOutput

Public Member Functions

 JParserTemplateElement (bool &object, const std::string &name="arg", const std::string &help="")
 Constructor. More...
 
virtual std::istream & read (std::istream &in) override
 Stream input. More...
 
virtual std::ostream & write (std::ostream &out) const override
 Stream output. More...
 
virtual bool getStatus () const override
 Status of object. More...
 
virtual bool getInitialisationStatus () const override
 Get initialisation status of parameter. More...
 
virtual void setInitialiationStatus (const bool value) override
 Set initialisation status of parameter. More...
 
virtual bool gcount () const override
 Read counter. More...
 
const std::stringgetName () const
 Get name of parameter. More...
 
const std::stringgetHelp () const
 Get help of parameter. More...
 
virtual void print (std::ostream &out) const
 Print. More...
 

Protected Attributes

std::string __name
 
std::string __help
 

Private Attributes

bool & object
 

Detailed Description

template<>
class JPARSER::JParserTemplateElement< bool >

Template specialisation of JPARSER::JParserTemplateElement for type bool.

The value is by default set to false and set to true in method read() without reading any data. This makes it possible to parse mutiple options in one go (e.g. -abc). This class implements the JPARSER::JParserElementInterface interface.

Definition at line 1082 of file JParser.hh.

Constructor & Destructor Documentation

JPARSER::JParserTemplateElement< bool >::JParserTemplateElement ( bool &  object,
const std::string name = "arg",
const std::string help = "" 
)
inline

Constructor.

The constructor assigns the default value false to the referenced parameter.

Parameters
objectreference to object
namename of object
helphelp of object

Definition at line 1095 of file JParser.hh.

1095  :
1097  object(object)
1098  {
1099  this->object = false;
1100  }
then echo Enter input within $TIMEOUT_S seconds echo n User name
Definition: JCookie.sh:42
JParserElementInterface(const std::string &name="arg", const std::string &help="")
Constructor.
Definition: JParser.hh:376

Member Function Documentation

virtual std::istream& JPARSER::JParserTemplateElement< bool >::read ( std::istream &  in)
inlineoverridevirtual

Stream input.

This method sets the value to true, without reading any data.

Parameters
ininput stream
Returns
input stream

Implements JLANG::JStreamInput.

Definition at line 1110 of file JParser.hh.

1111  {
1112  this->object = true;
1113 
1114  return in;
1115  }
then fatal Wrong number of arguments fi set_variable DETECTOR $argv[1] set_variable INPUT_FILE $argv[2] eval JPrintDetector a $DETECTOR O IDENTIFIER eval JPrintDetector a $DETECTOR O SUMMARY JAcoustics sh $DETECTOR_ID source JAcousticsToolkit sh CHECK_EXIT_CODE typeset A EMITTERS get_tripods $WORKDIR tripod txt EMITTERS get_transmitters $WORKDIR transmitter txt EMITTERS for EMITTER in
Definition: JCanberra.sh:46
virtual std::ostream& JPARSER::JParserTemplateElement< bool >::write ( std::ostream &  out) const
inlineoverridevirtual

Stream output.

Parameters
outoutput stream
Returns
output stream

Implements JLANG::JStreamOutput.

Definition at line 1124 of file JParser.hh.

1125  {
1126  return out << object;
1127  }
virtual bool JPARSER::JParserTemplateElement< bool >::getStatus ( ) const
inlineoverridevirtual

Status of object.

Returns
true

Implements JPARSER::JParserElementInterface.

Definition at line 1135 of file JParser.hh.

1136  {
1137  return true;
1138  }
virtual bool JPARSER::JParserTemplateElement< bool >::getInitialisationStatus ( ) const
inlineoverridevirtual

Get initialisation status of parameter.

Returns
true

Implements JPARSER::JParserElementInterface.

Definition at line 1146 of file JParser.hh.

1147  {
1148  return true;
1149  }
virtual void JPARSER::JParserTemplateElement< bool >::setInitialiationStatus ( const bool  value)
inlineoverridevirtual

Set initialisation status of parameter.

This implementation doesn't do anything.

Parameters
valueinitialisation status

Implements JPARSER::JParserElementInterface.

Definition at line 1158 of file JParser.hh.

1159  {}
virtual bool JPARSER::JParserTemplateElement< bool >::gcount ( ) const
inlineoverridevirtual

Read counter.

Returns
true if at least one character to be read; else false

Reimplemented from JPARSER::JParserElementInterface.

Definition at line 1167 of file JParser.hh.

1168  {
1169  return false;
1170  }
const std::string& JPARSER::JParserElementInterface::getName ( ) const
inlineinherited

Get name of parameter.

Returns
name

Definition at line 389 of file JParser.hh.

390  {
391  return __name;
392  }
const std::string& JPARSER::JParserElementInterface::getHelp ( ) const
inlineinherited

Get help of parameter.

Returns
help

Definition at line 400 of file JParser.hh.

401  {
402  return __help;
403  }
virtual void JPARSER::JParserElementInterface::print ( std::ostream &  out) const
inlinevirtualinherited

Print.

Parameters
outoutput stream

Reimplemented in JPARSER::JParserTemplateElement< JType_t, true >.

Definition at line 435 of file JParser.hh.

436  {
437  using namespace std;
438 
439  out << "<" << getName() << ">";
440 
441  if (getStatus() && !getShortprint(out)) {
442 
443  int width = WIDTH - getName().length();
444 
445  if (width > 0) {
446  out << setw(width) << " ";
447  }
448 
449  out << " = ";
450 
451  write(out);
452  }
453 
454  if (getLongprint(out) && getHelp() != "") {
455  out << " \"" << getHelp() << "\"";
456  }
457  }
Auxiliary data structure for alignment of data.
Definition: JManip.hh:231
virtual bool getStatus() const =0
Get status of parameter.
const std::string & getName() const
Get name of parameter.
Definition: JParser.hh:389
bool getLongprint(std::ostream &out)
Get long print option.
Definition: JManip.hh:121
virtual std::ostream & write(std::ostream &out) const =0
Stream output.
bool getShortprint(std::ostream &out)
Get short print option.
Definition: JManip.hh:75
const std::string & getHelp() const
Get help of parameter.
Definition: JParser.hh:400

Member Data Documentation

bool& JPARSER::JParserTemplateElement< bool >::object
private

Definition at line 1174 of file JParser.hh.

std::string JPARSER::JParserElementInterface::__name
protectedinherited

Definition at line 472 of file JParser.hh.

std::string JPARSER::JParserElementInterface::__help
protectedinherited

Definition at line 473 of file JParser.hh.


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