OpenStructure
Public Member Functions | Static Public Member Functions
MapIODxHandler Class Reference

#include <map_io_dx_handler.hh>

Inherits MapIOHandler, and MapIOHandler.

Public Member Functions

virtual void Import (img::MapHandle &sh, const boost::filesystem::path &loc, const ImageFormatBase &formatstruct)
 
virtual void Import (img::MapHandle &sh, std::istream &loc, const ImageFormatBase &formatstruct)
 
virtual void Export (const img::MapHandle &sh, const boost::filesystem::path &loc, const ImageFormatBase &formatstruct) const
 
virtual void Export (const img::MapHandle &sh, std::ostream &loc, const ImageFormatBase &formatstruct) const
 
virtual void Import (img::MapHandle &sh, const boost::filesystem::path &loc, const ImageFormatBase &formatstruct)
 
virtual void Import (img::MapHandle &sh, std::istream &loc, const ImageFormatBase &formatstruct)
 
virtual void Export (const img::MapHandle &sh, const boost::filesystem::path &loc, const ImageFormatBase &formatstruct) const
 
virtual void Export (const img::MapHandle &sh, std::ostream &loc, const ImageFormatBase &formatstruct) const
 
- Public Member Functions inherited from MapIOHandler
virtual ~MapIOHandler ()
 
virtual ~MapIOHandler ()
 

Static Public Member Functions

static bool MatchContent (unsigned char *header)
 
static bool MatchType (const ImageFormatBase &type)
 
static bool MatchSuffix (const String &locx)
 
static bool ProvidesImport ()
 
static bool ProvidesExport ()
 
static String GetFormatName ()
 
static String GetFormatDescription ()
 
static bool MatchContent (unsigned char *header)
 
static bool MatchType (const ImageFormatBase &type)
 
static bool MatchSuffix (const String &locx)
 
static bool ProvidesImport ()
 
static bool ProvidesExport ()
 
static String GetFormatName ()
 
static String GetFormatDescription ()
 

Detailed Description

Definition at line 45 of file map_io_dx_handler.hh.

Member Function Documentation

◆ Export() [1/4]

virtual void Export ( const img::MapHandle &  sh,
const boost::filesystem::path &  loc,
const ImageFormatBase &  formatstruct 
) const
virtual

Implements MapIOHandler.

◆ Export() [2/4]

virtual void Export ( const img::MapHandle &  sh,
const boost::filesystem::path &  loc,
const ImageFormatBase &  formatstruct 
) const
virtual

Implements MapIOHandler.

◆ Export() [3/4]

virtual void Export ( const img::MapHandle &  sh,
std::ostream &  loc,
const ImageFormatBase &  formatstruct 
) const
virtual

Implements MapIOHandler.

◆ Export() [4/4]

virtual void Export ( const img::MapHandle &  sh,
std::ostream &  loc,
const ImageFormatBase &  formatstruct 
) const
virtual

Implements MapIOHandler.

◆ GetFormatDescription() [1/2]

static String GetFormatDescription ( )
inlinestatic

Definition at line 70 of file map_io_dx_handler.hh.

◆ GetFormatDescription() [2/2]

static String GetFormatDescription ( )
inlinestatic

Definition at line 70 of file map_io_dx_handler.hh.

◆ GetFormatName() [1/2]

static String GetFormatName ( )
inlinestatic

Definition at line 69 of file map_io_dx_handler.hh.

◆ GetFormatName() [2/2]

static String GetFormatName ( )
inlinestatic

Definition at line 69 of file map_io_dx_handler.hh.

◆ Import() [1/4]

virtual void Import ( img::MapHandle &  sh,
const boost::filesystem::path &  loc,
const ImageFormatBase &  formatstruct 
)
virtual

Map IO handler to read/write APBS map files (in OpenDX format)

This map IO handler reads and writes OpenDX formatted map files, as generated by APBS for example. Only the information needed to construct an OpenStructure map are read from the file (i.e. grid size (in x,y,z), grid spacing (in x,y,z) grid origin (in x,y,z) and the actual values for each grid point. The other lines are ignored. Thus, when writing the grid to a file, not exactly the same file is produced.

Implements MapIOHandler.

◆ Import() [2/4]

virtual void Import ( img::MapHandle &  sh,
const boost::filesystem::path &  loc,
const ImageFormatBase &  formatstruct 
)
virtual

Map IO handler to read/write APBS map files (in OpenDX format)

This map IO handler reads and writes OpenDX formatted map files, as generated by APBS for example. Only the information needed to construct an OpenStructure map are read from the file (i.e. grid size (in x,y,z), grid spacing (in x,y,z) grid origin (in x,y,z) and the actual values for each grid point. The other lines are ignored. Thus, when writing the grid to a file, not exactly the same file is produced.

Implements MapIOHandler.

◆ Import() [3/4]

virtual void Import ( img::MapHandle &  sh,
std::istream &  loc,
const ImageFormatBase &  formatstruct 
)
virtual

Implements MapIOHandler.

◆ Import() [4/4]

virtual void Import ( img::MapHandle &  sh,
std::istream &  loc,
const ImageFormatBase &  formatstruct 
)
virtual

Implements MapIOHandler.

◆ MatchContent() [1/2]

static bool MatchContent ( unsigned char *  header)
static

◆ MatchContent() [2/2]

static bool MatchContent ( unsigned char *  header)
static

◆ MatchSuffix() [1/2]

static bool MatchSuffix ( const String &  locx)
static

◆ MatchSuffix() [2/2]

static bool MatchSuffix ( const String &  locx)
static

◆ MatchType() [1/2]

static bool MatchType ( const ImageFormatBase &  type)
static

◆ MatchType() [2/2]

static bool MatchType ( const ImageFormatBase &  type)
static

◆ ProvidesExport() [1/2]

static bool ProvidesExport ( )
inlinestatic

Definition at line 67 of file map_io_dx_handler.hh.

◆ ProvidesExport() [2/2]

static bool ProvidesExport ( )
inlinestatic

Definition at line 67 of file map_io_dx_handler.hh.

◆ ProvidesImport() [1/2]

static bool ProvidesImport ( )
inlinestatic

Definition at line 66 of file map_io_dx_handler.hh.

◆ ProvidesImport() [2/2]

static bool ProvidesImport ( )
inlinestatic

Definition at line 66 of file map_io_dx_handler.hh.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1