Mesh Oriented datABase  (version 5.5.1)
An array-based unstructured mesh library
moab::ReaderIface Class Referenceabstract

Interface for mesh reader implementations. More...

#include <ReaderIface.hpp>

+ Inheritance diagram for moab::ReaderIface:

Classes

struct  IDTag
 
struct  SubsetList
 

Public Member Functions

virtual ~ReaderIface ()
 
virtual ErrorCode load_file (const char *file_name, const EntityHandle *file_set, const FileOptions &opts, const SubsetList *subset_list=0, const Tag *file_id_tag=0)=0
 Load mesh from a file. More...
 
virtual ErrorCode read_tag_values (const char *file_name, const char *tag_name, const FileOptions &opts, std::vector< int > &tag_values_out, const SubsetList *subset_list=0)=0
 Read tag values from a file. More...
 

Detailed Description

Interface for mesh reader implementations.

Version
1.00
Date
2004-4-23
Author
Jason Kraftcheck

Definition at line 34 of file ReaderIface.hpp.

Constructor & Destructor Documentation

◆ ~ReaderIface()

virtual moab::ReaderIface::~ReaderIface ( )
inlinevirtual

Definition at line 37 of file ReaderIface.hpp.

37 {}

Member Function Documentation

◆ load_file()

virtual ErrorCode moab::ReaderIface::load_file ( const char *  file_name,
const EntityHandle file_set,
const FileOptions opts,
const SubsetList subset_list = 0,
const Tag file_id_tag = 0 
)
pure virtual

Load mesh from a file.

Method all readers must provide to import a mesh.

Parameters
file_nameThe file to read.
file_setOptional pointer to entity set representing file. If this is not NULL, reader may optionally tag the pointed-to set with format-specific meta-data.
subset_listAn optional struct pointer specifying the tags identifying entity sets to be read.
file_id_tagIf specified, reader should store for each entity it reads, a unique integer ID for this tag.
Author
Jason Kraftcheck

Implemented in moab::ReadNC, moab::Tqdcfr, moab::ReadVtk, moab::ReadTetGen, moab::ReadTemplate, moab::ReadSTL, moab::ReadSms, moab::ReadSmf, moab::ReadRTT, moab::ReadOBJ, moab::ReadNCDF, moab::ReadNASTRAN, moab::ReadMCNP5, moab::ReadIDEAS, moab::ReadHDF5, moab::ReadGmsh, moab::ReadDamsel, moab::ReadCGNS, moab::ReadCCMIO, and moab::ReadABAQUS.

Referenced by moab::Core::serial_load_file().

◆ read_tag_values()

virtual ErrorCode moab::ReaderIface::read_tag_values ( const char *  file_name,
const char *  tag_name,
const FileOptions opts,
std::vector< int > &  tag_values_out,
const SubsetList subset_list = 0 
)
pure virtual

Read tag values from a file.

Read the list if all integer tag values from the file for a tag that is a single integer value per entity.

Parameters
file_nameThe file to read.
tag_nameThe tag for which to read values
tag_values_outOutput: The list of tag values.
subset_listAn array of tag name and value sets specifying the subset of the file to read. If multiple tags are specified, the sets that match all tags (intersection) should be read.
subset_list_lengthThe length of the 'subset_list' array.

Implemented in moab::ReadNC, moab::Tqdcfr, moab::ReadVtk, moab::ReadTetGen, moab::ReadTemplate, moab::ReadSTL, moab::ReadSms, moab::ReadSmf, moab::ReadRTT, moab::ReadOBJ, moab::ReadNCDF, moab::ReadNASTRAN, moab::ReadMCNP5, moab::ReadIDEAS, moab::ReadHDF5, moab::ReadGmsh, moab::ReadDamsel, moab::ReadCGNS, moab::ReadCCMIO, and moab::ReadABAQUS.

Referenced by moab::Core::serial_read_tag().


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