- Main Page
- Modules
- Namespaces
- Classes
- Files
- Related Pages

- Class List
- Class Hierarchy
- Class Members

# OpenMesh::IO::BaseReader Class Reference

Base class for reader modules. More...

`#include <BaseReader.hh>`

Inheritance diagram for OpenMesh::IO::BaseReader:

List of all members.

## Public Member Functions
virtual | ~BaseReader ()
| Destructor.
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
| Returns a string with the accepted file extensions separated by a whitespace and in small caps.
virtual std::string | get_magic () const
| Return magic bits used to determine file format.
virtual bool | read (const std::string &_filename, BaseImporter &_bi, Options &_opt)=0
| Reads a mesh given by a filename.
virtual bool | can_u_read (const std::string &_filename) const
| Returns true if reader can parse _filename (checks extension).

## 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.

## Member Function Documentation

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.

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

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

- Core/IO/reader/BaseReader.hh
- Core/IO/reader/BaseReader.cc