DATRW++ library: seismic data I/O with multiple formats
formatmodifier.h File Reference

provide format modifiers (prototypes) More...

#include <string>
#include <sstream>
#include <map>
#include <datrwxx/formats.h>
#include <datrwxx/error.h>
Include dependency graph for formatmodifier.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  datrw::formatmodifiers::ModifierHelp
 Help formatting modifier online help. More...
 
struct  datrw::formatmodifiers::Value
 A struct to store values for a given key. More...
 
class  datrw::Subformat
 Class to handle format modifiersThis class is used to parse a format modifier string. Detailed instructions will be given upon request. For some hints have a look at tests/libdatrwxxtests.c. More...
 

Namespaces

 datrw
 Root namespace of library.
 
 datrw::formatmodifiers
 Namespace containing components of format modifiers.
 

Macros

#define DATRW_assert_modifiers_are_recognized(S, F)
 abort if user passed unused modifiers More...
 
#define DATRW_expect_no_modifier(F, M)
 Issue warning if modifiers are passed but not evaluated. More...
 
#define DATRW_FORMATMODIFIER_H_VERSION   "DATRW_FORMATMODIFIER_H V1.3"
 

Typedefs

typedef std::map< std::string, Value > datrw::formatmodifiers::Tparamap
 A map to store parameters. More...
 

Functions

Tparamap datrw::formatmodifiers::makeparamap (const std::string &p, const std::string &delimiter=":", const std::string &assign="=")
 Create a parameter map from a parameter string. More...
 
void datrw::formatmodifiers::online_help (std::ostream &os)
 Provide online help on modifiers. More...
 
template<class C >
std::ostream & datrw::formatmodifiers::operator<< (ModifierHelp &mh, const C &c)
 Output operator for ModifierHelpFor line indentation an object of type ModifierHelp can be used like an output stream;. More...
 

Detailed Description

provide format modifiers (prototypes)


Author
Thomas Forbriger
Date
28/07/2011

provide format modifiers (prototypes)


This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software

Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Copyright (c) 2011 by Thomas Forbriger (BFO Schiltach)

REVISIONS and CHANGES

  • 28/07/2011 V1.0 Thomas Forbriger (thof)
  • 21/01/2012 V1.1 provide online help output support class
  • 05/07/2016 V1.2 thof: provide output operator for line indentation with modifier help
  • 08/07/2016 V1.3 make correct use of new DATRW_report_assert

Definition in file formatmodifier.h.