PAPRECA hybrid off-lattice kMC/MD simulator  2.0.0 (17 September 2024)
PAPRECA::File Class Reference

General parent file class. Any PAPRECA export file should be a child to this class. More...

#include <export_files.h>

Inheritance diagram for PAPRECA::File:

Public Member Functions

 File ()
 
 File (const int &print_freq_in)
 
virtual ~File ()
 
virtual void close ()
 
void setActive ()
 
void setIncative ()
 
const bool isActive () const
 
void setPrintFreq (const int &print_freq_in)
 
const int getPrintFreq () const
 

Protected Attributes

std::ofstream file
 
bool is_active = false
 
int print_freq = 0
 

Friends

class PaprecaConfig
 

Detailed Description

General parent file class. Any PAPRECA export file should be a child to this class.

Constructor & Destructor Documentation

◆ File() [1/2]

PAPRECA::File::File ( )

◆ File() [2/2]

PAPRECA::File::File ( const int &  print_freq_in)

◆ ~File()

PAPRECA::File::~File ( )
virtual

Member Function Documentation

◆ close()

void PAPRECA::File::close ( )
virtual

Reimplemented in PAPRECA::ExecTime.

◆ getPrintFreq()

const int PAPRECA::File::getPrintFreq ( ) const

◆ isActive()

const bool PAPRECA::File::isActive ( ) const

◆ setActive()

void PAPRECA::File::setActive ( )

◆ setIncative()

void PAPRECA::File::setIncative ( )

◆ setPrintFreq()

void PAPRECA::File::setPrintFreq ( const int &  print_freq_in)

Friends And Related Function Documentation

◆ PaprecaConfig

friend class PaprecaConfig
friend

Member Data Documentation

◆ file

std::ofstream PAPRECA::File::file
protected

◆ is_active

bool PAPRECA::File::is_active = false
protected

◆ print_freq

int PAPRECA::File::print_freq = 0
protected

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