Mechanics of Defect Evolution Library
Loading...
Searching...
No Matches
model::IDreader< keySize, valueSize, T > Class Template Reference

A class template. More...

#include <IDreader.h>

Inheritance diagram for model::IDreader< keySize, valueSize, T >:
Collaboration diagram for model::IDreader< keySize, valueSize, T >:

Public Member Functions

 IDreader (const std::string &fileNamePrefix_in)
void readLabelsFile (const std::string &labelsFileName)
const T & operator() (const KeyType &key, const std::string &label)
const T & first (const std::string &label)
const T & last (const std::string &label)
std::string getFilename (const long long int &frameN, const bool &useTXT) const
bool isGood (const long long int &frameN, const bool &useTXT) const
bool read (const long long int &frameN, const bool &useTXT)

Public Attributes

const std::string fileNamePrefix

Detailed Description

template<int keySize, int valueSize, typename T>
class model::IDreader< keySize, valueSize, T >

A class template.

Definition at line 54 of file IDreader.h.

Constructor & Destructor Documentation

◆ IDreader()

template<int keySize, int valueSize, typename T>
model::IDreader< keySize, valueSize, T >::IDreader ( const std::string & fileNamePrefix_in)
inline

Constructor initializes currentFrame to -1 so that the statement frameN!=currentFrame will initially return false

Definition at line 164 of file IDreader.h.

Member Function Documentation

◆ first()

template<int keySize, int valueSize, typename T>
const T & model::IDreader< keySize, valueSize, T >::first ( const std::string & label)
inline

Definition at line 220 of file IDreader.h.

◆ getFilename()

template<int keySize, int valueSize, typename T>
std::string model::IDreader< keySize, valueSize, T >::getFilename ( const long long int & frameN,
const bool & useTXT ) const
inline

Definition at line 238 of file IDreader.h.

◆ isGood()

template<int keySize, int valueSize, typename T>
bool model::IDreader< keySize, valueSize, T >::isGood ( const long long int & frameN,
const bool & useTXT ) const
inline

Checks whether the file named "E/E_ \param[frameN] .txt" is good for reading.

Definition at line 255 of file IDreader.h.

◆ last()

template<int keySize, int valueSize, typename T>
const T & model::IDreader< keySize, valueSize, T >::last ( const std::string & label)
inline

Definition at line 229 of file IDreader.h.

◆ operator()()

template<int keySize, int valueSize, typename T>
const T & model::IDreader< keySize, valueSize, T >::operator() ( const KeyType & key,
const std::string & label )
inline

Definition at line 210 of file IDreader.h.

◆ read()

template<int keySize, int valueSize, typename T>
bool model::IDreader< keySize, valueSize, T >::read ( const long long int & frameN,
const bool & useTXT )
inline
Parameters
[in]frameNthe frame number to be read
[in]useTXTif true text files (.txt) are read, otherwise binary files (.bin) are read
Returns
true if the file has been read correctly

Definition at line 264 of file IDreader.h.

◆ readLabelsFile()

template<int keySize, int valueSize, typename T>
void model::IDreader< keySize, valueSize, T >::readLabelsFile ( const std::string & labelsFileName)
inline

Definition at line 174 of file IDreader.h.

Member Data Documentation

◆ fileNamePrefix

template<int keySize, int valueSize, typename T>
const std::string model::IDreader< keySize, valueSize, T >::fileNamePrefix

Definition at line 152 of file IDreader.h.


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