MDAL
Public Member Functions | Static Public Member Functions | Friends | List of all members
MDAL::SelafinFile Class Reference

This class is used to read the selafin file format. More...

#include <mdal_selafin.hpp>

Public Member Functions

 SelafinFile (const std::string &fileName)
 Constructor.
 
std::string readHeader ()
 Read the header of the file and return the project name.
 
bool addDatasetGroup (DatasetGroup *datasetGroup)
 Add the dataset group to the file (persist), replace dataset in the new group by Selafindataset with lazy loading.
 

Static Public Member Functions

static std::unique_ptr< MeshcreateMesh (const std::string &fileName)
 Returns a mesh created with the file.
 
static void populateDataset (Mesh *mesh, const std::string &fileName)
 Populates the mesh with dataset from the file.
 

Friends

class MeshSelafin
 
class MeshSelafinVertexIterator
 
class MeshSelafinFaceIterator
 
class DatasetSelafin
 

Detailed Description

This class is used to read the selafin file format.

The file is opened with initialize() and stay opened until this object is destroyed

Note
SelafinFile object is shared between different datasets, with the mesh and its iterators. As SelafinFile is not thread safe, it has to be shared in the same thread.

This class can be used to create a mesh with all the dataset contained in a file with the static method createMessh() It is also pĂ´ssible to add all the dataset of a file in a separate existing mesh with the static method populateDataset()

All the method to access with lazy loading to the mesh data or datasets are encapsulted and only accessible by the friend classes : MeshSelafin MeshSelafinVertexIterator MeshSelafinFaceIterator DatasetSelafin

This ecapsulation protects these lazy loading access methods because they can't be used before the instance of SelafinFile has been initialized and parsed.


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