OpenMesh::IO::BaseReader Class Reference

#include <BaseReader.hh>

Inheritance diagram for OpenMesh::IO::BaseReader:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool can_u_read (const std::string &_filename) const
 Returns true if reader can parse _filename (checks extension).
virtual std::string get_description () const =0
 Returns a brief description of the file type that can be parsed.
virtual std::string get_extensions () const =0
virtual std::string get_magic () const
 Return magic bits used to determine file format.
virtual bool read (std::istream &_is, BaseImporter &_bi, Options &_opt)=0
virtual bool read (const std::string &_filename, BaseImporter &_bi, Options &_opt)=0
virtual ~BaseReader ()
 Destructor.

Protected Member Functions

bool check_extension (const std::string &_fname, const std::string &_ext) const

Detailed Description

Base class for reader modules. Reader modules access persistent data and pass them to the desired data structure by the means of a BaseImporter derivative. All reader modules must be derived from this class.

Definition at line 84 of file BaseReader.hh.


Constructor & Destructor Documentation

virtual OpenMesh::IO::BaseReader::~BaseReader (  )  [inline, virtual]

Destructor.

Definition at line 89 of file BaseReader.hh.


Member Function Documentation

virtual bool OpenMesh::IO::BaseReader::can_u_read ( const std::string &  _filename  )  const [virtual]

Returns true if reader can parse _filename (checks extension).

Reimplemented in OpenMesh::IO::_OFFReader_, OpenMesh::IO::_OMReader_, and OpenMesh::IO::_PLYReader_.

bool OpenMesh::IO::BaseReader::check_extension ( const std::string &  _fname,
const std::string &  _ext 
) const [protected]
virtual std::string OpenMesh::IO::BaseReader::get_description (  )  const [pure virtual]

Returns a brief description of the file type that can be parsed.

Implemented in OpenMesh::IO::_OBJReader_, OpenMesh::IO::_OFFReader_, OpenMesh::IO::_OMReader_, OpenMesh::IO::_PLYReader_, and OpenMesh::IO::_STLReader_.

virtual std::string OpenMesh::IO::BaseReader::get_extensions (  )  const [pure virtual]

Returns a string with the accepted file extensions separated by a whitespace and in small caps.

Implemented in OpenMesh::IO::_OBJReader_, OpenMesh::IO::_OFFReader_, OpenMesh::IO::_OMReader_, OpenMesh::IO::_PLYReader_, and OpenMesh::IO::_STLReader_.

virtual std::string OpenMesh::IO::BaseReader::get_magic (  )  const [inline, virtual]

Return magic bits used to determine file format.

Reimplemented in OpenMesh::IO::_OFFReader_, OpenMesh::IO::_OMReader_, and OpenMesh::IO::_PLYReader_.

Definition at line 100 of file BaseReader.hh.

virtual bool OpenMesh::IO::BaseReader::read ( std::istream &  _is,
BaseImporter _bi,
Options _opt 
) [pure virtual]

Reads a mesh given by a std::stream. This method usually uses the same stream reading method that read uses. Options can be passed via _opt. After execution _opt contains the Options that were available

Implemented in OpenMesh::IO::_OBJReader_, OpenMesh::IO::_OFFReader_, OpenMesh::IO::_OMReader_, OpenMesh::IO::_PLYReader_, and OpenMesh::IO::_STLReader_.

virtual bool OpenMesh::IO::BaseReader::read ( const std::string &  _filename,
BaseImporter _bi,
Options _opt 
) [pure virtual]

Reads a mesh given by a filename. Usually this method opens a stream and passes it to stream read method. Acceptance checks by filename extension can be placed here.

Options can be passed via _opt. After execution _opt contains the Options that were available

Implemented in OpenMesh::IO::_OBJReader_, OpenMesh::IO::_OFFReader_, OpenMesh::IO::_OMReader_, OpenMesh::IO::_PLYReader_, and OpenMesh::IO::_STLReader_.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


openmesh
Author(s): Benjamin Pitzer
autogenerated on Fri Jan 11 12:11:18 2013