MINT::NamedParameterBase Class Reference

#include <NamedParameterBase.h>

Inheritance diagram for MINT::NamedParameterBase:

Public Types
enum	VERBOSITY { VERBOSE =0, QUIET =1 }

Public Member Functions
bool	setPPF (ParsedParameterFile *ppF_in=0)
bool	read ()
bool	read (std::istream &is)
bool	read (const std::string &fname)
bool	reloadFile (const std::string &id)
bool	setFromInitString (const std::string &str)
bool	setFromInitStringNoName (const std::string &str_in)
	NamedParameterBase (const std::string &name_in="", const char *fname=0, VERBOSITY=VERBOSE)
	NamedParameterBase (const NamedParameterBase &other)
virtual	~NamedParameterBase ()
virtual const std::string &	name () const
void	quiet (bool beSo=true)
bool	gotInitialised () const
Public Member Functions inherited from MINT::INamedParameter
virtual	~INamedParameter ()

Static Public Member Functions
static bool	setDefaultInputFile (const std::string &fname)
static bool	setDefaultInputStream (std::istream &str=std::cin)

Protected Member Functions
virtual bool	setFromParsedLine (const ParsedParameterLine &line)=0
virtual bool	setFromParsedFile ()
Protected Member Functions inherited from MINT::INamedParameter
	INamedParameter ()

Static Protected Member Functions
static ParsedParameterFileList *	getFlist ()

Protected Attributes
std::string	_name
ParsedParameterFile *	_ppF
bool	_gotInitialised
bool	_quiet

Static Protected Attributes
static bool	IveSaidItOnce =0
static std::string	_defaultFile = ""
static std::istream *	_defaultStreamPtr = &std::cin

Friends
std::stringstream &	operator>> (std::stringstream &is, MINT::NamedParameterBase &npb)

Detailed Description

Definition at line 29 of file NamedParameterBase.h.

Member Enumeration Documentation

VERBOSITY

enum MINT::NamedParameterBase::VERBOSITY

Enumerator
VERBOSE
QUIET

Definition at line 46 of file NamedParameterBase.h.

{VERBOSE=0, QUIET=1};

Constructor & Destructor Documentation

NamedParameterBase() [1/2]

NamedParameterBase::NamedParameterBase	(	const std::string &	name_in = "",
		const char *	fname = 0,
		NamedParameterBase::VERBOSITY	vb = VERBOSE
	)

Definition at line 40 of file NamedParameterBase.cpp.

  : INamedParameter()
  , _name(name_in)
  , _gotInitialised(false)
  , _quiet(vb==NamedParameterBase::QUIET)
{
  _name = ParsedParameterLine::removeLeadingBlanks(
       ParsedParameterLine::removeTrailingBlanks(
        _name));
  if(0 == fname){
    if((! _quiet) && 0 == IveSaidItOnce){
      IveSaidItOnce=true;
      cout << "INFO in constructor of NamedParameterBase:"
       << "\n  > For parameter named: \"" << _name << "\""
       << "\n  > You did not provide a filename."
       << "\n  > I'll read from stdin. This is completely OK,"
       << "\n  > but if there is no input from stdin ending in EOF,"
       << "\n  > the program will stall after this message."
       << "\n  > If you find yourself in this situation, press Ctr-d."
       << "\n  > In future, run the program as ./program < inputFile.txt"
       << "\n  > even if inputFile.txt is just an empty dummy file."
       << "\n  > This message is only printed once."
       << endl;
    }
    NamedParameterBase::read();
  }else{
    NamedParameterBase::read(fname);
  }
}

NamedParameterBase() [2/2]

NamedParameterBase::NamedParameterBase

(

const NamedParameterBase &

other

)

Definition at line 72 of file NamedParameterBase.cpp.

  : INamedParameter()
  , _name(other._name)
  , _ppF(other._ppF)
  , _gotInitialised(other._gotInitialised)
  , _quiet(other._quiet)
{}

~NamedParameterBase()

NamedParameterBase::~NamedParameterBase ( )

virtual

Definition at line 80 of file NamedParameterBase.cpp.

                                       {
  if( (! _gotInitialised) && (! _quiet)){
    cout << "WARNING in destructor of NamedParameterBase:"
     << "\n  > Hello. My name is \"" << _name << "\"."
     << "\n  > I'm being destroyed, and"
     << "\n  > I never even got initialised." 
     << "\n  > Did you do that deliberatly?"
     << endl;
  }
}

Member Function Documentation

getFlist()

ParsedParameterFileList * NamedParameterBase::getFlist ( )

staticprotected

Definition at line 91 of file NamedParameterBase.cpp.

                                                     {
  return ParsedParameterFileList::getMe();
}

gotInitialised()

bool MINT::NamedParameterBase::gotInitialised ( ) const

inline

Definition at line 72 of file NamedParameterBase.h.

{return _gotInitialised;}

name()

virtual const std::string& MINT::NamedParameterBase::name ( ) const

inlinevirtual

Implements MINT::INamedParameter.

Reimplemented in MINT::FitParameter.

Definition at line 67 of file NamedParameterBase.h.

                                       {
    return _name;
  }

quiet()

void MINT::NamedParameterBase::quiet ( bool  beSo = true )

inline

Definition at line 71 of file NamedParameterBase.h.

{_quiet = beSo;}

read() [1/3]

bool NamedParameterBase::read

(

)

Definition at line 102 of file NamedParameterBase.cpp.

                             {
  if(! ("" == _defaultFile)) return read(_defaultFile);
  else return read(*_defaultStreamPtr);
}

read() [2/3]

bool NamedParameterBase::read

(

std::istream &

is

)

Definition at line 106 of file NamedParameterBase.cpp.

                                           {
  _ppF = getFlist()->getParsedFile(is);
  if(0 == _ppF){
    cout << "SERIOUS ERROR IN NamedParameterBase::read(std::istream& is)"
     << "\n  > call to ParsedParameterFileList::getParsedFile"
     << "\n  > return 0 pointer. This is bad. Let's see how long"
     << "\n  > I'll last..." << endl;
    return false;
  }
  return true;
}

read() [3/3]

bool NamedParameterBase::read

(

const std::string &

fname

)

Definition at line 118 of file NamedParameterBase.cpp.

                                                   {
  _ppF = getFlist()->getParsedFile(fname);
  if(0 == _ppF){
    cout << "SERIOUS ERROR IN NamedParameterBase::read(const std::string&)"
     << "\n  > with string value = " << fname << "."
     << "\n  > Call to ParsedParameterFileList::getParsedFile"
     << "\n  > return 0 pointer. This is bad. Let's see how long"
     << "\n  > I'll last..." << endl;
    return false;
  }
  return true;
}

reloadFile()

bool NamedParameterBase::reloadFile

(

const std::string &

id

)

Definition at line 32 of file NamedParameterBase.cpp.

                                                      {
  bool success = true;
  success |= (bool) getFlist()->reloadFile(id);
  success |= read(id);
  success |= setFromParsedFile();
  return success;
}

setDefaultInputFile()

bool NamedParameterBase::setDefaultInputFile ( const std::string &  fname )

static

Definition at line 19 of file NamedParameterBase.cpp.

                                                                  {
  _defaultFile = fname;
  return true;
}

setDefaultInputStream()

bool NamedParameterBase::setDefaultInputStream ( std::istream &  str = std::cin )

static

Definition at line 24 of file NamedParameterBase.cpp.

                                                             {
  _defaultFile="";
  _defaultStreamPtr = &str;
  return true;
}

setFromInitString()

bool NamedParameterBase::setFromInitString

(

const std::string &

str

)

Definition at line 154 of file NamedParameterBase.cpp.

                                                              {
  ParsedParameterLine ppl(str);
  return this->setFromParsedLine(ppl);
}

setFromInitStringNoName()

bool NamedParameterBase::setFromInitStringNoName

(

const std::string &

str_in

)

Definition at line 158 of file NamedParameterBase.cpp.

                                                                       {
  std::string str = name() + "\t" + str_in;
  ParsedParameterLine ppl(str);
  return this->setFromParsedLine(ppl);
}

setFromParsedFile()

bool NamedParameterBase::setFromParsedFile ( )

protectedvirtual

Definition at line 131 of file NamedParameterBase.cpp.

                                          {
  bool success=false;
  if(0 == _ppF){
    if((! _gotInitialised) && (! _quiet)){
      cout << "WARNING in  NamedParameterBase::setFromParsedFile():"
       << "\n No ParsedParameterFile attached!." << endl;
    }
    return false;
  }
  const ParsedParameterLine& ppL =_ppF->find(name());
  if(! ppL.isValid()){
    /*if(! _quiet){
      cout << "WARNING in  NamedParameterBase::setFromParsedFile():"
       << "\n  > Can't find variable with name \"" << name() << "\""
       << "\n  > in attached ParsedParameterFile." << endl;
    }*/
  }else{
    success = setFromParsedLine(ppL);
  }
  if(success) _gotInitialised = true;
  return success;
}

setFromParsedLine()

virtual bool MINT::NamedParameterBase::setFromParsedLine ( const ParsedParameterLine &  line )

protectedpure virtual

Implements MINT::INamedParameter.

Implemented in MINT::NamedParameter< T >, MINT::NamedParameter< double >, MINT::NamedParameter< std::string >, MINT::NamedParameter< int >, MINT::FitParameter, MINT::NamedParameter< T >, MINT::NamedParameter< double >, MINT::NamedParameter< std::string >, MINT::NamedParameter< int >, MINT::NamedParameter< T >, MINT::NamedParameter< double >, MINT::NamedParameter< std::string >, and MINT::NamedParameter< int >.

setPPF()

bool NamedParameterBase::setPPF

(

ParsedParameterFile *

ppF_in = 0

)

Definition at line 95 of file NamedParameterBase.cpp.

                                                          {
  //  if(0 != _ppF) delete _ppF;
  // above now managed by ParsedParameterFileList
  _ppF = ppF_in;
  return true;
}

Friends And Related Function Documentation

operator>>

std::stringstream& operator>> ( std::stringstream &  is, MINT::NamedParameterBase &  npb  )

friend

Definition at line 164 of file NamedParameterBase.cpp.

                                                {
  std::string str;
  is >> str;
  npb.setFromInitStringNoName(str);
  return is;
}

Member Data Documentation

_defaultFile

std::string NamedParameterBase::_defaultFile = ""

staticprotected

Definition at line 36 of file NamedParameterBase.h.

_defaultStreamPtr

std::istream * NamedParameterBase::_defaultStreamPtr = &std::cin

staticprotected

Definition at line 37 of file NamedParameterBase.h.

_gotInitialised

bool MINT::NamedParameterBase::_gotInitialised

protected

Definition at line 41 of file NamedParameterBase.h.

_name

std::string MINT::NamedParameterBase::_name

protected

Definition at line 32 of file NamedParameterBase.h.

_ppF

ParsedParameterFile* MINT::NamedParameterBase::_ppF

protected

Definition at line 34 of file NamedParameterBase.h.

_quiet

bool MINT::NamedParameterBase::_quiet

protected

Definition at line 43 of file NamedParameterBase.h.

IveSaidItOnce

bool NamedParameterBase::IveSaidItOnce =0

staticprotected

Definition at line 31 of file NamedParameterBase.h.

---

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

• Mint/NamedParameterBase.h
• src/Mint/NamedParameter/NamedParameterBase.cpp