JPARSER::JParserTemplateElement< bool > Class Reference

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

#include <JParser.hh>

Inheritance diagram for JPARSER::JParserTemplateElement< bool >:

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::string &	getName () const
	Get name of parameter. More...
const std::string &	getHelp () 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 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 1263 of file JParser.hh.

Constructor & Destructor Documentation

JParserTemplateElement()

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

object	reference to object
name	name of object
help	help of object

Definition at line 1276 of file JParser.hh.

                                                                                                    : 
      JParserElementInterface(name, help),
      object(object)
    {
      this->object = false;
    }

Member Function Documentation

read()

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

in	input stream

Returns

input stream

Implements JLANG::JStreamInput.

Definition at line 1291 of file JParser.hh.

    {
      this->object = true;
      
      return in;
    }

write()

virtual std::ostream& JPARSER::JParserTemplateElement< bool >::write ( std::ostream &  out ) const

inlineoverridevirtual

Stream output.

Parameters

out	output stream

Returns

output stream

Implements JLANG::JStreamOutput.

Definition at line 1305 of file JParser.hh.

    { 
      return out << object;
    }

getStatus()

virtual bool JPARSER::JParserTemplateElement< bool >::getStatus ( ) const

inlineoverridevirtual

Status of object.

Returns

true

Implements JPARSER::JParserElementInterface.

Definition at line 1316 of file JParser.hh.

    {
      return true;
    }

getInitialisationStatus()

virtual bool JPARSER::JParserTemplateElement< bool >::getInitialisationStatus ( ) const

inlineoverridevirtual

Get initialisation status of parameter.

Returns

true

Implements JPARSER::JParserElementInterface.

Definition at line 1327 of file JParser.hh.

    {
      return true;
    }

setInitialiationStatus()

virtual void JPARSER::JParserTemplateElement< bool >::setInitialiationStatus ( const bool  value )

inlineoverridevirtual

Set initialisation status of parameter.

This implementation doesn't do anything.

Parameters

value

initialisation status

Implements JPARSER::JParserElementInterface.

Definition at line 1339 of file JParser.hh.

    {}

gcount()

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 1348 of file JParser.hh.

    {
      return false;
    }

getName()

const std::string& JPARSER::JParserElementInterface::getName ( ) const

inlineinherited

Get name of parameter.

Returns

name

Definition at line 570 of file JParser.hh.

    { 
      return __name; 
    }

getHelp()

const std::string& JPARSER::JParserElementInterface::getHelp ( ) const

inlineinherited

Get help of parameter.

Returns

help

Definition at line 581 of file JParser.hh.

    { 
      return __help; 
    }

print()

virtual void JPARSER::JParserElementInterface::print ( std::ostream &  out ) const

inlinevirtualinherited

Print.

Parameters

out	output stream

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

Definition at line 616 of file JParser.hh.

    {
      using namespace std;
 
      out << "<" << getName() << ">"; 
 
      if (getStatus() && !getShortprint(out)) {
 
        int width = WIDTH - getName().length();
 
        if (width > 0) {
          out << setw(width) << " ";
        }
 
        out << " = ";
          
        write(out);
      }
 
      if (getLongprint(out) && getHelp() != "") {
        out << " \"" << getHelp() << "\""; 
      }
    }

Member Data Documentation

object

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

private

Definition at line 1355 of file JParser.hh.

__name

std::string JPARSER::JParserElementInterface::__name

protectedinherited

Definition at line 653 of file JParser.hh.

__help

std::string JPARSER::JParserElementInterface::__help

protectedinherited

Definition at line 654 of file JParser.hh.

---

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

• JParser.hh