#include <MercuryData.h>

Public Member Functions
bool	operator!= (MercuryTimeStepIterator< NDIMS > other) const
	Not-equals operator, as defined for ForwardIterators. More...

MercuryTimeStep< NDIMS > &	operator* ()
	Dereference operator, as defined for ForwardIterators. More...

const MercuryTimeStep< NDIMS > &	operator* () const
	Const dereference operator, as defined for constant ForwardIterators. More...

void	operator++ ()
	Pre-increment operator, as defined for ForwardIterators This method populates the time step, including all the particles in there. It also resizes the backing storage mechanism. More...

Private Member Functions
	MercuryTimeStepIterator ()

	MercuryTimeStepIterator (MercuryDataFile *pData)

Private Attributes
MercuryTimeStep< NDIMS >	lastReadTimeStep_

bool	isEOFTimeStep_

MercuryDataFile *	dataFile_

Friends
class	MercuryDataFile

Detailed Description

template<std::size_t NDIMS>
class MercuryTimeStepIterator< NDIMS >

Lazy time step iterator Only loads the current time step and discards this as soon as it is incremented. This is a ForwardIterator as described by the C++11 standard This iterator invalidates any references to its dereferenced value when incremented.

Author: dducks

Constructor & Destructor Documentation

◆ MercuryTimeStepIterator() [1/2]

template<std::size_t NDIMS>

MercuryTimeStepIterator< NDIMS >::MercuryTimeStepIterator ( )

inlineprivate

EOF TimeStepIterator constructor, as used by MercuryDataFile::end()

       : isEOFTimeStep_(true), dataFile_(nullptr)
     {
     }

◆ MercuryTimeStepIterator() [2/2]

template<std::size_t NDIMS>

MercuryTimeStepIterator< NDIMS >::MercuryTimeStepIterator ( MercuryDataFile * pData )

inlineprivate

Beginning-of-file TimeStepIterator constructor, as used by MercuryDataFile::begin()

Parameters

[in] pData Pointer to the MercuryDataFile, which is required for the backing std::ifstream

       : lastReadTimeStep_(0,pData), isEOFTimeStep_(false), dataFile_(pData)
     {
       ++(*this);
       lastReadTimeStep_.ID_ = 0;
     }

References MercuryTimeStepIterator< NDIMS >::lastReadTimeStep_.

Member Function Documentation

◆ operator!=()

template<std::size_t NDIMS>

bool MercuryTimeStepIterator< NDIMS >::operator!= ( MercuryTimeStepIterator< NDIMS > other ) const

inline

Not-equals operator, as defined for ForwardIterators.

     {
       return (isEOFTimeStep_ != other.isEOFTimeStep_);
     }

References MercuryTimeStepIterator< NDIMS >::isEOFTimeStep_.

◆ operator*() [1/2]

template<std::size_t NDIMS>

MercuryTimeStep<NDIMS>& MercuryTimeStepIterator< NDIMS >::operator* ( )

inline

Dereference operator, as defined for ForwardIterators.

     {
       return lastReadTimeStep_;
     }

References MercuryTimeStepIterator< NDIMS >::lastReadTimeStep_.

◆ operator*() [2/2]

template<std::size_t NDIMS>

const MercuryTimeStep<NDIMS>& MercuryTimeStepIterator< NDIMS >::operator* ( ) const

inline

Const dereference operator, as defined for constant ForwardIterators.

     {
       return lastReadTimeStep_;
     }

References MercuryTimeStepIterator< NDIMS >::lastReadTimeStep_.

◆ operator++()

template<std::size_t NDIMS>

void MercuryTimeStepIterator< NDIMS >::operator++

Pre-increment operator, as defined for ForwardIterators This method populates the time step, including all the particles in there. It also resizes the backing storage mechanism.

 {
   lastReadTimeStep_.ID_++;
       
   std::string line;
   std::getline(dataFile_->file_, line);
   
   std::istringstream lineStream(line);
   
   lineStream >> lastReadTimeStep_;
   
   //I hope we didn't went beyond end of file...
   if (lineStream.eof())
   {
 //   logger(WARN, "The time step header detected an EOF.. Usually this"
 //                " means that the format was not what it appeared to be."
 //                "\nproceed with caution!");
   }
   //Resize the backing storage container to make sure we can actually
   //fit all the particles in there.
   lastReadTimeStep_.storage_.resize(lastReadTimeStep_.numParticles_);  
   //Well, now that we're set up, read all the particles
   for (MercuryParticle<NDIMS>& part : lastReadTimeStep_)
   {
     //line by line, because no data format can be trusted.
     std::getline(dataFile_->file_, line);
     lineStream.clear();
     lineStream.str(line);
    
     lineStream >> part;
   }
   
   if (dataFile_->file_.eof())
     isEOFTimeStep_ = true;
 }