File.h File Reference

#include <fstream>
#include <cstdlib>

Go to the source code of this file.

Classes
class	File

Enumerations
enum	FileType : unsigned char { FileType::NO_FILE = 0, FileType::ONE_FILE = 1, FileType::MULTIPLE_FILES = 2, FileType::MULTIPLE_FILES_PADDED = 3 }
	With FileType options, one is able to choose if data is to be read/written from/into no or single or multiple files. More...

Functions
std::string	to_string_padded (unsigned int value)
	Pads the number This function tries to pad the number to 4 digits, which is used when you create multiple files with padded numbers. Any numbers larger than 4 digits return unmodified. More...
std::ostream &	operator<< (std::ostream &os, FileType fileType)
	Writes the FileType as a human-readable string into the output stream 'os'. More...
std::istream &	operator>> (std::istream &is, FileType &fileType)
	Reads the FileType from an input stream 'is'. More...

Enumeration Type Documentation

enum FileType : unsigned char

strong

With FileType options, one is able to choose if data is to be read/written from/into no or single or multiple files.

Enumerator
NO_FILE	file will not be created/read
ONE_FILE	all data will be written into/ read from a single file called name_
MULTIPLE_FILES	each time-step will be written into/read from separate files numbered consecutively: name_.0, name_.1, .. so on
MULTIPLE_FILES_PADDED	each time-step will be written into/read from separate files numbered consecutively, with numbers padded by zeros to a minimum of four digits: name_.0000, name_.0001, ..

Definition at line 35 of file File.h.

                    : unsigned char
{
    NO_FILE = 0,
    ONE_FILE = 1,
    MULTIPLE_FILES = 2,
    MULTIPLE_FILES_PADDED = 3
};

Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		FileType	fileType
	)

Writes the FileType as a human-readable string into the output stream 'os'.

Parameters

[in,out]	os	output stream to which the fileType is written
[in]	fileType	the fileType that has to be written to the output stream

Returns

the output stream "os" that is returned after adding the fileType string

Definition at line 72 of file File.cc.

References MULTIPLE_FILES, MULTIPLE_FILES_PADDED, NO_FILE, and ONE_FILE.

{
    if (fileType == FileType::NO_FILE)
        os << "NO_FILE";
    else if (fileType == FileType::ONE_FILE)
        os << "ONE_FILE";
    else if (fileType == FileType::MULTIPLE_FILES)
        os << "MULTIPLE_FILES";
    else if (fileType == FileType::MULTIPLE_FILES_PADDED)
        os << "MULTIPLE_FILES_PADDED";
    else
    {
        std::cerr << "FileType not recognized" << std::endl;
        exit(-1);
    }
    return os;
}

std::istream& operator>>	(	std::istream &	is,
		FileType &	fileType
	)

Reads the FileType from an input stream 'is'.

Parameters

[in,out]	is	The input stream from which the fileType is read
[in]	fileType	The fileType that has to be read from the input stream

Returns

the input stream "is" (that is returned after the fileType string is read out)

Definition at line 95 of file File.cc.

References MULTIPLE_FILES, MULTIPLE_FILES_PADDED, NO_FILE, and ONE_FILE.

{
    std::string fileTypeString;
    is >> fileTypeString;
    if (!fileTypeString.compare("NO_FILE"))
        fileType = FileType::NO_FILE;
    else if (!fileTypeString.compare("ONE_FILE"))
        fileType = FileType::ONE_FILE;
    else if (!fileTypeString.compare("MULTIPLE_FILES"))
        fileType = FileType::MULTIPLE_FILES;
    else if (!fileTypeString.compare("MULTIPLE_FILES_PADDED"))
        fileType = FileType::MULTIPLE_FILES_PADDED;
    else
    {
        std::cerr << "FileType not recognized" << std::endl;
        exit(-1);
    }
    return is;
}

std::string to_string_padded

(

unsigned int

value

)

Pads the number This function tries to pad the number to 4 digits, which is used when you create multiple files with padded numbers. Any numbers larger than 4 digits return unmodified.

Todo:

TW: I am not able to define the operator >> for enum class type (the implementation works fine for the old enum)

Parameters

value

The value to modify

Returns

A padded string

Definition at line 60 of file File.cc.

Referenced by DPMBase::readNextArgument().

{
    std::ostringstream out;
    out << std::setw(4) << std::setfill('0') << value;
    return out.str();
}