JPARSER::JParserElementInterface Class Reference

Interface for I/O of parser element. More...

#include <JParser.hh>

Inheritance diagram for JPARSER::JParserElementInterface:

Public Member Functions
const std::string &	getName () const
	Get name of parameter. More...
const std::string &	getHelp () const
	Get help of parameter. More...
virtual bool	getStatus () const =0
	Get status of parameter. More...
virtual bool	getInitialisationStatus () const =0
	Get initialisation status of parameter. More...
virtual void	setInitialiationStatus (const bool value)=0
	Set initialisation status of parameter. More...
virtual void	print (std::ostream &out) const
	Print. More...
virtual bool	gcount () const
	Read counter. More...
virtual std::istream &	read (std::istream &in)=0
	Stream input. More...
virtual std::ostream &	write (std::ostream &out) const =0
	Stream output. More...

Protected Member Functions
	JParserElementInterface (const std::string &name="arg", const std::string &help="")
	Constructor. More...

Protected Attributes
std::string	__name
std::string	__help

Detailed Description

Interface for I/O of parser element.

Definition at line 546 of file JParser.hh.

Constructor & Destructor Documentation

JParserElementInterface()

JPARSER::JParserElementInterface::JParserElementInterface ( const std::string &  name = "arg", const std::string &  help = ""  )

inlineprotected

Constructor.

Parameters

name	name of object
help	help of object

Definition at line 557 of file JParser.hh.

                                                        :
      __name(name),
      __help(help)
    {}

Member Function Documentation

getName()

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

inline

Get name of parameter.

Returns

name

Definition at line 570 of file JParser.hh.

    { 
      return __name; 
    }

getHelp()

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

inline

Get help of parameter.

Returns

help

Definition at line 581 of file JParser.hh.

    { 
      return __help; 
    }

getStatus()

virtual bool JPARSER::JParserElementInterface::getStatus ( ) const

pure virtual

Get status of parameter.

Returns

status

Implemented in JPARSER::JParserTemplateElement< JCounter >, JPARSER::JParserTemplateElement< bool >, JPARSER::JParserTemplateElement< JType_t, true >, and JPARSER::JParserTemplateElement< JType_t, false >.

getInitialisationStatus()

virtual bool JPARSER::JParserElementInterface::getInitialisationStatus ( ) const

pure virtual

Get initialisation status of parameter.

Returns

status

Implemented in JPARSER::JParserTemplateElement< JCounter >, JPARSER::JParserTemplateElement< bool >, and JPARSER::JParserTemplateElement< JType_t, false >.

setInitialiationStatus()

virtual void JPARSER::JParserElementInterface::setInitialiationStatus ( const bool  value )

pure virtual

Set initialisation status of parameter.

Parameters

value

initialisation status

Implemented in JPARSER::JParserTemplateElement< JCounter >, JPARSER::JParserTemplateElement< bool >, and JPARSER::JParserTemplateElement< JType_t, false >.

print()

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

inlinevirtual

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() << "\""; 
      }
    }

gcount()

virtual bool JPARSER::JParserElementInterface::gcount ( ) const

inlinevirtual

Read counter.

Returns

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

Reimplemented in JPARSER::JParserTemplateElement< JCounter >, and JPARSER::JParserTemplateElement< bool >.

Definition at line 646 of file JParser.hh.

    {
      return true;
    }

read()

virtual std::istream& JLANG::JStreamInput::read ( std::istream &  in )

pure virtualinherited

Stream input.

Parameters

in	input stream

Returns

input stream

Implemented in JTOOLS::JAutoPointer< JDerived_t, JBase_t >, JLANG::JValueInput< T >, JEEP::JPropertiesTemplateElement< JProperties >, JEEP::JPropertiesTemplateElement< JProperties::JFileReader >, JEEP::JPropertiesTemplateElement< const T >, JEEP::JPropertiesTemplateElement< T >, JPARSER::JParserTemplateElement< JCounter >, JPARSER::JParserTemplateElement< bool >, and JPARSER::JParserTemplateElement< JType_t, false >.

write()

virtual std::ostream& JLANG::JStreamOutput::write ( std::ostream &  out ) const

pure virtualinherited

Stream output.

Parameters

out	output stream

Returns

output stream

Implemented in JTOOLS::JAutoPointer< JDerived_t, JBase_t >, JLANG::JValueOutput< T >, JEEP::JPropertiesTemplateElement< JProperties >, JEEP::JPropertiesTemplateElement< JProperties::JFileReader >, JEEP::JPropertiesTemplateElement< const T >, JEEP::JPropertiesTemplateElement< T >, JPARSER::JParserTemplateElement< JCounter >, JPARSER::JParserTemplateElement< bool >, and JPARSER::JParserTemplateElement< JType_t, false >.

Member Data Documentation

__name

std::string JPARSER::JParserElementInterface::__name

protected

Definition at line 653 of file JParser.hh.

__help

std::string JPARSER::JParserElementInterface::__help

protected

Definition at line 654 of file JParser.hh.

---

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

• JParser.hh