Jpp  19.0.0
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
JPARSER::JParserElementInterface Class Referenceabstract

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

#include <JParser.hh>

Inheritance diagram for JPARSER::JParserElementInterface:
JLANG::JStreamInput JLANG::JStreamOutput JPARSER::JParserTemplateElement< bool > JPARSER::JParserTemplateElement< JCounter > JPARSER::JParserTemplateElement< JType_t, false > JPARSER::JParserTemplateElement< JType_t, true >

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

Constructor & Destructor Documentation

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

Constructor.

Parameters
namename of object
helphelp of object

Definition at line 573 of file JParser.hh.

574  :
575  __name(name),
576  __help(help)
577  {}
then fatal The output file must have the wildcard in the name
Definition: JCanberra.sh:31

Member Function Documentation

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

Get name of parameter.

Returns
name

Definition at line 586 of file JParser.hh.

587  {
588  return __name;
589  }
const std::string& JPARSER::JParserElementInterface::getHelp ( ) const
inline

Get help of parameter.

Returns
help

Definition at line 597 of file JParser.hh.

598  {
599  return __help;
600  }
virtual bool JPARSER::JParserElementInterface::getStatus ( ) const
pure virtual
virtual bool JPARSER::JParserElementInterface::getInitialisationStatus ( ) const
pure virtual
virtual void JPARSER::JParserElementInterface::setInitialiationStatus ( const bool  value)
pure virtual

Set initialisation status of parameter.

Parameters
valueinitialisation status

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

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

Print.

Parameters
outoutput stream

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

Definition at line 632 of file JParser.hh.

633  {
634  using namespace std;
635 
636  out << "<" << getName() << ">";
637 
638  if (getStatus() && !getShortprint(out)) {
639 
640  int width = WIDTH - getName().length();
641 
642  if (width > 0) {
643  out << setw(width) << " ";
644  }
645 
646  out << " = ";
647 
648  write(out);
649  }
650 
651  if (getLongprint(out) && getHelp() != "") {
652  out << " \"" << getHelp() << "\"";
653  }
654  }
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:586
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:597
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 662 of file JParser.hh.

663  {
664  return true;
665  }
virtual std::istream& JLANG::JStreamInput::read ( std::istream &  in)
pure virtualinherited
virtual std::ostream& JLANG::JStreamOutput::write ( std::ostream &  out) const
pure virtualinherited

Member Data Documentation

std::string JPARSER::JParserElementInterface::__name
protected

Definition at line 669 of file JParser.hh.

std::string JPARSER::JParserElementInterface::__help
protected

Definition at line 670 of file JParser.hh.


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