Export data to a Csv. More...

#include <STK_ExportToCsv.h>

Public Member Functions
	ExportToCsv ()
	Default constructor.

	ExportToCsv (DataFrame const &df)
	Constructor : create an instance of ExportToCvs with a DataFrame.

template<class Type >
	ExportToCsv (TReadWriteCsv< Type > const &rw)
	Constructor : create an instance of ExportToCvs with a ReadWriteCsv.

template<class Container >
	ExportToCsv (ITContainer1D< Container > const &A, bool byCol=true, String const &prefix=Csv::DEFAULT_COLUMN_PREFIX)
	Instantiates an instance of ExportToCvs with an Array1D, a list1D, etc....

template<class Container >
	ExportToCsv (ITContainer< Container, Arrays::vector_ > const &A, bool byCol=true, String const &prefix=Csv::DEFAULT_COLUMN_PREFIX)
	Instantiates an instance of ExportToCvs with a vector.

template<class Container >
	ExportToCsv (ITContainer< Container, Arrays::point_ > const &A, bool byCol=false, String const &prefix=Csv::DEFAULT_COLUMN_PREFIX)
	Instantiates an instance of ExportToCvs with a point.

template<class Container >
	ExportToCsv (ITContainer< Container > const &A, String const &prefix=Csv::DEFAULT_COLUMN_PREFIX)
	Instantiates an instance of ExportToCvs with a general array.

	~ExportToCsv ()
	destructor.

template<class Container >
void	append (ITContainer< Container, Arrays::vector_ > const &A, String const &prefix=Csv::DEFAULT_COLUMN_PREFIX)
	Append a vector.

template<class Container >
void	append (ITContainer< Container, Arrays::point_ > const &A, String const &prefix=Csv::DEFAULT_COLUMN_PREFIX)
	Append a point (as a column vector).

template<class Container >
void	append (ITContainer< Container, Arrays::array2D_ > const &A, String const &prefix=Csv::DEFAULT_COLUMN_PREFIX)
	Append a 2D container.

template<class Container >
void	append (ITContainer< Container, Arrays::square_ > const &A, String const &prefix=Csv::DEFAULT_COLUMN_PREFIX)
	Append a 2D container.

template<class TYPE >
void	appendData (TYPE const &A, String const &prefix=Csv::DEFAULT_COLUMN_PREFIX)
	Append a value.

void	setColumnsNames (String const &prefix=Csv::DEFAULT_COLUMN_PREFIX)
	Set a name to each column of the ReadWriteCsv using the form prefix + number.

ReadWriteCsv *const	p_readWriteCsv () const
	Accesor.

void	release ()
	release the ReadWriteCsv.

Protected Attributes
ReadWriteCsv *	p_data_
	ptr on the ReadWriteCsv containing the data.

Detailed Description

Export data to a Csv.

An ExportToCsv object creates a ReadWriteCsv from a container of data like a DataFrame, a Vector, a point or a ArrayXX. The data are stored in a String format in the ReadWriteCsv struct.

Definition at line 62 of file STK_ExportToCsv.h.

Constructor & Destructor Documentation

◆ ExportToCsv() [1/7]

STK::ExportToCsv::ExportToCsv ( )

inline

Default constructor.

Create an instance of ExportToCvs.

Definition at line 66 of file STK_ExportToCsv.h.

66: p_data_(new ReadWriteCsv()) {}

STK::ExportToCsv::p_data_

ReadWriteCsv * p_data_

ptr on the ReadWriteCsv containing the data.

Definition STK_ExportToCsv.h:292

STK::ReadWriteCsv

class TReadWriteCsv< String > ReadWriteCsv

Definition STK_ReadWriteCsv.h:51

◆ ExportToCsv() [2/7]

STK::ExportToCsv::ExportToCsv ( DataFrame const & df )

inline

Constructor : create an instance of ExportToCvs with a DataFrame.

Parameters

df	the DataFrame to export

Definition at line 70 of file STK_ExportToCsv.h.

                                            : p_data_(new ReadWriteCsv())
    {
      p_data_->setReserve(df.sizeRows());
      p_data_->resize(df.sizeRows(), df.sizeCols());
      // for each field Try a String conversion
      for(int iVar = df.beginCols(), irw = p_data_->begin(); iVar<df.endCols(); iVar++, irw++)
      { if (df.elt(iVar)) df.elt(iVar)->exportAsString(p_data_->var(irw));}
    }

References STK::DataFrame::beginCols(), STK::DataFrame::elt(), STK::DataFrame::endCols(), STK::IVariable::exportAsString(), p_data_, STK::DataFrame::sizeCols(), and STK::DataFrame::sizeRows().

◆ ExportToCsv() [3/7]

template<class Type >

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

inline

Constructor : create an instance of ExportToCvs with a ReadWriteCsv.

Parameters

rw	the TReadWriteCsv to export

Definition at line 82 of file STK_ExportToCsv.h.

                                               : p_data_(new ReadWriteCsv())
    {
      p_data_->setReserve(rw.sizeRows());
      p_data_->resize(rw.sizeRows(), rw.sizeCols());
      p_data_->setWithNames(rw.withNames());
      // for each field Try a String conversion
      for(int iRw = rw.beginCols(), iData = p_data_->begin(); iRw<rw.endCols(); iRw++, iData++)
      { rw.var(iRw).exportAsString(p_data_->var(iData));}
    }

References p_data_.

◆ ExportToCsv() [4/7]

template<class Container >

STK::ExportToCsv::ExportToCsv	(	ITContainer1D< Container > const &	A,
		bool	byCol = `true`,
		String const &	prefix = `Csv::DEFAULT_COLUMN_PREFIX`
	)

inline

Instantiates an instance of ExportToCvs with an Array1D, a list1D, etc....

Parameters

A	the 1D container to export
byCol	export the container as a column vector or a row vector ?
prefix	the prefix of the name to set to the variable

Definition at line 98 of file STK_ExportToCsv.h.

               : p_data_(new ReadWriteCsv())
    {
#ifdef STK_DMANAGER_DEBUG
      stk_cout << "Entering ExportToCsv( ITContainer1D<Container> const& A, byCol, prefix)\n";
      stk_cout << "A.range()= " << A.range()  << "\n";
#endif
      // add an empty string variable (an empty column)
      p_data_->setWithNames(true);
      if (byCol)
      { // add to ReadWriteCsv a new variable
        //p_data_->
        p_data_->push_back(Variable<String>(A.range(), prefix));
 
        for(int i = A.begin(); i<A.end(); i++)
        { p_data_->back()[i] = typeToString(A.at(i));}
      }
      else // by row
      {
        for(int i = A.begin(); i<A.end(); i++)
        { p_data_->push_back( Variable<String>(1, typeToString(A.at(i)), prefix+typeToString(i)) );}
      }
    }

References p_data_, stk_cout, and STK::typeToString().

◆ ExportToCsv() [5/7]

template<class Container >

STK::ExportToCsv::ExportToCsv	(	ITContainer< Container, Arrays::vector_ > const &	A,
		bool	byCol = `true`,
		String const &	prefix = `Csv::DEFAULT_COLUMN_PREFIX`
	)

inline

Instantiates an instance of ExportToCvs with a vector.

Parameters

A	the ITContainer to export
byCol	export the container as a column vector or a raw vector ?
prefix	the prefix of the name to set to the variable

Definition at line 130 of file STK_ExportToCsv.h.

               : p_data_(new ReadWriteCsv())
    {
        // add an empty string variable (an empty column)
        p_data_->setWithNames(true);
        if (byCol)
        {
          p_data_->push_back(Variable<String>(A.range(), prefix));
 
          for(int i = A.begin(); i<A.end(); i++)
          { p_data_->back()[i] = typeToString(A.at(i));}
        }
        else
        {
          for(int i = A.begin(); i<A.end(); i++)
          {
            p_data_->push_back(Variable<String>(1, prefix+typeToString(i)));
            p_data_->back().front() = typeToString(A.at(i));
          }
        }
    }

References p_data_, and STK::typeToString().

◆ ExportToCsv() [6/7]

template<class Container >

STK::ExportToCsv::ExportToCsv	(	ITContainer< Container, Arrays::point_ > const &	A,
		bool	byCol = `false`,
		String const &	prefix = `Csv::DEFAULT_COLUMN_PREFIX`
	)

inline

Instantiates an instance of ExportToCvs with a point.

Parameters

A	the ITContainer1D to export
byCol	export the container as a column vector or a raw vector ?
prefix	the prefix ot the name to set to the variable

Definition at line 159 of file STK_ExportToCsv.h.

               : p_data_(new ReadWriteCsv())
    {
        // add an empty string variable (an empty column)
        p_data_->setWithNames(true);
        if (byCol)
        {
          p_data_->push_back(Variable<String>(A.range(), prefix));
 
          for(int i = A.begin(); i<A.end(); i++)
          { p_data_->back()[i] = typeToString(A.at(i));}
        }
        else
        {
          for(int i = A.begin(); i<A.end(); i++)
          {
            p_data_->push_back(Variable<String>(1, prefix+typeToString(i)));
            p_data_->back().front() = typeToString(A.at(i));
          }
        }
    }

References p_data_, and STK::typeToString().

◆ ExportToCsv() [7/7]

template<class Container >

STK::ExportToCsv::ExportToCsv	(	ITContainer< Container > const &	A,
		String const &	prefix = `Csv::DEFAULT_COLUMN_PREFIX`
	)

inline

Instantiates an instance of ExportToCvs with a general array.

Parameters

A	the IArray2d to export
prefix	the prefix ot the name to set to the variable

Definition at line 187 of file STK_ExportToCsv.h.

               : p_data_(new ReadWriteCsv())
    {
      p_data_->setWithNames(true);
      for(int iVar = A.beginCols(); iVar<A.endCols(); iVar++)
      {
        // add an empty string variable (an empty column)
        p_data_->push_back(Variable<String>(A.rows(), prefix));
        for (int iRow=A.beginRows(); iRow<A.endRows(); iRow++)
        { p_data_->back()[iRow] = typeToString(A.at(iRow,iVar));}
      }
    }

References p_data_, and STK::typeToString().

◆ ~ExportToCsv()

STK::ExportToCsv::~ExportToCsv ( )

inline

destructor.

The protected field p_data_ will be liberated.

Definition at line 204 of file STK_ExportToCsv.h.

204{ if (p_data_) delete p_data_;}

References p_data_.

Member Function Documentation

◆ append() [1/4]

template<class Container >

void STK::ExportToCsv::append	(	ITContainer< Container, Arrays::array2D_ > const &	A,
		String const &	prefix = `Csv::DEFAULT_COLUMN_PREFIX`
	)

inline

Append a 2D container.

Parameters

A	the container to export
prefix	the prefix ot the name to set to the variable

Definition at line 236 of file STK_ExportToCsv.h.

    {
      // for each field try a String conversion
      for(int iVar = A.beginCols(), iNum=1; iVar<A.endCols(); iVar++, iNum++)
      {
        // add an empty string variable (an empty column)
        p_data_->push_back(Variable<String>(A.rows(), prefix+typeToString(iNum)));
        for (int iRow=A.beginRows(); iRow<A.endRows(); iRow++)
        { p_data_->back()[iRow] = typeToString(A.elt(iRow,iVar));}
      }
    }

References p_data_, and STK::typeToString().

◆ append() [2/4]

template<class Container >

void STK::ExportToCsv::append	(	ITContainer< Container, Arrays::point_ > const &	A,
		String const &	prefix = `Csv::DEFAULT_COLUMN_PREFIX`
	)

inline

Append a point (as a column vector).

Parameters

A	the container to export
prefix	the prefix ot the name to set to the variable

Definition at line 223 of file STK_ExportToCsv.h.

    {
      // add an empty string variable
      p_data_->push_back(Variable<String>(A.range(), prefix));
      // add strings to the String variable
      for(int i = A.begin(); i< A.end(); i++)
      { p_data_->back()[i] = typeToString(A.elt(i));}
    }

References p_data_, and STK::typeToString().

◆ append() [3/4]

template<class Container >

void STK::ExportToCsv::append	(	ITContainer< Container, Arrays::square_ > const &	A,
		String const &	prefix = `Csv::DEFAULT_COLUMN_PREFIX`
	)

inline

Append a 2D container.

Parameters

A	the container to export
prefix	the prefix ot the name to set to the variable

Definition at line 252 of file STK_ExportToCsv.h.

    {
      // for each field try a String conversion
      for(int iVar = A.beginCols(), iNum=1; iVar<A.endCols(); iVar++, iNum++)
      {
        // add an empty string variable (an empty column)
        p_data_->push_back(Variable<String>(A.rows(), prefix+typeToString(iNum)));
        for (int iRow=A.beginRows(); iRow<A.endRows(); iRow++)
        { p_data_->back()[iRow] = typeToString(A.elt(iRow,iVar));}
      }
    }

References p_data_, and STK::typeToString().

◆ append() [4/4]

template<class Container >

void STK::ExportToCsv::append	(	ITContainer< Container, Arrays::vector_ > const &	A,
		String const &	prefix = `Csv::DEFAULT_COLUMN_PREFIX`
	)

inline

Append a vector.

Parameters

A	the container to export
prefix	the prefix ot the name to set to the variable

Definition at line 210 of file STK_ExportToCsv.h.

    {
      // add an empty string variable
      p_data_->push_back(Variable<String>(A.range(), prefix));
      // add strings to the String variable
      for(int i = A.begin(); i< A.end(); i++)
      { p_data_->back()[i] = typeToString(A.elt(i));}
    }

References p_data_, and STK::typeToString().

◆ appendData()

template<class TYPE >

void STK::ExportToCsv::appendData	(	TYPE const &	A,
		String const &	prefix = `Csv::DEFAULT_COLUMN_PREFIX`
	)

inline

Append a value.

Parameters

A	the value to export
prefix	the prefix ot the name to set to the variable

Definition at line 268 of file STK_ExportToCsv.h.

    {
      // add an empty string variable
      p_data_->push_back(Variable<String>( prefix + typeToString(p_data_->lastIdx())) );
      // add strings to the String variable
      p_data_->back().push_back(typeToString(A));
    }

References p_data_, and STK::typeToString().

◆ p_readWriteCsv()

ReadWriteCsv *const STK::ExportToCsv::p_readWriteCsv ( ) const

inline

Accesor.

Return a ptr on the the ReadWriteCsv.

Definition at line 286 of file STK_ExportToCsv.h.

286{ return p_data_;}

References p_data_.

◆ release()

void STK::ExportToCsv::release ( )

inline

release the ReadWriteCsv.

It will be freed by the user.

Definition at line 288 of file STK_ExportToCsv.h.

288{ p_data_ =0;}

References p_data_.

◆ setColumnsNames()

void STK::ExportToCsv::setColumnsNames ( String const & prefix = Csv::DEFAULT_COLUMN_PREFIX )

inline

Set a name to each column of the ReadWriteCsv using the form prefix + number.

Parameters

prefix the prefix to use for the names of the columns

Definition at line 279 of file STK_ExportToCsv.h.

    {
      for(int i = p_data_->begin(); i<p_data_->end(); i++)
      { p_data_->setName(i, prefix + typeToString(i)) ;}
    }

References p_data_, and STK::typeToString().

Member Data Documentation

◆ p_data_

ReadWriteCsv* STK::ExportToCsv::p_data_

protected

ptr on the ReadWriteCsv containing the data.

Definition at line 292 of file STK_ExportToCsv.h.

Referenced by append(), append(), append(), append(), appendData(), ExportToCsv(), ExportToCsv(), ExportToCsv(), ExportToCsv(), ExportToCsv(), ExportToCsv(), p_readWriteCsv(), release(), setColumnsNames(), and ~ExportToCsv().

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

STK_ExportToCsv.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ExportToCsv() [1/7]

◆ ExportToCsv() [2/7]

◆ ExportToCsv() [3/7]

◆ ExportToCsv() [4/7]

◆ ExportToCsv() [5/7]

◆ ExportToCsv() [6/7]

◆ ExportToCsv() [7/7]

◆ ~ExportToCsv()

Member Function Documentation

◆ append() [1/4]

◆ append() [2/4]

◆ append() [3/4]

◆ append() [4/4]

◆ appendData()

◆ p_readWriteCsv()

◆ release()

◆ setColumnsNames()

Member Data Documentation

◆ p_data_