STK::ImportFromCsv Class Reference

import data from a Csv File in a DataFrame. More...

#include <STK_ImportFromCsv.h>

Inheritance diagram for STK::ImportFromCsv:

Public Member Functions
	ImportFromCsv (ReadWriteCsv const &import, Import::TypeImport type=Import::numeric_)
	Constructor.
	ImportFromCsv (ImportFromCsv const &import)
	Copy Constructor.
virtual	~ImportFromCsv ()
	destructor.
ImportFromCsv *	clone () const
	clone pattern.
void	setTypeImport (Import::TypeImport typeImport)
	set the type of import the end user want
DataFrame const *	dataFrame () const
void	release ()
	Release the dataFrame.
bool	run ()
	launch the importation of the ReadWriteCsv to the DataFrame.
template<class Other >
bool	import (Array1D< int > const &indexes)
	launch the importation of the ReadWriteCsv to the DataFrame.
Public Member Functions inherited from STK::IRunnerBase
String const &	error () const
	get the last error message.

Protected Member Functions
template<class Other >
int	import (int const &iCol, Variable< Other > &var)
	convert a column of the csv in a variable of type Type
Protected Member Functions inherited from STK::IRunnerBase
	IRunnerBase ()
	default constructor
	IRunnerBase (IRunnerBase const &runner)
	copy constructor
virtual	~IRunnerBase ()
	destructor
virtual void	update ()
	update the runner.

Protected Attributes
DataFrame *	p_dataFrame_
	A ptr on the resulting DataFrame.
Import::TypeImport	typeImport_
	the type of import we want to perform.
Protected Attributes inherited from STK::IRunnerBase
String	msg_error_
	String with the last error message.
bool	hasRun_
	true if run has been used, false otherwise

Private Member Functions
bool	asNumeric ()
	launch the conversion from the ReadWriteCsv to a DataFrame with a numeric conversion.
bool	asOnlyNumeric ()
	launch the conversion from the ReadWriteCsv to a DataFrame with only the successful numeric conversion.
bool	asString ()
	launch the conversion from the ReadWriteCsv to a DataFrame as String.

Private Attributes
ReadWriteCsv const &	import_
	a constant reference on the the original ReadWriteCsv.

Detailed Description

import data from a Csv File in a DataFrame.

A ImportFromCsv object create a DataFrame from a given ReadWriteCsv object. It will try to convert the given ReadWriteCsv to the predefined type given by the user.

Definition at line 56 of file STK_ImportFromCsv.h.

Constructor & Destructor Documentation

ImportFromCsv() [1/2]

STK::ImportFromCsv::ImportFromCsv	(	ReadWriteCsv const &	import,
		Import::TypeImport	type = Import::numeric_
	)

Constructor.

Instantiates an instance of ImportFromCvs with the readWriteCsv to import.

Parameters

import	the ReadWriteCsv to import
type	the kind of import we want to perform

Definition at line 44 of file STK_ImportFromCsv.cpp.

                            : p_dataFrame_(0)
                            , typeImport_(type)
                            , import_(import)
{}

ImportFromCsv() [2/2]

STK::ImportFromCsv::ImportFromCsv

(

ImportFromCsv const &

import

)

Copy Constructor.

Parameters

import

the ImportFromCsv to import

Definition at line 53 of file STK_ImportFromCsv.cpp.

                            : p_dataFrame_(import.p_dataFrame_)
                            , typeImport_(import.typeImport_)
                            , import_(import.import_)
{}

~ImportFromCsv()

STK::ImportFromCsv::~ImportFromCsv ( )

virtual

destructor.

Definition at line 60 of file STK_ImportFromCsv.cpp.

{ if (p_dataFrame_) delete p_dataFrame_; }

References p_dataFrame_.

Member Function Documentation

asNumeric()

bool STK::ImportFromCsv::asNumeric ( )

private

launch the conversion from the ReadWriteCsv to a DataFrame with a numeric conversion.

Definition at line 87 of file STK_ImportFromCsv.cpp.

{
  try
  {
    // for each field Try a numeric conversion
    for (int j =import_.begin(); j <=import_.lastIdx(); j++)
    {
      Variable<Real>* pvReal = new Variable<Real>();
      // test number of successful conversion
      if (import<Real>(j, *pvReal)==import_.sizeRow(j))
      {  // if no failure add variable to the dataframe
         p_dataFrame_->pushBackVariable(pvReal);
      }
      else
      {
        delete pvReal; // delete varReal
        Variable<String>* pvString = import_.clone(j);
        p_dataFrame_->pushBackVariable(pvString);
      }
    }
  }
  catch(const Exception& error)
  {
    msg_error_  = error.error();
    msg_error_ += _T("\nIn ImportCsv::runNumeric()");
    return false;
  }
  return true;
}

References _T, STK::IRunnerBase::error(), import_, STK::IRunnerBase::msg_error_, p_dataFrame_, and STK::DataFrame::pushBackVariable().

Referenced by run().

asOnlyNumeric()

bool STK::ImportFromCsv::asOnlyNumeric ( )

private

launch the conversion from the ReadWriteCsv to a DataFrame with only the successful numeric conversion.

launch the conversion from the ReadWriteCsv to a Frame.

Definition at line 118 of file STK_ImportFromCsv.cpp.

{
  try
  {
    // for each field Try a numeric conversion
    for (int j =import_.begin(); j <import_.end(); j++)
    {
      Variable<Real>* pvReal = new Variable<Real>;
      // test number of successful conversion
      if (import<Real>(j, *pvReal) == import_.sizeRow(j))
      {  // if no failure add variable to the dataframe
         p_dataFrame_->pushBackVariable(pvReal);
      }
      else delete pvReal;
    }
  }
  catch(const Exception& error)
  {
    msg_error_ += _T("Error in ImportCsv::runOnlyNumeric()\n");
    msg_error_ += error.error();
    return false;
  }
  return true;
}

References _T, STK::IRunnerBase::error(), import_, STK::IRunnerBase::msg_error_, p_dataFrame_, and STK::DataFrame::pushBackVariable().

Referenced by run().

asString()

bool STK::ImportFromCsv::asString ( )

private

launch the conversion from the ReadWriteCsv to a DataFrame as String.

Definition at line 144 of file STK_ImportFromCsv.cpp.

{
  try
  {
    // for each field Try a numeric conversion
    for (int j =import_.begin(); j <=import_.lastIdx(); j++)
    {
      Variable<String>* pvString = import_.clone(j);
      p_dataFrame_->pushBackVariable(pvString);
    }
  }
  catch(const Exception& error)
  {
    msg_error_ += _T("Error in ImportCsv::runString()\n");
    msg_error_ += error.error();
    return false;
  }
  return true;
}

References _T, STK::IRunnerBase::error(), import_, STK::IRunnerBase::msg_error_, p_dataFrame_, and STK::DataFrame::pushBackVariable().

Referenced by run().

clone()

ImportFromCsv * STK::ImportFromCsv::clone ( ) const

inline

clone pattern.

Definition at line 72 of file STK_ImportFromCsv.h.

{ return new ImportFromCsv(*this);}

dataFrame()

DataFrame const * STK::ImportFromCsv::dataFrame ( ) const

inline

Returns

a ptr on the the data read.

Definition at line 77 of file STK_ImportFromCsv.h.

{ return p_dataFrame_;}

References p_dataFrame_.

import() [1/2]

template<class Other >

bool STK::ImportFromCsv::import ( Array1D< int > const &  indexes )

inline

launch the importation of the ReadWriteCsv to the DataFrame.

Returns

true if the importation is successful, false otherwise

Definition at line 94 of file STK_ImportFromCsv.h.

    { return false;}

import() [2/2]

template<class Other >

int STK::ImportFromCsv::import ( int const &  iCol, Variable< Other > &  var  )

inlineprotected

convert a column of the csv in a variable of type Type

Parameters

iCol	the column to convert
var	the variable storing the result

Returns

true if the conversion is successful, false otherwise

Definition at line 108 of file STK_ImportFromCsv.h.

    { return var.importFromString(import_[iCol]);}

References import_.

release()

void STK::ImportFromCsv::release ( )

inline

Release the dataFrame.

Definition at line 79 of file STK_ImportFromCsv.h.

{ p_dataFrame_ = 0;}

References p_dataFrame_.

run()

bool STK::ImportFromCsv::run ( )

virtual

launch the importation of the ReadWriteCsv to the DataFrame.

The call to this method will be without effect if the TypeImport is directed_. In this case use the

bool import( Array1D<int> const& indexes)

method.

Returns

true if the importation is successful, false otherwise

Implements STK::IRunnerBase.

Definition at line 64 of file STK_ImportFromCsv.cpp.

{
  msg_error_ = _T("");
  if (!p_dataFrame_) p_dataFrame_ = new DataFrame;
  switch (typeImport_)
  {
    case Import::numeric_:
      return asNumeric();
      break;
    case Import::only_numeric_:
      return asOnlyNumeric();
      break;
    case Import::string_:
      return asString();
      break;
    default:
      return false;
      break;
  };
  return false; // avoid warning
}

References _T, asNumeric(), asOnlyNumeric(), asString(), STK::IRunnerBase::msg_error_, STK::Import::numeric_, STK::Import::only_numeric_, p_dataFrame_, STK::Import::string_, and typeImport_.

setTypeImport()

void STK::ImportFromCsv::setTypeImport ( Import::TypeImport  typeImport )

inline

set the type of import the end user want

Definition at line 74 of file STK_ImportFromCsv.h.

{ typeImport_ = typeImport;}

References typeImport_.

Member Data Documentation

import_

ReadWriteCsv const& STK::ImportFromCsv::import_

private

a constant reference on the the original ReadWriteCsv.

Definition at line 113 of file STK_ImportFromCsv.h.

Referenced by asNumeric(), asOnlyNumeric(), asString(), and import().

p_dataFrame_

DataFrame* STK::ImportFromCsv::p_dataFrame_

protected

A ptr on the resulting DataFrame.

Definition at line 99 of file STK_ImportFromCsv.h.

Referenced by asNumeric(), asOnlyNumeric(), asString(), dataFrame(), release(), run(), and ~ImportFromCsv().

typeImport_

Import::TypeImport STK::ImportFromCsv::typeImport_

protected

the type of import we want to perform.

Definition at line 101 of file STK_ImportFromCsv.h.

Referenced by run(), and setTypeImport().

---

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

• STK_ImportFromCsv.h
• STK_ImportFromCsv.cpp