ossimCsvFile Class Reference

#include <ossimCsvFile.h>

Inheritance diagram for ossimCsvFile:

Classes
class	Record

Public Types
typedef std::vector< ossimString >	StringListType

Public Member Functions
	ossimCsvFile (const ossimString &separatorList=",")
	~ossimCsvFile ()
bool	open (const ossimFilename &file, const ossimString &flags="r")
	For now we will only support the read flag and open existing csv files. More...
void	close ()
bool	readHeader ()
ossimRefPtr< ossimCsvFile::Record >	nextRecord ()
	Read one record and returns null if no more records exist or returns a valid pointer if a record exists. More...
const StringListType &	fieldHeaderList () const
	Returns the header of the CSV file. More...
ossim_int32	indexOfField (const ossimString &fieldName) const
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const

Static Public Attributes
static ossim_int32	INVALID_INDEX = -1

Protected Member Functions
bool	readCsvLine (std::istream &inStream, ossimCsvFile::StringListType &tokens) const
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
StringListType	theFieldHeaderList
ossimRefPtr< ossimCsvFile::Record >	theRecordBuffer
std::istream *	theInputStream
ossimString	theSeparatorList
bool	theOpenFlag

Friends
class	Record

Detailed Description

Definition at line 12 of file ossimCsvFile.h.

Member Typedef Documentation

StringListType

typedef std::vector<ossimString> ossimCsvFile::StringListType

Definition at line 15 of file ossimCsvFile.h.

Constructor & Destructor Documentation

ossimCsvFile()

ossimCsvFile::ossimCsvFile

(

const ossimString &

separatorList = ","

)

Definition at line 102 of file ossimCsvFile.cpp.

:theInputStream(0),
theSeparatorList(separatorList),
 theOpenFlag(false)
{
}

~ossimCsvFile()

ossimCsvFile::~ossimCsvFile

(

)

Definition at line 109 of file ossimCsvFile.cpp.

References close().

{
   close();
}

Member Function Documentation

close()

void ossimCsvFile::close

(

)

Definition at line 229 of file ossimCsvFile.cpp.

References theFieldHeaderList, theInputStream, theOpenFlag, and theRecordBuffer.

Referenced by open(), and ~ossimCsvFile().

{
   if(theOpenFlag)
   {
      theFieldHeaderList.clear();
      if(theInputStream)
      {
         delete theInputStream;
         theInputStream = 0;
      }
      theOpenFlag = false;
      theRecordBuffer = 0;
   }
}

fieldHeaderList()

const ossimCsvFile::StringListType & ossimCsvFile::fieldHeaderList

(

)

const

Returns the header of the CSV file.

Definition at line 261 of file ossimCsvFile.cpp.

References theFieldHeaderList.

{
   return theFieldHeaderList;
}

indexOfField()

ossim_int32 ossimCsvFile::indexOfField

(

const ossimString &

fieldName

)

const

Definition at line 266 of file ossimCsvFile.cpp.

References INVALID_INDEX, and theFieldHeaderList.

{
   ossim_int32 result = ossimCsvFile::INVALID_INDEX;
   ossim_uint32 idx = 0;
   for(;idx < theFieldHeaderList.size(); ++idx)
   {
      if(theFieldHeaderList[idx] == fieldName)
      {
         result = (ossim_int32)idx;
         break;
      }
   }
   
   return result;
}

nextRecord()

ossimRefPtr< ossimCsvFile::Record > ossimCsvFile::nextRecord

(

)

Read one record and returns null if no more records exist or returns a valid pointer if a record exists.

Definition at line 243 of file ossimCsvFile.cpp.

References readCsvLine(), readHeader(), theFieldHeaderList, theInputStream, theOpenFlag, theRecordBuffer, and ossimCsvFile::Record::values().

{
   if(!theOpenFlag) return ossimRefPtr<ossimCsvFile::Record>(0);
   
   if(theFieldHeaderList.empty())
   {
      if(!readHeader())
      {
         return ossimRefPtr<ossimCsvFile::Record>();
      }
   }
   if(!readCsvLine(*theInputStream,  theRecordBuffer->values()))
   {
      return ossimRefPtr<ossimCsvFile::Record>();
   }
   return theRecordBuffer;
}

open()

bool ossimCsvFile::open	(	const ossimFilename &	file,
		const ossimString &	flags = "r"
	)

For now we will only support the read flag and open existing csv files.

Later we can add support for creating and writing csv files

Definition at line 200 of file ossimCsvFile.cpp.

References ossimString::begin(), ossimString::c_str(), close(), Record, theInputStream, theOpenFlag, and theRecordBuffer.

{
   close();
   
   if((*flags.begin()) == 'r')
   {
      theInputStream = new std::ifstream(file.c_str(), std::ios::in|std::ios::binary);
      theOpenFlag = true;
      theRecordBuffer = new ossimCsvFile::Record(this);
   }
   else
   {
      return theOpenFlag;
   }
   
   return theOpenFlag;
}

readCsvLine()

bool ossimCsvFile::readCsvLine ( std::istream &  inStream, ossimCsvFile::StringListType &  tokens  ) const

protected

Definition at line 114 of file ossimCsvFile.cpp.

Referenced by nextRecord(), and readHeader().

{
   tokens.clear();
   bool done = false;
   char c;
   const char quote = '\"';
   bool inQuotedString = false;
   bool inDoubleQuote    = false;
   ossimString currentToken;
   inStream >> csvSkipWhiteSpace;
   while(!done&&inStream.get(c)&&inStream.good())
   {
      if(c > 0x7e )
      {
         return false;
      }
      if((c!='\n')&&
         (c!='\r'))
      {
         // check to see if we are quoted and check to see if double quoted
         if(c == quote)
         {
            // check if at a double quote
            if(inStream.peek() == quote)
            {
               currentToken += quote;
               inStream.ignore(1);
               if(!inDoubleQuote)
               {
                  inDoubleQuote = true;
               }
               else
               {
                  inDoubleQuote = false;
               }
            }
            else
            {
               if(!inQuotedString)
               {
                  inQuotedString = true;
               }
               else
               {
                  inQuotedString = false;
               }
            }
         }
         // if we are at a separator then check to see if we are inside a quoted string
         else if(theSeparatorList.contains(c)) 
         {
            // ignore token separator if quoted
            if(inQuotedString||inDoubleQuote)
            {
               currentToken += c;
            }
            else
            {
               // push the current token.
               currentToken = currentToken.trim();
               tokens.push_back(currentToken);
               currentToken = "";
               inStream >> csvSkipWhiteSpace;
            }
         }
         else
         {
            currentToken += c;
         }
      }
      else if(!inQuotedString||inDoubleQuote)
      {
         currentToken = currentToken.trim();
         tokens.push_back(currentToken);
         done = true;
      }
      else
      {
         currentToken += c;
      }
   }
   
   return (inStream.good()&&(tokens.size()>0)); 
}

readHeader()

bool ossimCsvFile::readHeader

(

)

Definition at line 218 of file ossimCsvFile.cpp.

References readCsvLine(), theFieldHeaderList, theInputStream, and theOpenFlag.

Referenced by nextRecord().

{
   if(theOpenFlag)
   {
      theFieldHeaderList.clear();
      return readCsvLine(*theInputStream, theFieldHeaderList);
   }
   
   return false;
}

Friends And Related Function Documentation

Record

friend class Record

friend

Definition at line 67 of file ossimCsvFile.h.

Referenced by open().

Member Data Documentation

INVALID_INDEX

ossim_int32 ossimCsvFile::INVALID_INDEX = -1

static

Definition at line 94 of file ossimCsvFile.h.

Referenced by indexOfField().

theFieldHeaderList

StringListType ossimCsvFile::theFieldHeaderList

protected

Definition at line 98 of file ossimCsvFile.h.

Referenced by close(), fieldHeaderList(), indexOfField(), nextRecord(), and readHeader().

theInputStream

std::istream* ossimCsvFile::theInputStream

protected

Definition at line 100 of file ossimCsvFile.h.

Referenced by close(), nextRecord(), open(), and readHeader().

theOpenFlag

bool ossimCsvFile::theOpenFlag

protected

Definition at line 102 of file ossimCsvFile.h.

Referenced by close(), nextRecord(), open(), and readHeader().

theRecordBuffer

ossimRefPtr<ossimCsvFile::Record> ossimCsvFile::theRecordBuffer

protected

Definition at line 99 of file ossimCsvFile.h.

Referenced by close(), nextRecord(), and open().

theSeparatorList

ossimString ossimCsvFile::theSeparatorList

protected

Definition at line 101 of file ossimCsvFile.h.

---

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

• ossimCsvFile.h
• ossimCsvFile.cpp