Jpp  master_rocky-37-gf0c5bc59d
the software that should make you happy
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< JCounter > JPARSER::JParserTemplateElement< JType_t, false > JPARSER::JParserTemplateElement< bool > 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 546 of file JParser.hh.

Constructor & Destructor Documentation

◆ JParserElementInterface()

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

Constructor.

Parameters
namename of object
helphelp of object

Definition at line 557 of file JParser.hh.

558  :
559  __name(name),
560  __help(help)
561  {}

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.

571  {
572  return __name;
573  }

◆ getHelp()

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

Get help of parameter.

Returns
help

Definition at line 581 of file JParser.hh.

582  {
583  return __help;
584  }

◆ getStatus()

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

◆ getInitialisationStatus()

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

◆ setInitialiationStatus()

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 >.

◆ print()

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

Print.

Parameters
outoutput stream

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

Definition at line 616 of file JParser.hh.

617  {
618  using namespace std;
619 
620  out << "<" << getName() << ">";
621 
622  if (getStatus() && !getShortprint(out)) {
623 
624  int width = WIDTH - getName().length();
625 
626  if (width > 0) {
627  out << setw(width) << " ";
628  }
629 
630  out << " = ";
631 
632  write(out);
633  }
634 
635  if (getLongprint(out) && getHelp() != "") {
636  out << " \"" << getHelp() << "\"";
637  }
638  }
bool getShortprint(std::ostream &out)
Get short print option.
Definition: JManip.hh:75
bool getLongprint(std::ostream &out)
Get long print option.
Definition: JManip.hh:121
virtual std::ostream & write(std::ostream &out) const =0
Stream output.
const std::string & getHelp() const
Get help of parameter.
Definition: JParser.hh:581
virtual bool getStatus() const =0
Get status of parameter.
const std::string & getName() const
Get name of parameter.
Definition: JParser.hh:570
Definition: JSTDTypes.hh:14
Auxiliary data structure for alignment of data.
Definition: JManip.hh:231

◆ 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.

647  {
648  return true;
649  }

◆ read()

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

◆ write()

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

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: