JEEP Namespace Reference

General puprpose classes and methods. More...

Classes
class	JArgs
	Data structure to store command line arguments. More...
struct	JComment
	Auxiliary class for comment. More...
class	JCommunicator
	Auxiliary class to control standard input and output. More...
struct	JContainer
	Auxiliary wrapper for I/O of container with optional comment (see JComment). More...
struct	JDate
	Auxiliary class for simple date. More...
struct	JEEPZ
	Auxiliary data structure for streaming of STL containers. More...
struct	JFunctionAdaptor
	Function adaptor. More...
struct	JFunctionAdaptorHelper
	Auxiliary base class for function adaptor. More...
struct	JGetStatusBit
	Auxiliary class to map key to status bit. More...
struct	JMessage
	Auxiliary class for handling debug parameter within a class. More...
struct	JMessage< JAANET::JHondaFluxInterpolator< JPhiFunction_t, JCoszFunctionalMap_t, JEnergyFunctionalMap_t > >
	JMessage template specialization for Honda atmospheric neutrino flux interpolators. More...
struct	JMessage< JOSCPROB::JOscProbInterpolator< JCollection_t, JFunction1D_t, JFunctionalMaplist_t > >
	JMessage template specialization for oscillation probability interpolators. More...
class	JProperties
	Utility class to parse parameter values. More...
class	JPropertiesElement
	The property value class. More...
class	JPropertiesElementInterface
	Interface for I/O of properties element. More...
class	JPropertiesTemplateElement
	Template class for I/O of properties element. More...
class	JPropertiesTemplateElement< const T >
	Template specialisation of JPropertiesTemplateElement for const data type. More...
class	JPropertiesTemplateElement< JProperties >
	Template specialisation for JProperties. More...
class	JPropertiesTemplateElement< JProperties::JFileReader >
	Template specialisation for JFileReader. More...
struct	JPutStatusBit
	Auxiliary class to map status bit to key. More...
struct	JStatus
	Auxiliary class for handling status. More...
struct	JTime
	Auxiliary class for simple time. More...
class	JTimekeeper
	Time keeper. More...
class	JTimer
	Auxiliary class for CPU timing and usage. More...
struct	JVersion
	Auxiliary data structure for general purpose version number. More...

Typedefs
typedef std::vector< std::string >	JComment_t
	Type definition of comment block.
typedef std::multimap< JDate<'-'>, std::string >	JGITTags_t
	Type definition of dated GIT tags.

Enumerations
enum	JMessage_t {   debug_t = 3 , status_t = 2 , warning_t = 2 , notice_t = 1 ,   error_t = 0 , fatal_t = 0 }
	Debug level. More...
enum	JScale_t {   femto_t = -15 , pico_t = -12 , nano_t = -9 , micro_t = -6 ,   milli_t = -3 , unit_t = 0 , kilo_t = +3 , mega_t = +6 ,   giga_t = +9 , tera_t = +12 , peta_t = +15 , exa_t = +18 }
	Enumeration for scaling of quantity. More...

Functions
template<class T >
bool	compareObjects (const T &first, const T &second, JBool< true >)
	Comparison of comparable objects.
template<class T >
bool	compareObjects (const T &first, const T &second, JBool< false >)
	Comparison of uncomparable objects.
template<class T >
bool	compareObjects (const T &first, const T &second)
	Comparison of objects.
template<int N>
bool	compareObjects (const char(&first)[N], const char(&second)[N])
	Comparison of comparable objects.
bool	hasWildCard (const std::string &file_name)
	Check presence of wild card.
std::string	setWildCard (const std::string &file_name, const std::string &value)
	Get file name by setting wild card to given value.
std::string	strip (const std::string &file_name)
	Strip leading and trailing white spaces from file name.
std::string	getFilenameExtension (const std::string &file_name)
	Get file name extension, i.e. part after last JEEP::FILENAME_SEPARATOR if any.
std::string	getFilename (const std::string &file_name)
	Get file name part, i.e. part after last JEEP::PATHNAME_SEPARATOR if any.
std::string	getPath (const std::string &file_name)
	Get path, i.e. part before last JEEP::PATHNAME_SEPARATOR if any.
std::string	getFullPath (const std::string &path)
	Get full path, i.e. add JEEP::PATHNAME_SEPARATOR if necessary.
std::string	getFilename (const std::string &path, const std::string &file_name)
	Compose full file name and introduce JEEP::PATHNAME_SEPARATOR if needed.
std::string	getPath (const std::string &variable, const std::string &file_name)
	Get selected path from environment variable for given file name.
std::string	getFullFilename (const std::string &variable, const std::string &file_name)
	Get full file name (see JEEP::getPath).
std::string	getNamespace (const std::string &type_name)
	Get name space, i.e. part before JEEP::TYPENAME_SEPARATOR.
std::string	getClassname (const std::string &type_name)
	Get type name, i.e. part after JEEP::TYPENAME_SEPARATOR.
std::string	getProtocol (const std::string &file_name)
	Get protocol, i.e. part before first JEEP::PROTOCOL_SEPARATOR if any.
std::string	getURL ()
	Get URL of document pages.
template<class T >
T *	open (const std::string &file_name)
	Open file.
template<>
std::istream *	open (const std::string &file_name)
	Open file.
template<>
std::ostream *	open (const std::string &file_name)
	Open file.
void	close (std::istream *pf)
	Close file.
void	close (std::ostream *pf)
	Close file.
const JGITTags_t &	getGITTags ()
	Get GIT dated tags.
std::string	getGITVersion (const std::string &tag)
	Get GIT version for given GIT tag.
template<class T >
int	sign (const T &value)
	Get sign of value.
std::ostream &	getOstream ()
	Get output stream for conversion to std::string.
const char *	getCString (const std::string &input)
	Get output C-string.
bool	fail (std::istream &in)
	Check for stream state.
template<class T >
JProperties &	getProperties (T &object, const JEquationParameters &parameters=JEquationParameters(), const int debug=1)
	Get properties of a given object.
double	getValue (const JScale_t scale)
	Get numerical value corresponding to scale.
const char *	getUnit (const int scale)
	Get textual unit corresponding to scale.
JScale_t	getScale (const char unit)
	Get scale corresponding to textual unit.
void	print (std::ostream &out, const JStatus &status, const JPutStatusBit &helper)
	Print status.
void	print (std::ostream &out, const JStatus &status, const JGetStatusBit &helper)
	Print status.
template<class T >
std::istream &	readObject (std::istream &in, T &object)
	Stream input of object.
template<class T >
std::ostream &	writeObject (std::ostream &out, const T &object)
	Stream output of object.
template<class T >
std::ostream &	writeObject (std::ostream &out, const char *prefix, const T &object, const char postfix)
	Stream output of object.
template<class JFirst_t , class JSecond_t >
std::istream &	readObject (std::istream &in, std::pair< JFirst_t, JSecond_t > &object)
	Template specialisation of method readObject() for std::pair.
template<class JFirst_t , class JSecond_t >
std::ostream &	writeObject (std::ostream &out, const std::pair< JFirst_t, JSecond_t > &object)
	Template specialisation of method writeObject() for std::pair.
template<class JFirst_t , class JSecond_t >
std::ostream &	writeObject (std::ostream &out, const char *prefix, const std::pair< JFirst_t, JSecond_t > &object, const char postfix)
	Template specialisation of method writeObject() for std::pair.
template<class JElement_t , class JAllocator_t >
std::istream &	readObject (std::istream &in, std::vector< JElement_t, JAllocator_t > &object)
	Template specialisation of method readObject() for std::vector.
template<class JElement_t , class JAllocator_t >
std::ostream &	writeObject (std::ostream &out, const std::vector< JElement_t, JAllocator_t > &object)
	Template specialisation of method writeObject() for std::vector.
template<class JElement_t , class JAllocator_t >
std::ostream &	writeObject (std::ostream &out, const char *prefix, const std::vector< JElement_t, JAllocator_t > &object, const char postfix)
	Template specialisation of method writeObject() for std::vector.
template<class JElement_t , class JAllocator_t >
std::istream &	readObject (std::istream &in, std::list< JElement_t, JAllocator_t > &object)
	Template specialisation of method readObject() for std::list.
template<class JElement_t , class JAllocator_t >
std::ostream &	writeObject (std::ostream &out, const std::list< JElement_t, JAllocator_t > &object)
	Template specialisation of method writeObject() for std::list.
template<class JElement_t , class JAllocator_t >
std::ostream &	writeObject (std::ostream &out, const char *prefix, const std::list< JElement_t, JAllocator_t > &object, const char postfix)
	Template specialisation of method writeObject() for std::list.
template<class JElement_t , class JComparator_t , class JAllocator_t >
std::istream &	readObject (std::istream &in, std::set< JElement_t, JComparator_t, JAllocator_t > &object)
	Template specialisation of method readObject() for std::set.
template<class JElement_t , class JComparator_t , class JAllocator_t >
std::ostream &	writeObject (std::ostream &out, const std::set< JElement_t, JComparator_t, JAllocator_t > &object)
	Template specialisation of method writeObject() for std::set.
template<class JElement_t , class JComparator_t , class JAllocator_t >
std::ostream &	writeObject (std::ostream &out, const char *prefix, const std::set< JElement_t, JComparator_t, JAllocator_t > &object, const char postfix)
	Template specialisation of method writeObject() for std::set.
template<class JElement_t , class JComparator_t , class JAllocator_t >
std::istream &	readObject (std::istream &in, std::multiset< JElement_t, JComparator_t, JAllocator_t > &object)
	Template specialisation of method readObject() for std::multiset.
template<class JElement_t , class JComparator_t , class JAllocator_t >
std::ostream &	writeObject (std::ostream &out, const std::multiset< JElement_t, JComparator_t, JAllocator_t > &object)
	Template specialisation of method writeObject() for std::multiset.
template<class JElement_t , class JComparator_t , class JAllocator_t >
std::ostream &	writeObject (std::ostream &out, const char *prefix, const std::multiset< JElement_t, JComparator_t, JAllocator_t > &object, const char postfix)
	Template specialisation of method writeObject() for std::multiset.
template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >
std::istream &	readObject (std::istream &in, std::map< JKey_t, JValue_t, JComparator_t, JAllocator_t > &object)
	Template specialisation of method readObject() for std::map.
template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >
std::ostream &	writeObject (std::ostream &out, const std::map< JKey_t, JValue_t, JComparator_t, JAllocator_t > &object)
	Template specialisation of method writeObject() for std::map.
template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >
std::ostream &	writeObject (std::ostream &out, const char *prefix, const std::map< JKey_t, JValue_t, JComparator_t, JAllocator_t > &object, const char postfix)
	Template specialisation of method writeObject() for std::map.
template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >
std::istream &	readObject (std::istream &in, std::multimap< JKey_t, JValue_t, JComparator_t, JAllocator_t > &object)
	Template specialisation of method readObject() for std::multimap.
template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >
std::ostream &	writeObject (std::ostream &out, const std::multimap< JKey_t, JValue_t, JComparator_t, JAllocator_t > &object)
	Template specialisation of method writeObject() for std::multimap.
template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >
std::ostream &	writeObject (std::ostream &out, const char *prefix, const std::multimap< JKey_t, JValue_t, JComparator_t, JAllocator_t > &object, const char postfix)
	Template specialisation of method writeObject() for std::multimap.
template<class JElement_t , std::size_t N>
std::istream &	readObject (std::istream &in, std::array< JElement_t, N > &object)
	Template specialisation of method readObject() for std::array.
template<class JElement_t , std::size_t N>
std::ostream &	writeObject (std::ostream &out, const std::array< JElement_t, N > &object)
	Template specialisation of method writeObject() for std::array.
template<class JElement_t , std::size_t N>
std::ostream &	writeObject (std::ostream &out, const char *prefix, const std::array< JElement_t, N > &object, const char postfix)
	Template specialisation of method writeObject() for std::array.
template<class T >
std::ostream &	writeArray (std::ostream &out, const char *left, const char *right, const char *sep, T __begin, T __end)
	Write array of objects.

Variables
static const char *const	LD_LIBRARY_PATH = "LD_LIBRARY_PATH"
	Nick names of environment variables.
static const char *const	PATH = "PATH"
	binary file paths
static const char *const	SHELL = "SHELL"
	SHELL.
static const char *const	JPP_PAGES = "JPP_PAGES"
	Jpp document pages.
static const char	PATHNAME_SEPARATOR = '/'
	path name separator
static const char	PATHLIST_SEPARATOR = ':'
	path list separator
static const char	FILENAME_SEPARATOR = '.'
	file name separator
static const char *const	TYPENAME_SEPARATOR = "::"
	type name separator
static const char	PROTOCOL_SEPARATOR = ':'
	protocol separator
static const char	FILENAME_WILDCARD = '%'
	wild card character for file name substitution

Detailed Description

General puprpose classes and methods.

Author

mdejong

bjung

Typedef Documentation

JComment_t

typedef std::vector<std::string> JEEP::JComment_t

Type definition of comment block.

Definition at line 31 of file JComment.hh.

JGITTags_t

typedef std::multimap<JDate<'-'>, std::string> JEEP::JGITTags_t

Type definition of dated GIT tags.

Definition at line 25 of file Jeep/JGITTags.hh.

Enumeration Type Documentation

JMessage_t

enum JEEP::JMessage_t

Debug level.

Enumerator
debug_t	debug
status_t	status
warning_t	warning
notice_t	notice
error_t	error
fatal_t	fatal; exit

Definition at line 27 of file JMessage.hh.

                  {
    
    debug_t   = 3,    //!< debug
    status_t  = 2,    //!< status
    warning_t = 2,    //!< warning
    notice_t  = 1,    //!< notice
    error_t   = 0,    //!< error
    fatal_t   = 0     //!< fatal; exit
  };

JScale_t

enum JEEP::JScale_t

Enumeration for scaling of quantity.

Enumerator
femto_t	femto
pico_t	pico
nano_t	nano
micro_t	micro
milli_t	milli
unit_t	unit
kilo_t	kilo
mega_t	mega
giga_t	giga
tera_t	tera
peta_t	peta
exa_t	exa

Definition at line 24 of file JScale.hh.

                {
 
    femto_t  =  -15,    //!< femto
    pico_t   =  -12,    //!< pico
    nano_t   =   -9,    //!< nano
    micro_t  =   -6,    //!< micro
    milli_t  =   -3,    //!< milli
    unit_t   =    0,    //!< unit
    kilo_t   =   +3,    //!< kilo
    mega_t   =   +6,    //!< mega
    giga_t   =   +9,    //!< giga
    tera_t   =  +12,    //!< tera
    peta_t   =  +15,    //!< peta
    exa_t    =  +18     //!< exa
  };

Function Documentation

compareObjects() [1/4]

template<class T >

bool JEEP::compareObjects ( const T & first, const T & second, JBool< true >  )

inline

Comparison of comparable objects.

Parameters

first	first object
second	second object

Returns

true if objects are equal; else false

Definition at line 32 of file JComparisonToolkit.hh.

  {
    return first == second;
  }

compareObjects() [2/4]

template<class T >

bool JEEP::compareObjects ( const T & first, const T & second, JBool< false >  )

inline

Comparison of uncomparable objects.

Parameters

first	first object
second	second object

Returns

false

Definition at line 48 of file JComparisonToolkit.hh.

  {
    return false;
  }

compareObjects() [3/4]

template<class T >

bool JEEP::compareObjects ( const T & first, const T & second )

inline

Comparison of objects.

Parameters

first	first object
second	second object

Returns

true if objects are comparable and equal; else false

Definition at line 64 of file JComparisonToolkit.hh.

  { 
    return compareObjects(first, second, JBool<JComparisonAvailable<T>::has_eq>());
  }

compareObjects() [4/4]

template<int N>

bool JEEP::compareObjects ( const char(&) first[N], const char(&) second[N] )

inline

Comparison of comparable objects.

Parameters

first	first object
second	second object

Returns

true if objects are equal; else false

Definition at line 79 of file JComparisonToolkit.hh.

  {
    return strcmp(first, second) == 0;
  }

hasWildCard()

bool JEEP::hasWildCard ( const std::string & file_name )

inline

Check presence of wild card.

Parameters

file_name

file name

Returns

true if wild card present; else false

Definition at line 53 of file JeepToolkit.hh.

  {
    return (file_name.find(FILENAME_WILDCARD) != std::string::npos);
  }

setWildCard()

std::string JEEP::setWildCard ( const std::string & file_name, const std::string & value )

inline

Get file name by setting wild card to given value.

Parameters

file_name	input file name
value	value

Returns

output file name

Definition at line 66 of file JeepToolkit.hh.

  {
    using namespace std;
    using namespace JPP;
 
    string buffer = file_name;
 
    string::size_type pos = buffer.find(FILENAME_WILDCARD);
 
    if (pos == string::npos) {
      THROW(JNoValue, "Method getFilename(): Missing wild card character \'" << FILENAME_WILDCARD << "\'.");
    }
 
    return buffer.replace(pos, 1, value);
  }

strip()

std::string JEEP::strip ( const std::string & file_name )

inline

Strip leading and trailing white spaces from file name.

Parameters

file_name

file name

Returns

file name

Definition at line 89 of file JeepToolkit.hh.

  {
    using namespace std;
 
    string::const_iterator         p = file_name. begin();
    string::const_reverse_iterator q = file_name.rbegin();
    
    for ( ; p != file_name.end() && q != file_name.rend() && isspace(*p); ++p) {}
    for ( ; p != file_name.end() && q != file_name.rend() && isspace(*q); ++q) {}
    
    return string(p,q.base());
  }

getFilenameExtension()

std::string JEEP::getFilenameExtension ( const std::string & file_name )

inline

Get file name extension, i.e. part after last JEEP::FILENAME_SEPARATOR if any.

Parameters

file_name

file name

Returns

extension (excluding separator)

Definition at line 109 of file JeepToolkit.hh.

  {
    using namespace std;
 
    const size_t pos = file_name.rfind(FILENAME_SEPARATOR);
 
    if (pos != string::npos)
      return file_name.substr(pos + 1);
    else
      return "";
  }

getFilename() [1/2]

std::string JEEP::getFilename ( const std::string & file_name )

inline

Get file name part, i.e. part after last JEEP::PATHNAME_SEPARATOR if any.

Parameters

file_name

file name

Returns

file name part (excluding separator)

Definition at line 128 of file JeepToolkit.hh.

  {
    using namespace std;
 
    const string buffer = strip(file_name);
    const size_t pos    = buffer.rfind(PATHNAME_SEPARATOR);
 
    if (pos != string::npos)
      return buffer.substr(pos + 1);
    else
      return buffer;
  }

getPath() [1/2]

std::string JEEP::getPath ( const std::string & file_name )

inline

Get path, i.e. part before last JEEP::PATHNAME_SEPARATOR if any.

Parameters

file_name

file name

Returns

path (including separator)

Definition at line 148 of file JeepToolkit.hh.

  {
    using namespace std;
 
    const string buffer = strip(file_name);
    const size_t pos    = buffer.rfind(PATHNAME_SEPARATOR);
 
    if (pos != string::npos)
      return buffer.substr(0, pos + 1);
    else
      return "";
  }

getFullPath()

std::string JEEP::getFullPath ( const std::string & path )

inline

Get full path, i.e. add JEEP::PATHNAME_SEPARATOR if necessary.

Parameters

path

path

Returns

path (including separator)

Definition at line 168 of file JeepToolkit.hh.

  {
    using namespace std;
 
    const string buffer = strip(path);
 
    if (buffer.empty() || *buffer.rbegin() == PATHNAME_SEPARATOR) {
 
      return buffer;
 
    } else {
 
      return buffer + PATHNAME_SEPARATOR;
    }
  }

getFilename() [2/2]

std::string JEEP::getFilename ( const std::string & path, const std::string & file_name )

inline

Compose full file name and introduce JEEP::PATHNAME_SEPARATOR if needed.

Parameters

path	path
file_name	file name

Returns

file name

Definition at line 192 of file JeepToolkit.hh.

  {
    using namespace std;
 
    const string buffer = getFullPath(path);
 
    if (buffer.empty())
      return strip(file_name);
    else
      return buffer + strip(file_name);
  }

getPath() [2/2]

std::string JEEP::getPath ( const std::string & variable, const std::string & file_name )

inline

Get selected path from environment variable for given file name.

The environment variable is parsed according character JEEP::PATHLIST_SEPARATOR. The first path in which a file exists with the given file name is returned. If no existing file is found, an empty path is returned.

Parameters

variable	environment variable
file_name	file name

Returns

path

Definition at line 216 of file JeepToolkit.hh.

  {
    using namespace std;
 
    string path = "";
 
    if (!file_name.empty() && file_name[0] != PATHNAME_SEPARATOR) {
 
      const char* const p = getenv(variable.c_str());
 
      if (p != NULL) {
 
        const string buffer(p);
        
        if (!buffer.empty()) {
          
          size_t pos = 0, len;
          
          do { 
          
            len  = buffer.substr(pos).find(PATHLIST_SEPARATOR);
            path = buffer.substr(pos,len);
 
          } while (!ifstream(getFilename(path, file_name).c_str()).good() && len != string::npos && (pos += len + 1) != buffer.length());
        }
      }
    }
 
    if (ifstream(getFilename(path, file_name).c_str()).good())
      return path;
    else
      return "";
  }  

getFullFilename()

std::string JEEP::getFullFilename ( const std::string & variable, const std::string & file_name )

inline

Get full file name (see JEEP::getPath).

Parameters

variable	environment variable
file_name	file name

Returns

file name

Definition at line 258 of file JeepToolkit.hh.

  {
    return getFilename(getPath(variable, file_name), file_name);
  }

getNamespace()

std::string JEEP::getNamespace ( const std::string & type_name )

inline

Get name space, i.e. part before JEEP::TYPENAME_SEPARATOR.

Parameters

type_name

type name

Returns

name space (possibly empty)

Definition at line 270 of file JeepToolkit.hh.

  {
    using namespace std;
 
    const size_t pos = type_name.rfind(TYPENAME_SEPARATOR);
 
    if (pos != string::npos)
      return type_name.substr(0, pos);
    else
      return "";
  }

getClassname()

std::string JEEP::getClassname ( const std::string & type_name )

inline

Get type name, i.e. part after JEEP::TYPENAME_SEPARATOR.

Parameters

type_name

type name

Returns

class name

Definition at line 289 of file JeepToolkit.hh.

  {
    using namespace std;
 
    const size_t pos = type_name.rfind(TYPENAME_SEPARATOR);
 
    if (pos != string::npos)
      return type_name.substr(pos + 2);
    else
      return type_name;
  }

getProtocol()

std::string JEEP::getProtocol ( const std::string & file_name )

inline

Get protocol, i.e. part before first JEEP::PROTOCOL_SEPARATOR if any.

Parameters

file_name

file name

Returns

protocol (excluding separator)

Definition at line 308 of file JeepToolkit.hh.

  {
    using namespace std;
 
    const size_t pos = file_name.find(PROTOCOL_SEPARATOR);
 
    if (pos != string::npos)
      return file_name.substr(0, pos);
    else
      return "";
  }

getURL()

std::string JEEP::getURL ( )

inline

Get URL of document pages.

Returns

URL

Definition at line 326 of file JeepToolkit.hh.

  {
    const char* const url = getenv(JPP_PAGES);
 
    return std::string(url != NULL ? url : "");
  }

open() [1/3]

template<class T >

T * JEEP::open ( const std::string & file_name )

inline

Open file.

Parameters

file_name

file name

Returns

pointer to input stream

open() [2/3]

template<>

std::istream * JEEP::open ( const std::string & file_name )

inline

Open file.

Parameters

file_name

file name

Returns

pointer to input stream

Definition at line 351 of file JeepToolkit.hh.

  {
    using namespace std;
    using namespace JPP;
 
    if      (getFilenameExtension(file_name) == "gz") 
      return new igzstream(file_name.c_str());
    else if (getFilenameExtension(file_name) == "txt") 
      return new ifstream (file_name.c_str());
    else
      return NULL;
  }

open() [3/3]

template<>

std::ostream * JEEP::open ( const std::string & file_name )

inline

Open file.

Parameters

file_name

file name

Returns

pointer to output stream

Definition at line 372 of file JeepToolkit.hh.

  {
    using namespace std;
    using namespace JPP;
 
    if      (getFilenameExtension(file_name) == "gz") 
      return new ogzstream(file_name.c_str());
    else if (getFilenameExtension(file_name) == "txt") 
      return new ofstream (file_name.c_str());
    else
      return NULL;
  }

close() [1/2]

void JEEP::close ( std::istream * pf )

inline

Close file.

Parameters

pf	pointer to file stream

Definition at line 391 of file JeepToolkit.hh.

  {
    using namespace std;
    using namespace JPP;
 
    if (dynamic_cast<ifstream*> (pf) != NULL) { dynamic_cast<ifstream*> (pf)->close(); return; }
    if (dynamic_cast<igzstream*>(pf) != NULL) { dynamic_cast<igzstream*>(pf)->close(); return; }
  }

close() [2/2]

void JEEP::close ( std::ostream * pf )

inline

Close file.

Parameters

pf	pointer to file stream

Definition at line 406 of file JeepToolkit.hh.

  {
    using namespace std;
    using namespace JPP;
 
    if (dynamic_cast<ofstream*> (pf) != NULL) { dynamic_cast<ofstream*> (pf)->close(); return; }
    if (dynamic_cast<ogzstream*>(pf) != NULL) { dynamic_cast<ogzstream*>(pf)->close(); return; }
  }

getGITTags()

const JGITTags_t & JEEP::getGITTags

(

)

Get GIT dated tags.

Returns

dated GIT tags

Definition at line 8 of file JGITTags.cc.

  {
    using namespace std;
    using namespace JPP;
 
    static JGITTags_t buffer;
 
    if (buffer.empty()) {
 
#ifdef GIT_TAGS
 
      istringstream in(GIT_TAGS);
 
      JDate<'-'> date;
      string     tag;
 
      while (in >> tag >> date) {
        buffer.insert(make_pair(date, tag));
      }
#endif
    }
 
    return buffer;
  }

getGITVersion()

std::string JEEP::getGITVersion ( const std::string & tag )

inline

Get GIT version for given GIT tag.

Parameters

tag

GIT tag

Returns

GIT version

Definition at line 34 of file Jeep/JGITTags.hh.

  {
    if (!tag.empty()) {
 
      if (tag[0] == 'v' ||
          tag[0] == 'V') {
 
        return tag.substr(1);
      }
    }
 
    return tag;
  }

sign()

template<class T >

int JEEP::sign ( const T & value )

inline

Get sign of value.

Parameters

value

value

Returns

-1 if value < 0; 0 if value == 0; +1 if value > 0

Definition at line 20 of file JLib.hh.

  {
    return (value > T(0)) - (value < T(0));
  }

getOstream()

std::ostream & JEEP::getOstream ( )

inline

Get output stream for conversion to std::string.

Note that the stream is emptied before use.

Returns

output stream

Definition at line 28 of file JPrint.hh.

  {
    static std::ostringstream buffer;
 
    buffer.str("");
 
    return buffer;
  }

getCString()

const char * JEEP::getCString ( const std::string & input )

inline

Get output C-string.

Note that this method is needed to guarentee livetime of underlying std::string.

Parameters

input

input

Returns

C-string

Definition at line 46 of file JPrint.hh.

  {
    static std::string buffer;
 
    buffer = input;
 
    return buffer.c_str();
  }

fail()

bool JEEP::fail ( std::istream & in )

inline

Check for stream state.

Note that end-of-file is not defined as an error so to normally process e.g. std::string and std::vector.

Parameters

in	input stream

Returns

true if failure; else false

Definition at line 57 of file JProperties.hh.

  {
    return in.bad() || (in.fail() && !in.eof());
  }

getProperties()

template<class T >

JProperties & JEEP::getProperties ( T & object, const JEquationParameters & parameters = JEquationParameters(), const int debug = 1 )

inline

Get properties of a given object.

This method transfers the making of the property object to the corresponding class whilst preserving the constness of the argument.
The corresponding class should implement the method:

  template<bool is_constant>
  static JProperties getProperties(typename JCategory<T, is_constant>::reference_type object,
                                const JEquationParameters& equation,
                                const int debug)

Parameters

object	object
parameters	equation parameters
debug	debug level

Definition at line 1269 of file JProperties.hh.

  {
    using namespace JPP;
 
    static JProperties properties;
 
    properties = T::template getProperties<JClass<T>::is_constant>(object, parameters, debug);
    
    return properties; 
  }

getValue()

double JEEP::getValue ( const JScale_t scale )

inline

Get numerical value corresponding to scale.

Parameters

scale

scale

Returns

value

Definition at line 47 of file JScale.hh.

  {
    return pow(10.0, scale);
  }

getUnit()

const char * JEEP::getUnit ( const int scale )

inline

Get textual unit corresponding to scale.

Parameters

scale

scale

Returns

textual unit

Definition at line 59 of file JScale.hh.

  {
    switch (scale) {
 
    case femto_t:
      return "f";
 
    case pico_t:
      return "p";
 
    case nano_t:
      return "n";
 
    case micro_t:
      return "u";
 
    case milli_t:
      return "m";
 
    case unit_t:
      return "";
 
    case kilo_t:
      return "k";
 
    case mega_t:
      return "M";
 
    case giga_t:
      return "G";
 
    case tera_t:
      return "T";
 
    case peta_t:
      return "P";
 
    case exa_t:
      return "E";
 
    default:
      THROW(JValueOutOfRange, "getUnit(): invalid scale " << scale);
    };
  }

getScale()

JScale_t JEEP::getScale ( const char unit )

inline

Get scale corresponding to textual unit.

Parameters

unit	textual unit

Returns

scale

Definition at line 111 of file JScale.hh.

  {
    switch (unit) {
 
    case 'f':
      return femto_t;
 
    case 'p':
      return pico_t;
 
    case 'n':
      return nano_t;
 
    case 'u':
      return micro_t;
 
    case 'm':
      return milli_t;
 
    case ' ':
      return unit_t;
 
    case 'k':
      return kilo_t;
 
    case 'M':
      return mega_t;
 
    case 'G':
      return giga_t;
 
    case 'T':
      return tera_t;
 
    case 'P':
      return peta_t;
 
    case 'E':
      return exa_t;
 
    default:
      THROW(JValueOutOfRange, "getScale(): invalid unit " << unit);
    };
  }

print() [1/2]

void JEEP::print ( std::ostream & out, const JStatus & status, const JPutStatusBit & helper )

inline

Print status.

Parameters

out	output stream
status	status
helper	helper

Definition at line 264 of file JStatus.hh.

  {
    using namespace std;
 
    for (const auto& i : helper) {
      out << setw(24) << left << i.second << right << status.has(i.first) << endl;
    }
  }

print() [2/2]

void JEEP::print ( std::ostream & out, const JStatus & status, const JGetStatusBit & helper )

inline

Print status.

Parameters

out	output stream
status	status
helper	helper

Definition at line 281 of file JStatus.hh.

  {
    using namespace std;
 
    for (const auto& i : helper) {
      out << setw(24) << left << i.first << right << status.has(i.second) << endl;
    }
  }

readObject() [1/9]

template<class T >

std::istream & JEEP::readObject ( std::istream & in, T & object )

inline

Stream input of object.

Parameters

in	input stream
object	object

Returns

input stream

Definition at line 28 of file JStreamToolkit.hh.

  {
    return in >> object;
  }

writeObject() [1/18]

template<class T >

std::ostream & JEEP::writeObject ( std::ostream & out, const T & object )

inline

Stream output of object.

Parameters

out	output stream
object	object

Returns

output stream

Definition at line 42 of file JStreamToolkit.hh.

  { 
    return out << object;
  }

writeObject() [2/18]

template<class T >

std::ostream & JEEP::writeObject ( std::ostream & out, const char * prefix, const T & object, const char postfix )

inline

Stream output of object.

Parameters

out	output stream
prefix	prefix
object	object
postfix	postfix

Returns

output stream

Definition at line 58 of file JStreamToolkit.hh.

  { 
    return out << prefix << object << postfix;
  }

readObject() [2/9]

template<class JFirst_t , class JSecond_t >

std::istream & JEEP::readObject ( std::istream & in, std::pair< JFirst_t, JSecond_t > & object )

inline

Template specialisation of method readObject() for std::pair.

Parameters

in	input stream
object	object

Returns

input stream

Definition at line 75 of file JStreamToolkit.hh.

  {
    readObject(in, object.first);
    readObject(in, object.second);
 
    return in;
  }

writeObject() [3/18]

template<class JFirst_t , class JSecond_t >

std::ostream & JEEP::writeObject ( std::ostream & out, const std::pair< JFirst_t, JSecond_t > & object )

inline

Template specialisation of method writeObject() for std::pair.

Parameters

out	output stream
object	object

Returns

output stream

Definition at line 92 of file JStreamToolkit.hh.

  { 
    writeObject(out, object.first);
    writeObject(out, ' ');
    writeObject(out, object.second);
 
    return out;
  }

writeObject() [4/18]

template<class JFirst_t , class JSecond_t >

std::ostream & JEEP::writeObject ( std::ostream & out, const char * prefix, const std::pair< JFirst_t, JSecond_t > & object, const char postfix )

inline

Template specialisation of method writeObject() for std::pair.

Parameters

out	output stream
prefix	prefix
object	object
postfix	postfix

Returns

output stream

Definition at line 112 of file JStreamToolkit.hh.

  { 
    writeObject(out, prefix);
    writeObject(out, object.first);
    writeObject(out, ' ');
    writeObject(out, object.second);
    writeObject(out, postfix);
      
    return out;
  }

readObject() [3/9]

template<class JElement_t , class JAllocator_t >

std::istream & JEEP::readObject ( std::istream & in, std::vector< JElement_t, JAllocator_t > & object )

inline

Template specialisation of method readObject() for std::vector.

Parameters

in	input stream
object	object

Returns

input stream

Definition at line 135 of file JStreamToolkit.hh.

  {
    for (JElement_t element; readObject(in, element); ) {
      object.push_back(element);
    }
    
    return in;
  }

writeObject() [5/18]

template<class JElement_t , class JAllocator_t >

std::ostream & JEEP::writeObject ( std::ostream & out, const std::vector< JElement_t, JAllocator_t > & object )

inline

Template specialisation of method writeObject() for std::vector.

Parameters

out	output stream
object	object

Returns

output stream

Definition at line 153 of file JStreamToolkit.hh.

  { 
    for (typename std::vector<JElement_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      writeObject(out, ' ');
      writeObject(out, *i);
    }
    
    return out;
  }

writeObject() [6/18]

template<class JElement_t , class JAllocator_t >

std::ostream & JEEP::writeObject ( std::ostream & out, const char * prefix, const std::vector< JElement_t, JAllocator_t > & object, const char postfix )

inline

Template specialisation of method writeObject() for std::vector.

Parameters

out	output stream
prefix	prefix
object	object
postfix	postfix

Returns

output stream

Definition at line 174 of file JStreamToolkit.hh.

  { 
    for (typename std::vector<JElement_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      writeObject(out, prefix, *i, postfix);
    }
    
    return out;
  }

readObject() [4/9]

template<class JElement_t , class JAllocator_t >

std::istream & JEEP::readObject ( std::istream & in, std::list< JElement_t, JAllocator_t > & object )

inline

Template specialisation of method readObject() for std::list.

Parameters

in	input stream
object	object

Returns

input stream

Definition at line 195 of file JStreamToolkit.hh.

  {
    for (JElement_t element; readObject(in, element); ) {
      object.push_back(element);
    }
    
    return in;
  }

writeObject() [7/18]

template<class JElement_t , class JAllocator_t >

std::ostream & JEEP::writeObject ( std::ostream & out, const std::list< JElement_t, JAllocator_t > & object )

inline

Template specialisation of method writeObject() for std::list.

Parameters

out	output stream
object	object

Returns

output stream

Definition at line 213 of file JStreamToolkit.hh.

  { 
    for (typename std::list<JElement_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      writeObject(out, ' ');
      writeObject(out, *i);
    }
    
    return out;
  }

writeObject() [8/18]

template<class JElement_t , class JAllocator_t >

std::ostream & JEEP::writeObject ( std::ostream & out, const char * prefix, const std::list< JElement_t, JAllocator_t > & object, const char postfix )

inline

Template specialisation of method writeObject() for std::list.

Parameters

out	output stream
prefix	prefix
object	object
postfix	postfix

Returns

output stream

Definition at line 234 of file JStreamToolkit.hh.

  { 
    for (typename std::list<JElement_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      writeObject(out, prefix, *i, postfix);
    }
    
    return out;
  }

readObject() [5/9]

template<class JElement_t , class JComparator_t , class JAllocator_t >

std::istream & JEEP::readObject ( std::istream & in, std::set< JElement_t, JComparator_t, JAllocator_t > & object )

inline

Template specialisation of method readObject() for std::set.

Parameters

in	input stream
object	object

Returns

input stream

Definition at line 255 of file JStreamToolkit.hh.

  {
    for (JElement_t element; readObject(in, element); ) {
 
      const std::pair<typename std::set<JElement_t, JComparator_t, JAllocator_t>::iterator, bool> result = object.insert(element);
 
      if (!result.second) {
        object.erase (result.first);
        object.insert(element);
      }
    }
    
    return in;
  }

writeObject() [9/18]

template<class JElement_t , class JComparator_t , class JAllocator_t >

std::ostream & JEEP::writeObject ( std::ostream & out, const std::set< JElement_t, JComparator_t, JAllocator_t > & object )

inline

Template specialisation of method writeObject() for std::set.

Parameters

out	output stream
object	object

Returns

output stream

Definition at line 279 of file JStreamToolkit.hh.

  { 
    for (typename std::set<JElement_t, JComparator_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      writeObject(out, ' ');
      writeObject(out, *i);
    }
    
    return out;
  }

writeObject() [10/18]

template<class JElement_t , class JComparator_t , class JAllocator_t >

std::ostream & JEEP::writeObject ( std::ostream & out, const char * prefix, const std::set< JElement_t, JComparator_t, JAllocator_t > & object, const char postfix )

inline

Template specialisation of method writeObject() for std::set.

Parameters

out	output stream
prefix	prefix
object	object
postfix	postfix

Returns

output stream

Definition at line 300 of file JStreamToolkit.hh.

  { 
    for (typename std::set<JElement_t, JComparator_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      writeObject(out, prefix, *i, postfix);
    }
    
    return out;
  }

readObject() [6/9]

template<class JElement_t , class JComparator_t , class JAllocator_t >

std::istream & JEEP::readObject ( std::istream & in, std::multiset< JElement_t, JComparator_t, JAllocator_t > & object )

inline

Template specialisation of method readObject() for std::multiset.

Parameters

in	input stream
object	object

Returns

input stream

Definition at line 321 of file JStreamToolkit.hh.

  {
    for (JElement_t element; readObject(in, element); ) {
      object.insert(element);
    }
    
    return in;
  }

writeObject() [11/18]

template<class JElement_t , class JComparator_t , class JAllocator_t >

std::ostream & JEEP::writeObject ( std::ostream & out, const std::multiset< JElement_t, JComparator_t, JAllocator_t > & object )

inline

Template specialisation of method writeObject() for std::multiset.

Parameters

out	output stream
object	object

Returns

output stream

Definition at line 339 of file JStreamToolkit.hh.

  { 
    for (typename std::multiset<JElement_t, JComparator_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      writeObject(out, ' ');
      writeObject(out, *i);
    }
    
    return out;
  }

writeObject() [12/18]

template<class JElement_t , class JComparator_t , class JAllocator_t >

std::ostream & JEEP::writeObject ( std::ostream & out, const char * prefix, const std::multiset< JElement_t, JComparator_t, JAllocator_t > & object, const char postfix )

inline

Template specialisation of method writeObject() for std::multiset.

Parameters

out	output stream
prefix	prefix
object	object
postfix	postfix

Returns

output stream

Definition at line 360 of file JStreamToolkit.hh.

  { 
    for (typename std::multiset<JElement_t, JComparator_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      writeObject(out, prefix, *i, postfix);
    }
    
    return out;
  }

readObject() [7/9]

template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >

std::istream & JEEP::readObject ( std::istream & in, std::map< JKey_t, JValue_t, JComparator_t, JAllocator_t > & object )

inline

Template specialisation of method readObject() for std::map.

Parameters

in	input stream
object	object

Returns

input stream

Definition at line 381 of file JStreamToolkit.hh.

  {
    for (std::pair<JKey_t, JValue_t> element; readObject(in, element); ) {
 
      const std::pair<typename std::map<JKey_t, JValue_t, JComparator_t, JAllocator_t>::iterator, bool> result = object.insert(element);
 
      if (!result.second) {
        result.first->second = element.second;
      }
    }
 
    return in;
  }

writeObject() [13/18]

template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >

std::ostream & JEEP::writeObject ( std::ostream & out, const std::map< JKey_t, JValue_t, JComparator_t, JAllocator_t > & object )

inline

Template specialisation of method writeObject() for std::map.

Parameters

out	output stream
object	object

Returns

output stream

Definition at line 404 of file JStreamToolkit.hh.

  { 
    for (typename std::map<JKey_t, JValue_t, JComparator_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      writeObject(out, ' ');
      writeObject(out, *i);
    }
 
    return out;
  }

writeObject() [14/18]

template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >

std::ostream & JEEP::writeObject ( std::ostream & out, const char * prefix, const std::map< JKey_t, JValue_t, JComparator_t, JAllocator_t > & object, const char postfix )

inline

Template specialisation of method writeObject() for std::map.

Parameters

out	output stream
prefix	prefix
object	object
postfix	postfix

Returns

output stream

Definition at line 425 of file JStreamToolkit.hh.

  { 
    for (typename std::map<JKey_t, JValue_t, JComparator_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      writeObject(out, prefix, *i, postfix);
    }
 
    return out;
  }

readObject() [8/9]

template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >

std::istream & JEEP::readObject ( std::istream & in, std::multimap< JKey_t, JValue_t, JComparator_t, JAllocator_t > & object )

inline

Template specialisation of method readObject() for std::multimap.

Parameters

in	input stream
object	object

Returns

input stream

Definition at line 446 of file JStreamToolkit.hh.

  {
    for (std::pair<JKey_t, JValue_t> element; readObject(in, element); ) {
      object.insert(element);
    }
 
    return in;
  }

writeObject() [15/18]

template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >

std::ostream & JEEP::writeObject ( std::ostream & out, const std::multimap< JKey_t, JValue_t, JComparator_t, JAllocator_t > & object )

inline

Template specialisation of method writeObject() for std::multimap.

Parameters

out	output stream
object	object

Returns

output stream

Definition at line 464 of file JStreamToolkit.hh.

  { 
    for (typename std::multimap<JKey_t, JValue_t, JComparator_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      writeObject(out, ' ');
      writeObject(out, *i);
    }
 
    return out;
  }

writeObject() [16/18]

template<class JKey_t , class JValue_t , class JComparator_t , class JAllocator_t >

std::ostream & JEEP::writeObject ( std::ostream & out, const char * prefix, const std::multimap< JKey_t, JValue_t, JComparator_t, JAllocator_t > & object, const char postfix )

inline

Template specialisation of method writeObject() for std::multimap.

Parameters

out	output stream
prefix	prefix
object	object
postfix	postfix

Returns

output stream

Definition at line 485 of file JStreamToolkit.hh.

  { 
    for (typename std::multimap<JKey_t, JValue_t, JComparator_t, JAllocator_t>::const_iterator i = object.begin(); i != object.end(); ++i) {
      writeObject(out, prefix, *i, postfix);
    }
 
    return out;
  }

readObject() [9/9]

template<class JElement_t , std::size_t N>

std::istream & JEEP::readObject ( std::istream & in, std::array< JElement_t, N > & object )

inline

Template specialisation of method readObject() for std::array.

Parameters

in	input stream
object	object

Returns

input stream

Definition at line 506 of file JStreamToolkit.hh.

  {
    for (size_t i = 0; i != N; ++i) {
      readObject(in, object[i]);
    }
    
    return in;
  }

writeObject() [17/18]

template<class JElement_t , std::size_t N>

std::ostream & JEEP::writeObject ( std::ostream & out, const std::array< JElement_t, N > & object )

inline

Template specialisation of method writeObject() for std::array.

Parameters

out	output stream
object	object

Returns

output stream

Definition at line 524 of file JStreamToolkit.hh.

  { 
    for (size_t i = 0; i != N; ++i) {
      writeObject(out, ' ');
      writeObject(out, object[i]);
    }
    
    return out;
  }

writeObject() [18/18]

template<class JElement_t , std::size_t N>

std::ostream & JEEP::writeObject ( std::ostream & out, const char * prefix, const std::array< JElement_t, N > & object, const char postfix )

inline

Template specialisation of method writeObject() for std::array.

Parameters

out	output stream
prefix	prefix
object	object
postfix	postfix

Returns

output stream

Definition at line 545 of file JStreamToolkit.hh.

  { 
    for (size_t i = 0; i != N; ++i) {
      writeObject(out, prefix, object[i], postfix);
    }
    
    return out;
  }

writeArray()

template<class T >

std::ostream & JEEP::writeArray ( std::ostream & out, const char * left, const char * right, const char * sep, T __begin, T __end )

inline

Write array of objects.

Parameters

out	output stream
left	left bracket
right	right bracket
sep	separator
__begin	begin of data
__end	end of data

Returns

output stream

Definition at line 570 of file JStreamToolkit.hh.

  { 
    if (std::distance(__begin, __end) != 0) {
 
      out << left;
 
      T i = __begin;
      
      writeObject(out, *i); 
      
      while (++i != __end) {
        
        out << sep;
        
        writeObject(out, *i); 
      }
      
      out << right;
    }
 
    return out;
  }

Variable Documentation

LD_LIBRARY_PATH

const char* const JEEP::LD_LIBRARY_PATH = "LD_LIBRARY_PATH"

static

Nick names of environment variables.

library file paths

Definition at line 34 of file JeepToolkit.hh.

PATH

const char* const JEEP::PATH = "PATH"

static

binary file paths

Definition at line 35 of file JeepToolkit.hh.

SHELL

const char* const JEEP::SHELL = "SHELL"

static

SHELL.

Definition at line 36 of file JeepToolkit.hh.

JPP_PAGES

const char* const JEEP::JPP_PAGES = "JPP_PAGES"

static

Jpp document pages.

Definition at line 37 of file JeepToolkit.hh.

PATHNAME_SEPARATOR

const char JEEP::PATHNAME_SEPARATOR = '/'

static

path name separator

Definition at line 39 of file JeepToolkit.hh.

PATHLIST_SEPARATOR

const char JEEP::PATHLIST_SEPARATOR = ':'

static

path list separator

Definition at line 40 of file JeepToolkit.hh.

FILENAME_SEPARATOR

const char JEEP::FILENAME_SEPARATOR = '.'

static

file name separator

Definition at line 41 of file JeepToolkit.hh.

TYPENAME_SEPARATOR

const char* const JEEP::TYPENAME_SEPARATOR = "::"

static

type name separator

Definition at line 42 of file JeepToolkit.hh.

PROTOCOL_SEPARATOR

const char JEEP::PROTOCOL_SEPARATOR = ':'

static

protocol separator

Definition at line 43 of file JeepToolkit.hh.

FILENAME_WILDCARD

const char JEEP::FILENAME_WILDCARD = '%'

static

wild card character for file name substitution

Definition at line 44 of file JeepToolkit.hh.