 |
NumeRe v1.1.4
NumeRe: Framework für Numerische Rechnungen
|
|
NumeRe v1.1.4
NumeRe: Framework für Numerische Rechnungen
|
This class resembles an Excel (97) workbook (*.xls), which is composed out of a compound file. Reading and writing is done using the BasicExcel library. More...
#include <file.hpp>
Public Member Functions | |
| XLSSpreadSheet (const std::string &filename) | |
| virtual | ~XLSSpreadSheet () |
| virtual bool | read () override |
| Pure virtual declaration of the read access method. Has to be implemented in all derived classes and can be used to read the contents of the file to memory. More... | |
| virtual bool | write () override |
| Pure virtual declaration of the write access method. Has to be implemented in all derived classes and can be used to write the contents in memory to the target file. More... | |
 Public Member Functions inherited from NumeRe::GenericFile | |
| GenericFile (const std::string &fileName) | |
| Constructor from filename. More... | |
| GenericFile (const GenericFile &file) | |
| Copy constructor. More... | |
| virtual | ~GenericFile () |
| Virtual destructor: we'll work with instances on the heap, therefore we'll need virtual declared destructors. This destructor will clear the internal memory and closes the file stream, if it is still open. More... | |
| bool | is_open () |
| Wrapper for fstream::is_open() More... | |
| void | close () |
| Wrapper for fstream::close(). Will also clear the internal memory. More... | |
| bool | good () |
| Wrapper for fstream::good() More... | |
| size_t | tellg () |
| Wrapper for fstream::tellg() More... | |
| size_t | tellp () |
| Wrapper for fstream::tellp() More... | |
| void | seekg (size_t pos) |
| Wrapper for fstream::seekg() with start from the beginning of the stream. More... | |
| void | seekp (size_t pos) |
| Wrapper for fstream::seekp() with start from the beginning of the stream. More... | |
| std::string | getExtension () |
| Returns the file extension. More... | |
| std::string | getFileName () |
| Returns the file name. More... | |
| std::string | getTableName () |
| Returns the table name referenced in the file. Will default to the file name with non-alnum characters replaced with underscores, if the file does not reference a table name by itself. More... | |
| std::string | getComment () |
| Returns the comment stored with the referenced file. More... | |
| void | setComment (const std::string &comment) |
| Sets the comment to be written to the referencedfile. More... | |
| long long int | getRows () |
| Returns the number of rows. More... | |
| long long int | getCols () |
| Returns the number of columns. More... | |
| virtual FileHeaderInfo | getFileHeaderInformation () |
| Returns the file header information structure. More... | |
| virtual bool | read ()=0 |
| Pure virtual declaration of the read access method. Has to be implemented in all derived classes and can be used to read the contents of the file to memory. More... | |
| virtual bool | write ()=0 |
| Pure virtual declaration of the write access method. Has to be implemented in all derived classes and can be used to write the contents in memory to the target file. More... | |
| GenericFile & | operator= (const GenericFile &file) |
| Assignment operator definition. More... | |
| void | getData (TableColumnArray *data) |
| This method copies the internal data to the passed memory address. The target memory must already exist. More... | |
| TableColumnArray * | getData (long long int &rows, long long int &cols) |
| This method returns a pointer to the internal memory with read and write access. This pointer shall not stored for future use, because the referenced memory will be deleted upon destruction of this class instance. More... | |
| void | setDimensions (long long int rows, long long int cols) |
| Sets the dimensions of the data table, which will be used in the future. Clears the internal memory in advance. More... | |
| void | setTableName (const std::string &name) |
| Set the table's name. More... | |
| void | setTextfilePrecision (unsigned short nPrecision) |
| Set the precision, which shall be used to convert the floating point numbers into strings. More... | |
| void | addData (TableColumnArray *data, long long int rows, long long int cols) |
| This method created the internal storage and copies the passed data to this storage. More... | |
| void | setData (TableColumnArray *data, long long int rows, long long int cols) |
| This method refernces the passed external data internally. The data is not copied and must exist as long as thos class exists. More... | |
| Public Member Functions inherited from FileSystem | |
| FileSystem () | |
| Default constructor. More... | |
| FileSystem & | assign (const FileSystem &_fSys) |
| Assignment member function to copy the settings from another FileSystem instance. More... | |
| std::string | ValidFileName (std::string _sFileName, const std::string sExtension=".dat", bool checkExtension=true, bool doCleanPath=true) const |
| This member function evaluates, whether the passed filename is a valid filename. One may supply a preferred filename extension. More... | |
| std::string | ValidFolderName (std::string _sFileName, bool doCleanPath=true, bool appendTrailingSeparator=true) const |
| This member function evaluates, whether the passed foldername is a valid foldername. More... | |
| std::string | ValidizeAndPrepareName (const std::string &_sFileName, const std::string &sExtension=".dat") const |
| This member function validizes the passed file name and creates the needed folders on-the-fly. More... | |
| int | setPath (std::string _sPath, bool bMkDir, std::string _sExePath) |
| This member function may be used to set the preferred file path of the current FileSystem instance. More... | |
| void | createRevisionsFolder () |
| This member function creates the hidden revisions folders for the version control system. More... | |
| std::string | getPath () const |
| Returns the default path of this FileSystem instance. More... | |
| std::vector< std::string > | getFileParts (const std::string &sFilePath) const |
| This member function separates all path parts into single strings: the drive letter, the path, the name and the extension. This function may also handle folder paths and network paths. More... | |
| FileInfo | getFileInfo (const std::string &sFilePath) const |
| Return the file information about the passed file path. More... | |
| void | setTokens (std::string _sTokens) |
| This member function may be used to update the path placeholders of the current FileSystem instance. More... | |
| bool | isFile (const std::string &_sPath) const |
| This function determines, whether a path name indicates a file or a folder. More... | |
| void | initializeFromKernel () |
| Member function to remote-initialize the class from the kernel. Cannot be used during kernel start-up. More... | |
| void | setProgramPath (std::string _sExePath) |
| std::string | getProgramPath () const |
| void | declareFileType (const std::string &sFileType) |
Private Member Functions | |
| void | readFile () |
| This member function is used to read the data from the XLS spreadsheet ino the internal storage. More... | |
| void | writeFile () |
| This member function is used to write the data in the internal storage to the target XLS spreadsheet. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from NumeRe::GenericFile | |
| void | open (std::ios::openmode mode) |
| This method has to be used to open the target file in stream mode. If the file cannot be opened, this method throws an error. More... | |
| void | stripTrailingSpaces (std::string &_sToStrip) |
| This method strips trailing spaces from the passed string. More... | |
| void | replaceDecimalSign (std::string &_sToReplace) |
| This method simply replaces commas with dots in the passed string to enable correct parsing into a double. More... | |
| void | replaceTabSign (std::string &_sToReplace, bool bAddPlaceholders=false) |
| This method replaces tabulator characters with whitespaces to simplify the column determination (the used tokenizer will only have to consider whitespaces as separator characters). Sometimes, replacing tabulators into whitespaces will destroy column information. To avoid this, placeholders (underscores) may be inserted as "empty" column cells. More... | |
| std::pair< size_t, size_t > | calculateCellExtents (const std::string &sContents) |
| This method calculates the extents of the passed string, if it is used as a table column headlines. This method will return a std::pair<> with the maximal number of characters in a line in the first and the number of lines in the second component. More... | |
| std::string | getLineFromHead (long long int nCol, size_t nLineNumber) |
| This method gets the selected line number from the table column headline in the selected column. If the selected text does not contain enough lines, a simple whitespaces is returned. More... | |
| template<typename T > | |
| T | readNumField () |
| This method is a template fo reading a numeric field of the selected template type in binary mode. More... | |
| std::string | readStringField () |
| This mehtod can be used to read a string field from the file in binary mode. More... | |
| std::string | getZipFileItem (const std::string &filename) |
| This method may be used to get the contents of an embedded file in a zipfile and return the contents as string. More... | |
| template<typename T > | |
| T * | readNumBlock (long long int &size) |
| This method template is for reading a block of numeric data into memory in binary mode. More... | |
| template<typename T > | |
| T ** | readDataArray (long long int &rows, long long int &cols) |
| This method template is for reading a whole two-dimensional array of data into memory in binary mode. More... | |
| std::string * | readStringBlock (long long int &size) |
| This method can be used for reading a block of string data to memory in binary mode. More... | |
| std::vector< std::string > | readTextFile (bool stripEmptyLines) |
| This method may be used to read the file in text mode and to obtain the data as a vector. More... | |
| std::vector< std::string > | tokenize (std::string sString, const std::string &sSeparators, bool skipEmptyTokens=false) |
| This method may be used to separater a line into multiple tokens using a set of separator characters. If empty token shall be skipped, then only tokens with a non-zero length are stored. More... | |
| template<typename T > | |
| void | writeNumField (T num) |
| This method template can be used to write a numeric value to file in binary mode. More... | |
| void | writeStringField (const std::string &sString) |
| This method may be used to write a string to file in binary mode. More... | |
| template<typename T > | |
| void | writeNumBlock (T *data, long long int size) |
| This method template may be used to write a block of data of the selected type to the file in binary mode. More... | |
| template<typename T > | |
| void | writeDataArray (T **data, long long int rows, long long int cols) |
| This method may be used to write a two-dimensional array of data to the file in binary mode. More... | |
| void | writeStringBlock (std::string *data, long long int size) |
| This method may be used to write a block of strings into the file in binary mode. More... | |
| void | createStorage () |
| This method prepares the internal storage, so that it may contain the read data. This method is only used for textual files. More... | |
| void | clearStorage () |
| This method cleares the internal storage. This method is called by the destructor automatically. More... | |
| template<typename T > | |
| void | copyDataArray (T **from, T **to, long long int rows, long long int cols) |
| This method may be used to copy two- dimensional arrays of data. Both source and target arrays have to exist in advance. More... | |
| void | copyStringArray (std::string *from, std::string *to, long long int nElements) |
| This method may be used to copy string arrays. Both source and target arrays have to exist in advance. More... | |
| template<typename T > | |
| void | copyArray (T *from, T *to, long long int nElements) |
| This method template may be used to copy arrays of data of the selected type. Both source and target arrays have to exist in advance. More... | |
| bool | isNumeric (const std::string &sString) |
| This method may be used to determine, whether a string contains only numeric data. More... | |
| void | assign (const GenericFile &file) |
| This method is used by the assignment operator and the copy constructor to copy the contents of the passed GenericFile instance. More... | |
| Protected Member Functions inherited from FileSystem | |
| int | createFolders (const std::string &_sPath) const |
| This member function creates all missing directories in the passed path. More... | |
| Protected Attributes inherited from NumeRe::GenericFile | |
| std::fstream | fFileStream |
| std::string | sFileExtension |
| std::string | sFileName |
| std::string | sTableName |
| std::string | sComment |
| long long int | nRows |
| long long int | nCols |
| unsigned short | nPrecFields |
| bool | useExternalData |
| std::ios::openmode | openMode |
| TableColumnArray * | fileData |
| Protected Attributes inherited from FileSystem | |
| std::string | sPath |
| std::string | sExecutablePath |
| std::string | sTokens [7][2] |
| std::string | sValidExtensions |
This class resembles an Excel (97) workbook (*.xls), which is composed out of a compound file. Reading and writing is done using the BasicExcel library.
| NumeRe::XLSSpreadSheet::XLSSpreadSheet | ( | const std::string & | filename | ) |
|
inlineoverridevirtual |
Pure virtual declaration of the read access method. Has to be implemented in all derived classes and can be used to read the contents of the file to memory.
Implements NumeRe::GenericFile.
Definition at line 1828 of file file.hpp.
References readFile().
|
private |
This member function is used to read the data from the XLS spreadsheet ino the internal storage.
Definition at line 3723 of file file.cpp.
References SyntaxError::CANNOT_READ_FILE, YExcel::BasicExcelWorksheet::Cell(), NumeRe::GenericFile::createStorage(), YExcel::BasicExcelCell::DOUBLE, NumeRe::GenericFile::fileData, YExcel::BasicExcelCell::GetDouble(), YExcel::BasicExcelCell::GetInteger(), YExcel::BasicExcelCell::GetString(), YExcel::BasicExcelWorksheet::GetTotalCols(), YExcel::BasicExcelWorksheet::GetTotalRows(), YExcel::BasicExcel::GetTotalWorkSheets(), YExcel::BasicExcel::GetWorksheet(), YExcel::BasicExcelCell::GetWString(), YExcel::BasicExcelCell::INT, SyntaxError::invalid_position, YExcel::BasicExcel::Load(), NumeRe::GenericFile::nCols, NumeRe::GenericFile::nRows, NumeRe::GenericFile::sFileName, YExcel::BasicExcelCell::STRING, YExcel::BasicExcelCell::Type(), YExcel::BasicExcelCell::UNDEFINED, utf8parser(), wcstombs(), and YExcel::BasicExcelCell::WSTRING.
Referenced by read().
|
inlineoverridevirtual |
Pure virtual declaration of the write access method. Has to be implemented in all derived classes and can be used to write the contents in memory to the target file.
Implements NumeRe::GenericFile.
Definition at line 1834 of file file.hpp.
References writeFile().
|
private |
This member function is used to write the data in the internal storage to the target XLS spreadsheet.
Definition at line 3911 of file file.cpp.
References YExcel::BasicExcelWorksheet::Cell(), YExcel::BasicExcelCell::EraseContents(), NumeRe::GenericFile::fileData, NumeRe::GenericFile::getTableName(), YExcel::BasicExcel::GetWorksheet(), NumeRe::GenericFile::nCols, YExcel::BasicExcel::New(), NumeRe::GenericFile::nRows, YExcel::BasicExcel::RenameWorksheet(), YExcel::BasicExcel::SaveAs(), YExcel::BasicExcelCell::SetDouble(), YExcel::BasicExcelCell::SetString(), NumeRe::GenericFile::sFileName, TableColumn::TYPE_LOGICAL, and TableColumn::TYPE_VALUE.
Referenced by write().
1.9.3