AsciiInput Class Reference

A class to provide read access to an ASCII input file. More...

#include <AsciiInput.h>

Collaboration diagram for AsciiInput:

Public Member Functions
	AsciiInput (const std::string &fileName)
	~AsciiInput ()
int	open ()
	Open the input file.
int	close ()
	Close the input file.
std::vector< std::string >	readRow ()
	Read one line of the input text file into a vector of strings.

Static Public Member Functions
static std::vector< std::string >	strToStrVec (const std::string &inputString)
	A helper function to convert a string into a string vector, by using any number of space or tab characters as separators.
static long	strToLong (const std::string &inputString)
	A helper function to convert a string to a long value.
static double	strToDouble (const std::string &inputString)
	A helper function to convert a string to a double value.

Private Attributes
std::string	m_fileName
	Input file name.
std::ifstream	m_file
	Input file stream.
char	m_lineBuffer [MAX_LINE_LENGTH]
	Character buffers used while parsing the input file.

Static Private Attributes
static const int	MAX_LINE_LENGTH = 500
	Size of the character buffers.

Detailed Description

A class to provide read access to an ASCII input file.

Author

W. H. Bell W.Bel.nosp@m.l@ce.nosp@m.rn.ch

Definition at line 18 of file AsciiInput.h.

Constructor & Destructor Documentation

AsciiInput()

AsciiInput::AsciiInput

(

const std::string &

fileName

)

Definition at line 9 of file AsciiInput.cxx.

                                               : m_fileName(fileName),
                                                     m_file() {
  for(int i=0; i< MAX_LINE_LENGTH;i++ )
    m_lineBuffer[i]='\0';
}

~AsciiInput()

AsciiInput::~AsciiInput

(

)

Definition at line 17 of file AsciiInput.cxx.

                        {
}

Member Function Documentation

close()

int AsciiInput::close

(

)

Close the input file.

A non-zero value is returned if this is not successful.

Definition at line 32 of file AsciiInput.cxx.

                      {
  if(m_file.is_open()) {
    m_file.close();
  }
 
  return 0;
}

open()

int AsciiInput::open

(

)

Open the input file.

A non-zero value is returned if this is not successful.

Definition at line 22 of file AsciiInput.cxx.

                     {
  m_file.open(m_fileName.c_str());
  if(!m_file) {
    std::cerr << "Error: could not open " << m_fileName << std::endl;
    return 1;
  }
  
  return 0;
}

readRow()

std::vector< std::string > AsciiInput::readRow

(

)

Read one line of the input text file into a vector of strings.

Any number of space or tab characters are used as separators. If the row contains only separators or the end of file has been reached the returned vector will be empty.

Definition at line 42 of file AsciiInput.cxx.

                                         {
  std::vector<std::string> row;
 
  // Check if the end of file has been reached.
  if(m_file.eof()) {
    std::cout << "End of file reached."  << std::endl;
    return row;
  }
 
  // Read one line from the input file.  (Need one additional character
  // for string termination of a word.)
  m_file.getline(m_lineBuffer,MAX_LINE_LENGTH-1);
  if(m_file.eof()) { // True when normally reaching the end of the file.
    return row;
  }
  
  // Convert the cstring to a string.
  std::string tmpString(m_lineBuffer);
 
  // Split the string into substrings.
  return strToStrVec(tmpString);
}

strToDouble()

double AsciiInput::strToDouble ( const std::string & inputString )

static

A helper function to convert a string to a double value.

Definition at line 122 of file AsciiInput.cxx.

                                                           {
  double doubleValue;
  std::istringstream inStr(inputString);
  inStr >> doubleValue;
  return doubleValue;
}

strToLong()

long AsciiInput::strToLong ( const std::string & inputString )

static

A helper function to convert a string to a long value.

Definition at line 113 of file AsciiInput.cxx.

                                                       {
  long longValue;
  std::istringstream inStr(inputString);
  inStr >> longValue;
  return longValue;
}

strToStrVec()

std::vector< std::string > AsciiInput::strToStrVec ( const std::string & inputString )

static

A helper function to convert a string into a string vector, by using any number of space or tab characters as separators.

Definition at line 67 of file AsciiInput.cxx.

                                                                         {
  std::vector<std::string> strVec;
  std::string tmpString;
  size_t stringLength, i;
  
  stringLength = inputString.length();
 
  // Loop over all characters in the string.
  i=0;
  while(i<stringLength) {
 
    // Skip over any white spaces at the start of the string.
    while(inputString[i] == ' ' || 
      inputString[i] == '\t') {
      i++;
      if(i >= stringLength) break;
    }
    
    if(i>=stringLength) continue;
    
    // Copy all non-white space characters until a white space, end of string or comment character.
    tmpString.clear();
    while(inputString[i] != ' ' &&
      inputString[i] != '\t' && 
      inputString[i] != '#') {
      tmpString.push_back(inputString[i]);
      i++;
      if(i >= stringLength) break;
    }
 
    // Push the string back if its length is greater than zero.
    if(tmpString.length() > 0) {
      strVec.push_back(tmpString);
    }
 
    // Check if a comment was found.
    if(i < stringLength) {
      if(inputString[i] == '#') break;
    }
  }
 
  return strVec;
}

Member Data Documentation

m_file

std::ifstream AsciiInput::m_file

private

Input file stream.

Definition at line 53 of file AsciiInput.h.

m_fileName

std::string AsciiInput::m_fileName

private

Input file name.

Definition at line 50 of file AsciiInput.h.

m_lineBuffer

char AsciiInput::m_lineBuffer[MAX_LINE_LENGTH]

private

Character buffers used while parsing the input file.

Definition at line 59 of file AsciiInput.h.

MAX_LINE_LENGTH

const int AsciiInput::MAX_LINE_LENGTH = 500

staticprivate

Size of the character buffers.

Definition at line 56 of file AsciiInput.h.

---

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

• AsciiInput.h
• AsciiInput.cxx