the TReadWriteCsv class : allow to write and/or to read a csv file. More...

#include <STK_ReadWriteCsv.h>

Public Types
typedef Variable< Type >	Var

Public Member Functions
	TReadWriteCsv ()
	The default constructor.

	TReadWriteCsv (std::string const &file_name, bool read_names=Csv::DEFAULT_READNAMES, String const &delimiters=Csv::DEFAULT_DELIMITER)
	Constructor with a specified file name.

	TReadWriteCsv (TReadWriteCsv const &rw)
	Copy constructor.

	~TReadWriteCsv ()
	destructor.

void	clear ()
	reset all fields to default value and reclaims any allocated memory.

int	begin () const

int	end () const

int	size () const

Range	cols () const

int	beginCols () const

int	endCols () const

int	sizeCols () const

int	firstRow (int icol) const

int	endRow (int icol) const

int	lastRow (int icol) const

int	sizeRow (int icol) const

int	beginRows () const

int	endRows () const

int	sizeRows () const

int	lastIdxRows () const

Range	rows () const

int	lastIdx () const

int	lastIdxCols () const

String const &	error () const

String const &	delimiters () const

bool	withNames () const

void	setDelimiters (String const &delimiters) const
	Sets the delimiters to use for parsing data (delimiters_ is mutable).

void	setWithNames (bool with_names) const
	Sets the with_names_ value for reading/writing variables names.

void	setWithMapping (bool with_mapping) const
	Sets the with_mapping_ value for reading/writing variables names.

void	setLast_nl (bool with_last_nl) const
	Sets the with_last_nl_ value for writing a new line after the last line.

void	setReserve (int const &reserve) const
	Sets the reserve value for data storage (reserve_ is mutable).

void	setInMapping (std::map< String, Type > const &imapping)
	Set mapping to used when reading.

void	setOutMapping (std::map< String, Type > const &omapping)
	Set mapping to used when writting.

bool	setName (int const &icol, String const &name)
	Set the variable name `name` at the specified index.

Type &	operator() (int const &iRow, int const &iCol)

Type const	operator() (int const &iRow, int const &iCol) const

Var *	clone (int icol) const

Var &	var (int j)

Var const &	var (int icol) const

Var &	at (int icol)

Var const &	at (int icol) const

Var &	operator[] (int const &icol)

Var const	operator[] (int const &icol) const
	@ return a const reference to the value at the specified location.

Var &	front ()

Var const &	front () const

Var &	back ()

Var const &	back () const

bool	push_back (Var const &data=Var())
	Attempts to add a column with the values contained in data.

bool	push_front (Var const &data=Var())
	Attempts to add a column with the values contained in data.

void	resize (int sizeRows, int sizeCols)
	resize the container str_data_.

bool	appendData (int const &icol, Type const &value)
	Attempts to append a data to the variable specified by icol.

bool	eraseColumn (int const &icol)
	Deletes the variable whose index is icol from a TReadWriteCsv.

TReadWriteCsv &	operator= (TReadWriteCsv const &rw)
	Assigns a TReadWriteCsv equal to another TReadWriteCsv.

TReadWriteCsv &	operator+= (TReadWriteCsv const &rw)
	Appends a TReadWriteCsv to another TReadWriteCsv.

TReadWriteCsv	operator+ (TReadWriteCsv const &rw) const
	Combines TReadWriteCsv(s)

template<class Array >
void	exporter (ArrayBase< Array > &array) const
	export to an array of the same Type

bool	read ()
	Reads the default file with the specified read flags.

bool	read (std::map< String, Type > const &mapping)
	Reads the default file with the specified read flags using a map.

bool	read (std::string const &file_name)
	Reads the specified file with the specified read flags.

bool	read (istream &inBuffer)
	Reads the specified input stream with the specified read flags.

bool	write ()
	write to the default file with the specified write flags.

bool	write (std::string const &file_name) const
	Attempts to write the TReadWriteCsv to the location specified by file_name using the delimiters specified by delimiters_.

void	write (ostream &os) const
	Write the csv to an output stream.

void	writeSelection (ostream &os, int top, int bottom, int left, int right) const
	Write to output stream a selection based on the coordinates passed (Think of it as highlighting cells in Excel).

Protected Member Functions
int	countFields (String const &line, Array1D< Char > &listDelimiters)
	Counts the number of columns in a line stored in a String and return the position of the delimiters and its types.

int	readCurrentLine (istream &inBuffer, String &currentLine, Array1D< Char > &listDelimiters)
	Read the current line from the buffer.

void	readNames (istream &inBuffer)
	Read the names of rhe Csv file.

void	initRead (istream &inBuffer)
	Initial read.

void	fastSetData (int const &icol, int const &irow, Type const &value)
	Set without check the specified value to the element (icol, irow).

void	resizeRows (Range const &rows)
	resize the `TReadWriteCsv` to the given range of rows.

void	resizeCols (Range const &cols)
	resize the `TReadWriteCsv` to the given range of columns.

Protected Attributes
std::string	file_name_
	Name of the Current file read.

bool	with_names_
	Read or Write names of the variables.

bool	with_mapping_
	map the values stored

bool	with_last_nl_
	write a new line character at the end of the output

String	delimiters_
	Delimiter(s)

int	reserve_
	Size of the buffer.

String	msg_error_
	Contain the last error message.

Array1D< Var >	str_data_
	Array of array for the data.

std::map< String, Type >	imapping_
	mapping String -> Type for (input)

std::map< Type, String >	omapping_
	mapping Type -> String (output)

int	nbVars_
	The number of variables we manage.

int	nbRows_
	The number of rows we manage.

Friends
istream &	operator>> (istream &in, TReadWriteCsv &rw)
	overload operator >> for rw

ostream &	operator<< (ostream &os, TReadWriteCsv const &rw)
	overload operator << for rw

Detailed Description

template<typename Type>
class STK::TReadWriteCsv< Type >

the TReadWriteCsv class : allow to write and/or to read a csv file.

It is possible to merge two csv files and to extract sub-region of the file too. All data are stored in a Type format. if there exists mixed types in the file you want to read/write, used the String format and use the import/export utilities classes

See also: ExportToCsv, ImportFromCsv.

It is possible to use a mapping in order to write/read the data using an other encoding.

Definition at line 107 of file STK_ReadWriteCsv.h.

Member Typedef Documentation

◆ Var

template<typename Type >

typedef Variable<Type> STK::TReadWriteCsv< Type >::Var

Definition at line 110 of file STK_ReadWriteCsv.h.

Constructor & Destructor Documentation

◆ TReadWriteCsv() [1/3]

template<typename Type >

STK::TReadWriteCsv< Type >::TReadWriteCsv ( )

inline

The default constructor.

Instantiates an instance of TReadWriteCsv and initialize data members to default values.

Definition at line 114 of file STK_ReadWriteCsv.h.

                           : file_name_()
                           , with_names_(Csv::DEFAULT_READNAMES)
                           , with_mapping_(Csv::DEFAULT_MAPPING)
                           , with_last_nl_(Csv::DEFAULT_LAST_NL)
                           , delimiters_(Csv::DEFAULT_DELIMITER)
                           , reserve_(Csv::DEFAULT_RESERVE)
                           , msg_error_()
                           , nbVars_(0)
                           , nbRows_(0)
 
    {}

Referenced by STK::TReadWriteCsv< Type >::operator+().

◆ TReadWriteCsv() [2/3]

template<typename Type >

STK::TReadWriteCsv< Type >::TReadWriteCsv	(	std::string const &	file_name,
		bool	read_names = `Csv::DEFAULT_READNAMES`,
		String const &	delimiters = `Csv::DEFAULT_DELIMITER`
	)

inline

Constructor with a specified file name.

Instantiates an instance of TReadWriteCsv with the specified read flags.

Parameters

file_name	name of the file to read/write
read_names	true if we want read/write the names of the variables at the first line of the file
delimiters	The delimiters used in the fileo(if read) or the delimiter to use (if write)

Definition at line 133 of file STK_ReadWriteCsv.h.

                        : file_name_(file_name)
                        , with_names_(read_names)
                        , with_mapping_(Csv::DEFAULT_MAPPING)
                        , with_last_nl_(Csv::DEFAULT_LAST_NL)
                        , delimiters_(delimiters)
                        , reserve_(Csv::DEFAULT_RESERVE)
                        , msg_error_()
                        , nbVars_(0)
                        , nbRows_(0)
    {}

◆ TReadWriteCsv() [3/3]

template<typename Type >

STK::TReadWriteCsv< Type >::TReadWriteCsv ( TReadWriteCsv< Type > const & rw )

inline

Copy constructor.

Instantiates an instance of TReadWriteCsv with the contents of another TReadWriteCsv.

Parameters

rw	the TReadWriteCsv to copy

Definition at line 151 of file STK_ReadWriteCsv.h.

151{ *this = rw;}

◆ ~TReadWriteCsv()

template<typename Type >

STK::TReadWriteCsv< Type >::~TReadWriteCsv ( )

inline

destructor.

Definition at line 153 of file STK_ReadWriteCsv.h.

153{}

Member Function Documentation

◆ appendData()

template<typename Type >

bool STK::TReadWriteCsv< Type >::appendData	(	int const &	icol,
		Type const &	value
	)

inline

Attempts to append a data to the variable specified by icol.

Parameters

icol	index of the col
value	value to set

Returns: true if successful, false if an error is encountered.

Definition at line 383 of file STK_ReadWriteCsv.h.

    {
      try
      {
        if (Arithmetic<Type>::isNA(value))
          str_data_[icol].push_back(Arithmetic<Type>::NA());
        else
          str_data_[icol].push_back(value);
        return true;
      }
      catch(const Exception& e) { msg_error_ = e.error(); }
      catch(...) { msg_error_ = Csv::ERRORCODES[1]; }
      return false;
    }

References STK::IRunnerBase::error(), STK::TReadWriteCsv< Type >::msg_error_, and STK::TReadWriteCsv< Type >::str_data_.

◆ at() [1/2]

template<typename Type >

Var & STK::TReadWriteCsv< Type >::at ( int icol )

inline

Returns: the element with the index icol.

Parameters

icol	index of the col

Definition at line 317 of file STK_ReadWriteCsv.h.

317{ return str_data_.at(icol); }

References STK::TReadWriteCsv< Type >::str_data_.

◆ at() [2/2]

template<typename Type >

Var const & STK::TReadWriteCsv< Type >::at ( int icol ) const

inline

Returns: a constant reference of the icol variable.

Parameters

icol	index of the col

Definition at line 321 of file STK_ReadWriteCsv.h.

321{ return str_data_.at(icol); }

References STK::TReadWriteCsv< Type >::str_data_.

◆ back() [1/2]

template<typename Type >

Var & STK::TReadWriteCsv< Type >::back ( )

inline

Returns: the last variable.

Definition at line 335 of file STK_ReadWriteCsv.h.

335{ return str_data_.at(lastIdx());}

STK::TReadWriteCsv::lastIdx

int lastIdx() const

Definition STK_ReadWriteCsv.h:237

References STK::TReadWriteCsv< Type >::lastIdx(), and STK::TReadWriteCsv< Type >::str_data_.

◆ back() [2/2]

template<typename Type >

Var const & STK::TReadWriteCsv< Type >::back ( ) const

inline

Returns: the last variable (const).

Definition at line 337 of file STK_ReadWriteCsv.h.

337{ return str_data_.at(lastIdx());}

References STK::TReadWriteCsv< Type >::lastIdx(), and STK::TReadWriteCsv< Type >::str_data_.

◆ begin()

template<typename Type >

int STK::TReadWriteCsv< Type >::begin ( ) const

inline

Returns: the index of the first variable (should be baseIdx).

Definition at line 166 of file STK_ReadWriteCsv.h.

166{ return str_data_.begin(); }

References STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::beginRows(), STK::TReadWriteCsv< Type >::endRows(), STK::TReadWriteCsv< Type >::front(), STK::TReadWriteCsv< Type >::front(), STK::TReadWriteCsv< Type >::lastIdxRows(), STK::TReadWriteCsv< Type >::resizeRows(), STK::TReadWriteCsv< Type >::sizeRows(), STK::TReadWriteCsv< Type >::write(), and STK::TReadWriteCsv< Type >::write().

◆ beginCols()

template<typename Type >

int STK::TReadWriteCsv< Type >::beginCols ( ) const

inline

Returns: the index of the first variable (should be baseIdx).

Definition at line 175 of file STK_ReadWriteCsv.h.

175{ return str_data_.begin(); }

References STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::exporter().

◆ beginRows()

template<typename Type >

int STK::TReadWriteCsv< Type >::beginRows ( ) const

inline

Returns: the first index of the samples.

Definition at line 198 of file STK_ReadWriteCsv.h.

    {
      if (size()<= 0) return baseIdx;
      int retVal = firstRow(begin());
      for (int i=begin()+1; i<=lastIdx(); i++)
      { retVal = std::min(retVal, firstRow(i));}
      return retVal;
    }

References STK::baseIdx, STK::TReadWriteCsv< Type >::begin(), STK::TReadWriteCsv< Type >::firstRow(), STK::TReadWriteCsv< Type >::lastIdx(), and STK::TReadWriteCsv< Type >::size().

Referenced by STK::TReadWriteCsv< Type >::exporter(), STK::TReadWriteCsv< Type >::rows(), STK::TReadWriteCsv< Type >::write(), and STK::TReadWriteCsv< Type >::write().

◆ clear()

template<typename Type >

void STK::TReadWriteCsv< Type >::clear ( )

inline

reset all fields to default value and reclaims any allocated memory.

Definition at line 155 of file STK_ReadWriteCsv.h.

    {
      msg_error_.clear();
      str_data_.clear();
      with_names_   = Csv::DEFAULT_READNAMES;
      with_mapping_ = Csv::DEFAULT_MAPPING;
      with_last_nl_ = Csv::DEFAULT_LAST_NL;
      delimiters_   = Csv::DEFAULT_DELIMITER;
      reserve_      = Csv::DEFAULT_RESERVE;
    }

References STK::TReadWriteCsv< Type >::delimiters_, STK::TReadWriteCsv< Type >::msg_error_, STK::TReadWriteCsv< Type >::reserve_, STK::TReadWriteCsv< Type >::str_data_, STK::TReadWriteCsv< Type >::with_last_nl_, STK::TReadWriteCsv< Type >::with_mapping_, and STK::TReadWriteCsv< Type >::with_names_.

◆ clone()

template<typename Type >

Var * STK::TReadWriteCsv< Type >::clone ( int icol ) const

inline

Returns: the variable with the index icol.

Parameters

icol	index of the col

Definition at line 305 of file STK_ReadWriteCsv.h.

305{ return str_data_.elt(icol).clone(); }

References STK::TReadWriteCsv< Type >::str_data_.

◆ cols()

template<typename Type >

Range STK::TReadWriteCsv< Type >::cols ( ) const

inline

Returns: The range of the variables of the TReadWriteCsv

Definition at line 173 of file STK_ReadWriteCsv.h.

173{ return str_data_.range(); }

References STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::resizeCols().

◆ countFields()

template<typename Type >

int STK::TReadWriteCsv< Type >::countFields	(	String const &	line,
		Array1D< Char > &	listDelimiters
	)

inlineprotected

Counts the number of columns in a line stored in a String and return the position of the delimiters and its types.

Parameters

line	The String to parse
listDelimiters	array with the delimiters found in the line

Returns: the number of field in the line

Definition at line 588 of file STK_ReadWriteCsv.h.

    {
      listDelimiters.clear();
      listDelimiters.reserve(nbVars_);
      // position of the delimiters in the file
      String::size_type idx =0;
      do
      {
        // Find delimiter
        idx = line.find_first_of(delimiters_, idx);
        // if the position of the delimiter char is not found
        if (idx == line.npos) break;
        listDelimiters.push_back(line[idx]);
        ++idx;
      } while(1);
      // last delimiter is the end of line
      listDelimiters.push_back(CHAR_NL);
      listDelimiters.shift(1);
      // return the number of fields
      return listDelimiters.size();
    }

References STK::TReadWriteCsv< Type >::delimiters_, and STK::TReadWriteCsv< Type >::nbVars_.

Referenced by STK::TReadWriteCsv< Type >::readCurrentLine().

◆ delimiters()

template<typename Type >

String const & STK::TReadWriteCsv< Type >::delimiters ( ) const

inline

Returns: the delimiters used in the Csv file

Definition at line 244 of file STK_ReadWriteCsv.h.

244{ return delimiters_; }

References STK::TReadWriteCsv< Type >::delimiters_.

Referenced by STK::TReadWriteCsv< Type >::setDelimiters().

◆ end()

template<typename Type >

int STK::TReadWriteCsv< Type >::end ( ) const

inline

Returns: the ending index of the variables

Definition at line 168 of file STK_ReadWriteCsv.h.

168{ return str_data_.end(); }

References STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::endRows(), STK::TReadWriteCsv< Type >::lastIdxRows(), and STK::TReadWriteCsv< Type >::sizeRows().

◆ endCols()

template<typename Type >

int STK::TReadWriteCsv< Type >::endCols ( ) const

inline

Returns: the ending index of the variables

Definition at line 177 of file STK_ReadWriteCsv.h.

177{ return str_data_.end(); }

References STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::exporter().

◆ endRow()

template<typename Type >

int STK::TReadWriteCsv< Type >::endRow ( int icol ) const

inline

Parameters

icol	index of the column

Returns: the ending index of the column icol

Definition at line 188 of file STK_ReadWriteCsv.h.

188{ return str_data_.at(icol).end();}

References STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::endRows().

◆ endRows()

template<typename Type >

int STK::TReadWriteCsv< Type >::endRows ( ) const

inline

Returns: the ending index of the samples.

Definition at line 207 of file STK_ReadWriteCsv.h.

    {
      if (size()<= 0) return baseIdx;
      int retVal = lastRow(begin());
      for (int i=begin()+1; i<end(); i++)
      { retVal = std::max(retVal, endRow(i));}
      return retVal;
    }

References STK::baseIdx, STK::TReadWriteCsv< Type >::begin(), STK::TReadWriteCsv< Type >::end(), STK::TReadWriteCsv< Type >::endRow(), STK::TReadWriteCsv< Type >::lastRow(), and STK::TReadWriteCsv< Type >::size().

Referenced by STK::TReadWriteCsv< Type >::exporter().

◆ eraseColumn()

template<typename Type >

bool STK::TReadWriteCsv< Type >::eraseColumn ( int const & icol )

inline

Deletes the variable whose index is icol from a TReadWriteCsv.

Parameters

icol	index of the column to erase

Returns: true if successful, false if an error is encountered.

Definition at line 401 of file STK_ReadWriteCsv.h.

    {
      try
      {
        str_data_.erase(icol);
        return true;
      }
      catch( Exception const& e) { msg_error_ = e.error(); }
      catch(...) { msg_error_ = Csv::ERRORCODES[1]; }
      return false;
    }

References STK::IRunnerBase::error(), STK::TReadWriteCsv< Type >::msg_error_, and STK::TReadWriteCsv< Type >::str_data_.

◆ error()

template<typename Type >

String const & STK::TReadWriteCsv< Type >::error ( ) const

inline

Returns: the last error encountered

Definition at line 242 of file STK_ReadWriteCsv.h.

242{ return msg_error_; }

References STK::TReadWriteCsv< Type >::msg_error_.

◆ exporter()

template<typename Type >

template<class Array >

void STK::TReadWriteCsv< Type >::exporter ( ArrayBase< Array > & array ) const

inline

export to an array of the same Type

Definition at line 443 of file STK_ReadWriteCsv.h.

    {
      array.asDerived().resize(sizeRows(), sizeCols());
      for (int j= beginCols(); j < endCols(); ++j)
      {
        for (int i= beginRows(); i < endRows(); ++i)
        {
          array.elt(i,j) = var(j)[i];
        }
 
      }
    }

References STK::TReadWriteCsv< Type >::beginCols(), STK::TReadWriteCsv< Type >::beginRows(), STK::TReadWriteCsv< Type >::endCols(), STK::TReadWriteCsv< Type >::endRows(), STK::TReadWriteCsv< Type >::sizeCols(), STK::TReadWriteCsv< Type >::sizeRows(), and STK::TReadWriteCsv< Type >::var().

◆ fastSetData()

template<typename Type >

void STK::TReadWriteCsv< Type >::fastSetData	(	int const &	icol,
		int const &	irow,
		Type const &	value
	)

inlineprotected

Set without check the specified value to the element (icol, irow).

Parameters

icol	index of the column
irow	index of the row
value	the value to set

Definition at line 689 of file STK_ReadWriteCsv.h.

690 { str_data_.elt(icol).elt(irow) = value;}

References STK::TReadWriteCsv< Type >::str_data_.

◆ firstRow()

template<typename Type >

int STK::TReadWriteCsv< Type >::firstRow ( int icol ) const

inline

Parameters

icol	index of the variable

Returns: the first index in the column icol

Definition at line 184 of file STK_ReadWriteCsv.h.

184{ return str_data_.at(icol).begin();}

References STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::beginRows().

◆ front() [1/2]

template<typename Type >

Var & STK::TReadWriteCsv< Type >::front ( )

inline

Returns: the first variable.

Definition at line 331 of file STK_ReadWriteCsv.h.

331{ return str_data_.at(begin());}

References STK::TReadWriteCsv< Type >::begin(), and STK::TReadWriteCsv< Type >::str_data_.

◆ front() [2/2]

template<typename Type >

Var const & STK::TReadWriteCsv< Type >::front ( ) const

inline

Returns: the first variable (const).

Definition at line 333 of file STK_ReadWriteCsv.h.

333{ return str_data_.at(begin());}

References STK::TReadWriteCsv< Type >::begin(), and STK::TReadWriteCsv< Type >::str_data_.

◆ initRead()

template<typename Type >

void STK::TReadWriteCsv< Type >::initRead ( istream & inBuffer )

inlineprotected

Initial read.

Will compute an initial value for nbRows_ and nbVars_ and eventually read the name of the variables in the first line of the file.

Parameters

inBuffer the input stream to start to read

Definition at line 660 of file STK_ReadWriteCsv.h.

    {
      Array1D<Char>  listDelimiters;
      String currentLine;
      // clear previous ReadCvs if any
      str_data_.clear();
      // get current position in the stream
      std::streampos pos = inBuffer.tellg();
      // Count the number of rows of the input stream
      nbRows_ = DManager::nbEndOfLine(inBuffer);
      setReserve(nbRows_);
      // revert to the current position in the stream
      inBuffer.seekg(pos);
      // initialize the initial number of variables to 0
      nbVars_ = 0;
      // If the names are at the top line
      if (with_names_) { readNames(inBuffer);}
      // get current position
      pos = inBuffer.tellg();
      // count number of fields in the first line
      int nbField = readCurrentLine(inBuffer, currentLine, listDelimiters);
      nbVars_ = std::max(nbVars_, nbField);
      inBuffer.seekg(pos);
    }

References STK::DManager::nbEndOfLine(), STK::TReadWriteCsv< Type >::nbRows_, STK::TReadWriteCsv< Type >::nbVars_, STK::TReadWriteCsv< Type >::readCurrentLine(), STK::TReadWriteCsv< Type >::readNames(), STK::TReadWriteCsv< Type >::setReserve(), STK::TReadWriteCsv< Type >::str_data_, and STK::TReadWriteCsv< Type >::with_names_.

◆ lastIdx()

template<typename Type >

int STK::TReadWriteCsv< Type >::lastIdx ( ) const

inline

Returns: the index of the last variable

Definition at line 237 of file STK_ReadWriteCsv.h.

237{ return str_data_.lastIdx(); }

References STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::back(), STK::TReadWriteCsv< Type >::back(), STK::TReadWriteCsv< Type >::beginRows(), STK::TReadWriteCsv< Type >::resizeRows(), STK::TReadWriteCsv< Type >::write(), and STK::TReadWriteCsv< Type >::write().

◆ lastIdxCols()

template<typename Type >

int STK::TReadWriteCsv< Type >::lastIdxCols ( ) const

inline

Returns: the index of the last variable

Definition at line 239 of file STK_ReadWriteCsv.h.

239{ return str_data_.lastIdx(); }

References STK::TReadWriteCsv< Type >::str_data_.

◆ lastIdxRows()

template<typename Type >

int STK::TReadWriteCsv< Type >::lastIdxRows ( ) const

inline

Returns: the last index of the samples.

Definition at line 225 of file STK_ReadWriteCsv.h.

    {
      if (size()<= 0) return baseIdx-1;
      int retVal = lastRow(begin());
      for (int i=begin()+1; i<end(); i++)
      { retVal = std::max(retVal, lastRow(i));}
      return retVal;
    }

References STK::baseIdx, STK::TReadWriteCsv< Type >::begin(), STK::TReadWriteCsv< Type >::end(), STK::TReadWriteCsv< Type >::lastRow(), and STK::TReadWriteCsv< Type >::size().

Referenced by STK::TReadWriteCsv< Type >::rows(), STK::TReadWriteCsv< Type >::write(), and STK::TReadWriteCsv< Type >::write().

◆ lastRow()

template<typename Type >

int STK::TReadWriteCsv< Type >::lastRow ( int icol ) const

inline

Parameters

icol	index of the column

Returns: the last index in the column icol

Definition at line 192 of file STK_ReadWriteCsv.h.

192{ return str_data_.at(icol).lastIdx();}

References STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::endRows(), and STK::TReadWriteCsv< Type >::lastIdxRows().

◆ operator()() [1/2]

template<typename Type >

Type & STK::TReadWriteCsv< Type >::operator()	(	int const &	iRow,
		int const &	iCol
	)

inline

Returns: a reference of the value specified by the given coordinates.

Parameters

iCol	index of the column
iRow	index of the row

Definition at line 294 of file STK_ReadWriteCsv.h.

295 { return str_data_.elt(iCol).elt(iRow);}

References STK::TReadWriteCsv< Type >::str_data_.

◆ operator()() [2/2]

template<typename Type >

Type const STK::TReadWriteCsv< Type >::operator()	(	int const &	iRow,
		int const &	iCol
	)		const

inline

Returns: a constant reference of the value specified by the given coordinates.

Parameters

iCol	index of the column
iRow	index of the row

Definition at line 300 of file STK_ReadWriteCsv.h.

301 { return str_data_.elt(iCol).elt(iRow);}

References STK::TReadWriteCsv< Type >::str_data_.

◆ operator+()

template<typename Type >

TReadWriteCsv STK::TReadWriteCsv< Type >::operator+ ( TReadWriteCsv< Type > const & rw ) const

inline

Combines TReadWriteCsv(s)

Parameters

rw	the TReadWriteCsv to add

Definition at line 439 of file STK_ReadWriteCsv.h.

440 { return TReadWriteCsv((*this)) += rw;}

STK::TReadWriteCsv::TReadWriteCsv

TReadWriteCsv()

The default constructor.

Definition STK_ReadWriteCsv.h:114

References STK::TReadWriteCsv< Type >::TReadWriteCsv().

◆ operator+=()

template<typename Type >

TReadWriteCsv & STK::TReadWriteCsv< Type >::operator+= ( TReadWriteCsv< Type > const & rw )

inline

Appends a TReadWriteCsv to another TReadWriteCsv.

Parameters

rw	the TReadWriteCsv to append

Definition at line 430 of file STK_ReadWriteCsv.h.

    {
      for ( int i=rw.begin(); i<=rw.lastIdx(); i++)
      { str_data_.push_back(rw.str_data_[i]);}
      return *this;
    }

References STK::TReadWriteCsv< Type >::str_data_.

◆ operator=()

template<typename Type >

TReadWriteCsv & STK::TReadWriteCsv< Type >::operator= ( TReadWriteCsv< Type > const & rw )

inline

Assigns a TReadWriteCsv equal to another TReadWriteCsv.

Parameters

rw	the TReadWriteCsv to copy

Definition at line 415 of file STK_ReadWriteCsv.h.

    {
      file_name_     = rw.file_name_;
      with_names_    = rw.with_names_;
      delimiters_    = rw.delimiters_;
      reserve_       = rw.reserve_;
      msg_error_     = rw.msg_error_;
      str_data_      = rw.str_data_;
      nbVars_        = rw.nbVars_;
      nbRows_        = rw.nbRows_;
      return *this;
    }

References STK::TReadWriteCsv< Type >::delimiters_, STK::TReadWriteCsv< Type >::file_name_, STK::TReadWriteCsv< Type >::msg_error_, STK::IRunnerBase::msg_error_, STK::TReadWriteCsv< Type >::nbRows_, STK::TReadWriteCsv< Type >::nbVars_, STK::TReadWriteCsv< Type >::reserve_, STK::TReadWriteCsv< Type >::str_data_, and STK::TReadWriteCsv< Type >::with_names_.

◆ operator[]() [1/2]

template<typename Type >

Var & STK::TReadWriteCsv< Type >::operator[] ( int const & icol )

inline

Returns: a reference of the icol variable

Parameters

icol	index of the col

Definition at line 325 of file STK_ReadWriteCsv.h.

325{ return str_data_[icol]; }

References STK::TReadWriteCsv< Type >::str_data_.

◆ operator[]() [2/2]

template<typename Type >

Var const STK::TReadWriteCsv< Type >::operator[] ( int const & icol ) const

inline

@ return a const reference to the value at the specified location.

Parameters

icol	index of the col

Definition at line 329 of file STK_ReadWriteCsv.h.

329{ return str_data_[icol]; }

References STK::TReadWriteCsv< Type >::str_data_.

◆ push_back()

template<typename Type >

bool STK::TReadWriteCsv< Type >::push_back ( Var const & data = Var() )

inline

Attempts to add a column with the values contained in data.

Parameters

data	the column to push back

Returns: true if successful, false if an error is encountered.

Definition at line 342 of file STK_ReadWriteCsv.h.

    {
      try
      {
        str_data_.push_back(data);
        //str_data_.back().reserve(reserve_);
        return true;
      }
      catch(const Exception& e) { msg_error_ = e.error(); }
      catch(...) { msg_error_ = Csv::ERRORCODES[1]; }
      return false;
    }

References STK::IRunnerBase::error(), STK::TReadWriteCsv< Type >::msg_error_, and STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::readNames().

◆ push_front()

template<typename Type >

bool STK::TReadWriteCsv< Type >::push_front ( Var const & data = Var() )

inline

Attempts to add a column with the values contained in data.

Parameters

data	the column to push front

Returns: true if successful, false if an error is encountered.

Definition at line 358 of file STK_ReadWriteCsv.h.

    {
      try
      {
        str_data_.push_front(data);
        return true;
      }
      catch(const Exception& e) { msg_error_ = e.error(); }
      catch(...) { msg_error_ = Csv::ERRORCODES[1]; }
      return false;
    }

References STK::IRunnerBase::error(), STK::TReadWriteCsv< Type >::msg_error_, and STK::TReadWriteCsv< Type >::str_data_.

◆ read() [1/4]

template<typename Type >

bool STK::TReadWriteCsv< Type >::read ( )

inline

Reads the default file with the specified read flags.

Returns: true if successful, false if an error is encountered.

Definition at line 458 of file STK_ReadWriteCsv.h.

458{ return read(file_name_);}

STK::TReadWriteCsv::read

bool read()

Reads the default file with the specified read flags.

Definition STK_ReadWriteCsv.h:458

References STK::TReadWriteCsv< Type >::file_name_, and STK::TReadWriteCsv< Type >::read().

Referenced by STK::TReadWriteCsv< Type >::read(), STK::TReadWriteCsv< Type >::read(), and STK::TReadWriteCsv< Type >::read().

◆ read() [2/4]

template<typename Type >

bool STK::TReadWriteCsv< Type >::read ( istream & inBuffer )

Reads the specified input stream with the specified read flags.

Parameters

inBuffer name of the stream to read

Returns: true if successful, false if an error is encountered.

Definition at line 711 of file STK_ReadWriteCsv.h.

{
  Array1D<Char> listDelimiters;
  String currentLine;
  try
  {
    initRead(inBuffer);
    resizeCols(nbVars_);
    resizeRows(nbRows_);
    // Read data : loop for all rows
    int currentRow=beginRows()-1, countRows = 0;
    for (; !inBuffer.eof();)
    {
      int nbField = readCurrentLine(inBuffer, currentLine, listDelimiters);
      if (nbField == 0) { break;}
      //  add on the non-existing columns: will be done if (nbField >= nbVars_)
      for (int iField=nbVars_+1; iField<=nbField; iField++)
      { push_back(Var( nbRows_, Arithmetic<Type>::NA(), stringNa));
        nbVars_++;
      }
      // first loop on the existing columns with data
      currentRow++; countRows++;
      istringstream instream(currentLine);
      int icol=begin();
      for (int iField=1 ; iField<=nbField; iField++, icol++)
      {
        String field;
        DManager::getField( instream, field, listDelimiters.elt(iField));
        // append Data to the column
        with_mapping_ ?
            fastSetData(icol, currentRow, imapping_.count(field) ? imapping_.find(field)->second : Arithmetic<Type>::NA())
         :  fastSetData(icol, currentRow, stringToType<Type>(field));
      }
      // Append NA values if the row is not complete
      for (; icol<end(); icol++) { fastSetData(icol, currentRow, Arithmetic<Type>::NA());}
    }
    // resize in case there exists too much rows
    resizeRows(Range(countRows));
    return true;
  }
  catch( Exception const& e) { msg_error_ = e.error(); }
  catch(...) { msg_error_ = Csv::ERRORCODES[1]; }
  return false;
}

References STK::IRunnerBase::error(), STK::DManager::getField(), STK::IRunnerBase::msg_error_, STK::Arithmetic< Type >::NA(), and STK::stringNa.

◆ read() [3/4]

template<typename Type >

bool STK::TReadWriteCsv< Type >::read ( std::map< String, Type > const & mapping )

inline

Reads the default file with the specified read flags using a map.

Returns: true if successful, false if an error is encountered.

Definition at line 462 of file STK_ReadWriteCsv.h.

463 { return read(file_name_);}

References STK::TReadWriteCsv< Type >::file_name_, and STK::TReadWriteCsv< Type >::read().

◆ read() [4/4]

template<typename Type >

bool STK::TReadWriteCsv< Type >::read ( std::string const & file_name )

inline

Reads the specified file with the specified read flags.

Parameters

file_name name of the file to read

Returns: true if successful, false if an error is encountered.

Definition at line 468 of file STK_ReadWriteCsv.h.

    {
      try
      {
        // update current file_name
        file_name_ = file_name;
        // input file stream
        ifstream inFile;
        // open file
        inFile.open(file_name.c_str(),std::ios::in);
        // check error
        if (inFile.rdstate() & std::ios::failbit)
        {
          inFile.close();
          msg_error_ = Csv::ERRORCODES[4];
          msg_error_ += "\nFile: " + file_name;
          return false;
        }
        read(inFile);                  // and read it
        inFile.close();
        // return
        return true;
      }
      catch(const Exception& e)
      { msg_error_ = e.error();}
      catch(...)
      { msg_error_ = Csv::ERRORCODES[1];}
      return false;
    }

References STK::IRunnerBase::error(), STK::TReadWriteCsv< Type >::file_name_, STK::TReadWriteCsv< Type >::msg_error_, and STK::TReadWriteCsv< Type >::read().

◆ readCurrentLine()

template<typename Type >

int STK::TReadWriteCsv< Type >::readCurrentLine	(	istream &	inBuffer,
		String &	currentLine,
		Array1D< Char > &	listDelimiters
	)

inlineprotected

Read the current line from the buffer.

Returns: the number of field found in the current line

Parameters

inBuffer	the input stream to read
currentLine	the line to read
listDelimiters	the delimiters between the fields in the current line

Definition at line 615 of file STK_ReadWriteCsv.h.

    {
      if (inBuffer.eof()) return 0;
      int nbField =0;
      do
      {
        currentLine.clear();
        std::getline(inBuffer, currentLine);
        if (currentLine.size() == 0) {nbField = 0;}
        else
        {
          DManager::removeCharBeforeAndAfter(currentLine, CHAR_BLANK);
          nbField = (currentLine.size() == 0)
                  ? 0 : countFields( currentLine, listDelimiters);
        }
      }
      while ((nbField == 0)&&(!inBuffer.eof()));
      return nbField;
    }

References STK::TReadWriteCsv< Type >::countFields(), and STK::DManager::removeCharBeforeAndAfter().

Referenced by STK::TReadWriteCsv< Type >::initRead(), and STK::TReadWriteCsv< Type >::readNames().

◆ readNames()

template<typename Type >

void STK::TReadWriteCsv< Type >::readNames ( istream & inBuffer )

inlineprotected

Read the names of rhe Csv file.

They are stored in the first line of the file.

Parameters

inBuffer the input stream to read

Definition at line 637 of file STK_ReadWriteCsv.h.

    {
      Array1D<Char> listDelimiters;
      String currentLine;
      // Count the number of names of the first line
      int nbField = readCurrentLine(inBuffer, currentLine, listDelimiters);
      if (nbField == 0) return;
      // Declare an input string stream
      istringstream instream(currentLine);
      for(int icol=1; icol<=nbField; icol++)
      {
        // Append a Col
        String name;
        DManager::getField( instream, name, listDelimiters.elt(icol));
        push_back(Var(nbRows_, name));
      }
      // Update the number of var
      nbVars_ = std::max(nbVars_, nbField);
    }

References STK::DManager::getField(), STK::TReadWriteCsv< Type >::nbRows_, STK::TReadWriteCsv< Type >::nbVars_, STK::TReadWriteCsv< Type >::push_back(), and STK::TReadWriteCsv< Type >::readCurrentLine().

Referenced by STK::TReadWriteCsv< Type >::initRead().

◆ resize()

template<typename Type >

void STK::TReadWriteCsv< Type >::resize	(	int	sizeRows,
		int	sizeCols
	)

inline

resize the container str_data_.

Parameters

sizeCols	number of columns
sizeRows	number of rows

Definition at line 373 of file STK_ReadWriteCsv.h.

    {
      resizeCols(sizeCols);
      resizeRows(sizeRows);
    }

References STK::TReadWriteCsv< Type >::resizeCols(), STK::TReadWriteCsv< Type >::resizeRows(), STK::TReadWriteCsv< Type >::sizeCols(), and STK::TReadWriteCsv< Type >::sizeRows().

◆ resizeCols()

template<typename Type >

void STK::TReadWriteCsv< Type >::resizeCols ( Range const & cols )

inlineprotected

resize the TReadWriteCsv to the given range of columns.

Parameters

cols	the range of columns to set

Definition at line 702 of file STK_ReadWriteCsv.h.

703 { str_data_.resize(cols);}

STK::TReadWriteCsv::cols

Range cols() const

Definition STK_ReadWriteCsv.h:173

References STK::TReadWriteCsv< Type >::cols(), and STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::resize().

◆ resizeRows()

template<typename Type >

void STK::TReadWriteCsv< Type >::resizeRows ( Range const & rows )

inlineprotected

resize the TReadWriteCsv to the given range of rows.

Parameters

rows	the range of the rows

Definition at line 694 of file STK_ReadWriteCsv.h.

    {
      for (int iVar=begin(); iVar<=lastIdx(); iVar++ )
      { str_data_.elt(iVar).resize(rows);}
    }

References STK::TReadWriteCsv< Type >::begin(), STK::TReadWriteCsv< Type >::lastIdx(), STK::TReadWriteCsv< Type >::rows(), and STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::resize().

◆ rows()

template<typename Type >

Range STK::TReadWriteCsv< Type >::rows ( ) const

inline

Returns: The range of the samples of the TReadWriteCsv

Definition at line 234 of file STK_ReadWriteCsv.h.

234{ return Range(beginRows(), lastIdxRows(), 0); }

STK::TReadWriteCsv::lastIdxRows

int lastIdxRows() const

Definition STK_ReadWriteCsv.h:225

References STK::TReadWriteCsv< Type >::beginRows(), and STK::TReadWriteCsv< Type >::lastIdxRows().

Referenced by STK::TReadWriteCsv< Type >::resizeRows().

◆ setDelimiters()

template<typename Type >

void STK::TReadWriteCsv< Type >::setDelimiters ( String const & delimiters ) const

inline

Sets the delimiters to use for parsing data (delimiters_ is mutable).

Parameters

delimiters delimiters to use

Definition at line 250 of file STK_ReadWriteCsv.h.

250{ delimiters_ = delimiters; }

References STK::TReadWriteCsv< Type >::delimiters(), and STK::TReadWriteCsv< Type >::delimiters_.

◆ setInMapping()

template<typename Type >

void STK::TReadWriteCsv< Type >::setInMapping ( std::map< String, Type > const & imapping )

inline

Set mapping to used when reading.

Definition at line 268 of file STK_ReadWriteCsv.h.

269 { imapping_ = imapping;}

References STK::TReadWriteCsv< Type >::imapping_.

◆ setLast_nl()

template<typename Type >

void STK::TReadWriteCsv< Type >::setLast_nl ( bool with_last_nl ) const

inline

Sets the with_last_nl_ value for writing a new line after the last line.

Parameters

with_last_nl true if we want to write a new line after the last line

Definition at line 262 of file STK_ReadWriteCsv.h.

262{ with_last_nl_ = with_last_nl; }

References STK::TReadWriteCsv< Type >::with_last_nl_.

◆ setName()

template<typename Type >

bool STK::TReadWriteCsv< Type >::setName	(	int const &	icol,
		String const &	name
	)

inline

Set the variable name name at the specified index.

Parameters

icol	index of the variable
name	name of the variable to set

Returns: true if successful, false if an error is encountered.

Definition at line 278 of file STK_ReadWriteCsv.h.

    {
      try
      {
        str_data_.at(icol).setName(name);
        return true;
      }
      catch( Exception const& e) { msg_error_ = e.error(); }
      catch(...)  { msg_error_ = Csv::ERRORCODES[1]; }
      return false;
    }

References STK::IRunnerBase::error(), STK::TReadWriteCsv< Type >::msg_error_, and STK::TReadWriteCsv< Type >::str_data_.

◆ setOutMapping()

template<typename Type >

void STK::TReadWriteCsv< Type >::setOutMapping ( std::map< String, Type > const & omapping )

inline

Set mapping to used when writting.

Definition at line 271 of file STK_ReadWriteCsv.h.

272 { omapping_ = omapping;}

STK::TReadWriteCsv::omapping_

std::map< Type, String > omapping_

mapping Type -> String (output)

Definition STK_ReadWriteCsv.h:577

References STK::TReadWriteCsv< Type >::omapping_.

◆ setReserve()

template<typename Type >

void STK::TReadWriteCsv< Type >::setReserve ( int const & reserve ) const

inline

Sets the reserve value for data storage (reserve_ is mutable).

Parameters

reserve number of place to reserve

Definition at line 266 of file STK_ReadWriteCsv.h.

266{ reserve_ = reserve; }

References STK::TReadWriteCsv< Type >::reserve_.

Referenced by STK::TReadWriteCsv< Type >::initRead().

◆ setWithMapping()

template<typename Type >

void STK::TReadWriteCsv< Type >::setWithMapping ( bool with_mapping ) const

inline

Sets the with_mapping_ value for reading/writing variables names.

Parameters

with_mapping true if we want to read the data using a map

Definition at line 258 of file STK_ReadWriteCsv.h.

258{ with_mapping_ = with_mapping; }

References STK::TReadWriteCsv< Type >::with_mapping_.

◆ setWithNames()

template<typename Type >

void STK::TReadWriteCsv< Type >::setWithNames ( bool with_names ) const

inline

Sets the with_names_ value for reading/writing variables names.

Parameters

with_names true if we want to read the names of the variables

Definition at line 254 of file STK_ReadWriteCsv.h.

254{ with_names_ = with_names; }

References STK::TReadWriteCsv< Type >::with_names_.

◆ size()

template<typename Type >

int STK::TReadWriteCsv< Type >::size ( ) const

inline

Returns: The current number of variables of the TReadWriteCsv

Definition at line 170 of file STK_ReadWriteCsv.h.

170{ return str_data_.size(); }

References STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::beginRows(), STK::TReadWriteCsv< Type >::endRows(), STK::TReadWriteCsv< Type >::lastIdxRows(), and STK::TReadWriteCsv< Type >::sizeRows().

◆ sizeCols()

template<typename Type >

int STK::TReadWriteCsv< Type >::sizeCols ( ) const

inline

Returns: The current number of variables of the TReadWriteCsv

Definition at line 179 of file STK_ReadWriteCsv.h.

179{ return str_data_.size(); }

References STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::exporter(), and STK::TReadWriteCsv< Type >::resize().

◆ sizeRow()

template<typename Type >

int STK::TReadWriteCsv< Type >::sizeRow ( int icol ) const

inline

Parameters

icol	index of the column

Returns: the number of element in the column icol

Definition at line 196 of file STK_ReadWriteCsv.h.

196{ return str_data_.at(icol).size();}

References STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::sizeRows().

◆ sizeRows()

template<typename Type >

int STK::TReadWriteCsv< Type >::sizeRows ( ) const

inline

Returns: the size of the samples.

Definition at line 216 of file STK_ReadWriteCsv.h.

    {
      if (size()<= 0) return 0;
      int retVal = sizeRow(begin());
      for (int i=begin()+1; i<end(); i++)
      { retVal = std::max(retVal, sizeRow(i));}
      return retVal;
    }

References STK::TReadWriteCsv< Type >::begin(), STK::TReadWriteCsv< Type >::end(), STK::TReadWriteCsv< Type >::size(), and STK::TReadWriteCsv< Type >::sizeRow().

Referenced by STK::TReadWriteCsv< Type >::exporter(), and STK::TReadWriteCsv< Type >::resize().

◆ var() [1/2]

template<typename Type >

Var const & STK::TReadWriteCsv< Type >::var ( int icol ) const

inline

Returns: a constant reference of the icol variable.

Parameters

icol	index of the col

Definition at line 313 of file STK_ReadWriteCsv.h.

313{ return str_data_.elt(icol); }

References STK::TReadWriteCsv< Type >::str_data_.

◆ var() [2/2]

template<typename Type >

Var & STK::TReadWriteCsv< Type >::var ( int j )

inline

Returns: the variable with the index icol.

Parameters

j	index of the column

Definition at line 309 of file STK_ReadWriteCsv.h.

309{ return str_data_.elt(j); }

References STK::TReadWriteCsv< Type >::str_data_.

Referenced by STK::TReadWriteCsv< Type >::exporter().

◆ withNames()

template<typename Type >

bool STK::TReadWriteCsv< Type >::withNames ( ) const

inline

Returns: with_names value

Definition at line 246 of file STK_ReadWriteCsv.h.

246{ return with_names_; }

References STK::TReadWriteCsv< Type >::with_names_.

◆ write() [1/3]

template<typename Type >

bool STK::TReadWriteCsv< Type >::write ( )

inline

write to the default file with the specified write flags.

Returns: true if successful, false if an error is encountered.

Definition at line 505 of file STK_ReadWriteCsv.h.

505{ return write(file_name_);}

STK::TReadWriteCsv::write

bool write()

write to the default file with the specified write flags.

Definition STK_ReadWriteCsv.h:505

References STK::TReadWriteCsv< Type >::file_name_, and STK::TReadWriteCsv< Type >::write().

Referenced by STK::TReadWriteCsv< Type >::write().

◆ write() [2/3]

template<typename Type >

void STK::TReadWriteCsv< Type >::write ( ostream & os ) const

inline

Write the csv to an output stream.

Parameters

os	the output stream

Definition at line 528 of file STK_ReadWriteCsv.h.

529 { writeSelection(os, beginRows(), lastIdxRows(), begin(), lastIdx());}

STK::TReadWriteCsv::writeSelection

void writeSelection(ostream &os, int top, int bottom, int left, int right) const

Write to output stream a selection based on the coordinates passed (Think of it as highlighting cells...

Definition STK_ReadWriteCsv.h:757

References STK::TReadWriteCsv< Type >::begin(), STK::TReadWriteCsv< Type >::beginRows(), STK::TReadWriteCsv< Type >::lastIdx(), STK::TReadWriteCsv< Type >::lastIdxRows(), and STK::TReadWriteCsv< Type >::writeSelection().

◆ write() [3/3]

template<typename Type >

bool STK::TReadWriteCsv< Type >::write ( std::string const & file_name ) const

inline

Attempts to write the TReadWriteCsv to the location specified by file_name using the delimiters specified by delimiters_.

Parameters

file_name name of the file to write

Returns: true if successful, false if an error is encountered.

Definition at line 511 of file STK_ReadWriteCsv.h.

    {
      file_name_  = file_name;
      try
      {
        ofstream os(file_name.c_str());
        writeSelection( os, beginRows(), lastIdxRows(), begin(), lastIdx());
        os.close();
        return true;
      }
      catch(const Exception& e) { msg_error_ = e.error(); }
      catch(...) { msg_error_ = Csv::ERRORCODES[1]; }
      return false;
    }

References STK::TReadWriteCsv< Type >::begin(), STK::TReadWriteCsv< Type >::beginRows(), STK::IRunnerBase::error(), STK::TReadWriteCsv< Type >::file_name_, STK::TReadWriteCsv< Type >::lastIdx(), STK::TReadWriteCsv< Type >::lastIdxRows(), STK::TReadWriteCsv< Type >::msg_error_, and STK::TReadWriteCsv< Type >::writeSelection().

◆ writeSelection()

template<typename Type >

void STK::TReadWriteCsv< Type >::writeSelection	(	ostream &	os,
		int	top,
		int	bottom,
		int	left,
		int	right
	)		const

Write to output stream a selection based on the coordinates passed (Think of it as highlighting cells in Excel).

Parameters

os	the output stream
top	the top index
bottom	th bottom index
left	the left index
right	the right index

Definition at line 757 of file STK_ReadWriteCsv.h.

{
  if ((right < left)|| (bottom < top)) return;
  // create a vector for the format of the output
  Array1D<String::size_type>  format(Range(left, right, 0), 0);
  // for each variable, find the largest size
  for(int iVar=left; iVar<=right; iVar++)
  { format[iVar] = str_data_[iVar].maxLength(with_names_);}
  // write if needed names variables
  if (with_names_)
  {
    for(int iVar=left; iVar<right; iVar++)
    {
      os << std::setw(int(format[iVar])) << std::right
         << Proxy<String>(str_data_.at(iVar).name())
         << delimiters_.at(0);
    }
    os << std::setw(int(format[right])) << std::right
       << Proxy<String>(str_data_[right].name())
       << _T("\n");
  }
  // write data
  for(int irow = top; irow<bottom; irow++)
  {
    for(int iVar = left; iVar<right; iVar++)
    {
      try
      {
        os << std::setw(format[iVar]) << std::right
           << Proxy<Type>(str_data_[iVar].at(irow));
      }
      catch(...) // if an error occur, we put NA value
      { os << std::setw(format[iVar]) << std::right << stringNa;}
      os <<  delimiters_.at(0);
    }
    try
    {
      os << std::setw(format[right]) << std::right
         << Proxy<Type>(str_data_[right].at(irow));
    }
    catch(...) // if an error occur, we put NA value
    { os << std::setw(format[right]) << std::right << stringNa;}
     os << _T("\n");
  }
  for(int iVar = left; iVar<right; iVar++)
  {
    try
    {
      os << std::setw(format[iVar]) << std::right
         << Proxy<Type>(str_data_[iVar].at(bottom));
    }
    catch(...) // if an error occur, we put NA value
    { os << std::setw(format[iVar]) << std::right << stringNa;}
    os <<  delimiters_.at(0);
  }
  try
  {
    os << std::setw(format[right]) << std::right
       << Proxy<Type>(str_data_[right].at(bottom));
  }
  catch(...) // if an error occur, we put NA value
  { os << std::setw(format[right]) << std::right << stringNa;}
  if (with_last_nl_) { os << _T("\n");}
}

References _T, and STK::stringNa.

Referenced by STK::TReadWriteCsv< Type >::write(), and STK::TReadWriteCsv< Type >::write().

Friends And Related Symbol Documentation

◆ operator<<

template<typename Type >

ostream & operator<<	(	ostream &	os,
		TReadWriteCsv< Type > const &	rw
	)

friend

overload operator << for rw

Definition at line 547 of file STK_ReadWriteCsv.h.

    {
      try
      { rw.writeSelection( os, rw.beginRows(), rw.lastIdxRows(), rw.begin(), rw.lastIdx());}
      // catch and re-throw any Exceptions
      catch(const Exception& e) { throw e; }
      catch(...) { throw Exception(Csv::ERRORCODES[1]); }
      return os;
    }

◆ operator>>

template<typename Type >

istream & operator>>	(	istream &	in,
		TReadWriteCsv< Type > &	rw
	)

friend

overload operator >> for rw

Definition at line 541 of file STK_ReadWriteCsv.h.

    {
      if (!rw.read(in)) throw Exception(rw.msg_error_);
      return in;
    }

Member Data Documentation

◆ delimiters_

template<typename Type >

String STK::TReadWriteCsv< Type >::delimiters_

mutableprotected

Delimiter(s)

Definition at line 567 of file STK_ReadWriteCsv.h.

Referenced by STK::TReadWriteCsv< Type >::clear(), STK::TReadWriteCsv< Type >::countFields(), STK::TReadWriteCsv< Type >::delimiters(), STK::TReadWriteCsv< Type >::operator=(), and STK::TReadWriteCsv< Type >::setDelimiters().

◆ file_name_

template<typename Type >

std::string STK::TReadWriteCsv< Type >::file_name_

mutableprotected

Name of the Current file read.

Definition at line 559 of file STK_ReadWriteCsv.h.

Referenced by STK::TReadWriteCsv< Type >::operator=(), STK::TReadWriteCsv< Type >::read(), STK::TReadWriteCsv< Type >::read(), STK::TReadWriteCsv< Type >::read(), STK::TReadWriteCsv< Type >::write(), and STK::TReadWriteCsv< Type >::write().

◆ imapping_

template<typename Type >

std::map<String, Type> STK::TReadWriteCsv< Type >::imapping_

protected

mapping String -> Type for (input)

Definition at line 575 of file STK_ReadWriteCsv.h.

Referenced by STK::TReadWriteCsv< Type >::setInMapping().

◆ msg_error_

template<typename Type >

String STK::TReadWriteCsv< Type >::msg_error_

mutableprotected

Contain the last error message.

Definition at line 571 of file STK_ReadWriteCsv.h.

Referenced by STK::TReadWriteCsv< Type >::appendData(), STK::TReadWriteCsv< Type >::clear(), STK::TReadWriteCsv< Type >::eraseColumn(), STK::TReadWriteCsv< Type >::error(), STK::TReadWriteCsv< Type >::operator=(), STK::TReadWriteCsv< Type >::push_back(), STK::TReadWriteCsv< Type >::push_front(), STK::TReadWriteCsv< Type >::read(), STK::TReadWriteCsv< Type >::setName(), and STK::TReadWriteCsv< Type >::write().

◆ nbRows_

template<typename Type >

int STK::TReadWriteCsv< Type >::nbRows_

protected

The number of rows we manage.

Definition at line 581 of file STK_ReadWriteCsv.h.

Referenced by STK::TReadWriteCsv< Type >::initRead(), STK::TReadWriteCsv< Type >::operator=(), and STK::TReadWriteCsv< Type >::readNames().

◆ nbVars_

template<typename Type >

int STK::TReadWriteCsv< Type >::nbVars_

protected

The number of variables we manage.

Definition at line 579 of file STK_ReadWriteCsv.h.

Referenced by STK::TReadWriteCsv< Type >::countFields(), STK::TReadWriteCsv< Type >::initRead(), STK::TReadWriteCsv< Type >::operator=(), and STK::TReadWriteCsv< Type >::readNames().

◆ omapping_

template<typename Type >

std::map<Type, String> STK::TReadWriteCsv< Type >::omapping_

protected

mapping Type -> String (output)

Definition at line 577 of file STK_ReadWriteCsv.h.

Referenced by STK::TReadWriteCsv< Type >::setOutMapping().

◆ reserve_

template<typename Type >

int STK::TReadWriteCsv< Type >::reserve_

mutableprotected

Size of the buffer.

Definition at line 569 of file STK_ReadWriteCsv.h.

Referenced by STK::TReadWriteCsv< Type >::clear(), STK::TReadWriteCsv< Type >::operator=(), and STK::TReadWriteCsv< Type >::setReserve().

◆ str_data_

template<typename Type >

Array1D< Var > STK::TReadWriteCsv< Type >::str_data_

protected

Array of array for the data.

Definition at line 573 of file STK_ReadWriteCsv.h.

◆ with_last_nl_

template<typename Type >

bool STK::TReadWriteCsv< Type >::with_last_nl_

mutableprotected

write a new line character at the end of the output

Definition at line 565 of file STK_ReadWriteCsv.h.

Referenced by STK::TReadWriteCsv< Type >::clear(), and STK::TReadWriteCsv< Type >::setLast_nl().

◆ with_mapping_

template<typename Type >

bool STK::TReadWriteCsv< Type >::with_mapping_

mutableprotected

map the values stored

Definition at line 563 of file STK_ReadWriteCsv.h.

Referenced by STK::TReadWriteCsv< Type >::clear(), and STK::TReadWriteCsv< Type >::setWithMapping().

◆ with_names_

template<typename Type >

bool STK::TReadWriteCsv< Type >::with_names_

mutableprotected

Read or Write names of the variables.

Definition at line 561 of file STK_ReadWriteCsv.h.

Referenced by STK::TReadWriteCsv< Type >::clear(), STK::TReadWriteCsv< Type >::initRead(), STK::TReadWriteCsv< Type >::operator=(), STK::TReadWriteCsv< Type >::setWithNames(), and STK::TReadWriteCsv< Type >::withNames().

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

STK_ReadWriteCsv.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Var

Constructor & Destructor Documentation

◆ TReadWriteCsv() [1/3]

◆ TReadWriteCsv() [2/3]

◆ TReadWriteCsv() [3/3]

◆ ~TReadWriteCsv()

Member Function Documentation

◆ appendData()

◆ at() [1/2]

◆ at() [2/2]

◆ back() [1/2]

◆ back() [2/2]

◆ begin()

◆ beginCols()

◆ beginRows()

◆ clear()

◆ clone()

◆ cols()

◆ countFields()

◆ delimiters()

◆ end()

◆ endCols()

◆ endRow()

◆ endRows()

◆ eraseColumn()

◆ error()

◆ exporter()

◆ fastSetData()

◆ firstRow()

◆ front() [1/2]

◆ front() [2/2]

◆ initRead()

◆ lastIdx()

◆ lastIdxCols()

◆ lastIdxRows()

◆ lastRow()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator+()

◆ operator+=()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ push_back()

◆ push_front()

◆ read() [1/4]

◆ read() [2/4]

◆ read() [3/4]

◆ read() [4/4]

◆ readCurrentLine()

◆ readNames()

◆ resize()

◆ resizeCols()

◆ resizeRows()

◆ rows()

◆ setDelimiters()

◆ setInMapping()

◆ setLast_nl()

◆ setName()

◆ setOutMapping()

◆ setReserve()

◆ setWithMapping()

◆ setWithNames()

◆ size()

◆ sizeCols()

◆ sizeRow()

◆ sizeRows()

◆ var() [1/2]

◆ var() [2/2]

◆ withNames()

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]