Isis::FileList Class Reference

Internalizes a list of files. More...

#include <FileList.h>

Inheritance diagram for Isis::FileList:

Collaboration diagram for Isis::FileList:

Public Member Functions
	FileList (FileName listFile)
	Constructs a FileList from a stream.
	FileList (std::istream &in)
	FileList ()
	Constructs an empty FileList.
	~FileList ()
	Destroys the FileList object.
void	read (FileName listFile)
	Constructs a FileList from a stream.
void	read (std::istream &in)
	Loads list of files from a stream.
void	write (FileName outputFileList)
	Writes a list of files to a file.
void	write (std::ostream &out)
	Writes a list of files to a stream.

Detailed Description

Internalizes a list of files.

This class reads a list of filenames from a file an internalizes them in a standard template vector of strings. Thus, a file like:

m0035431.imq
m0030402.imq
m0033231.imq
   .
   .
   .
m0203331.imq

Will be internalized as and accessable as an vector.

Author

2003-05-01 Jeff Anderson

History:

2003-05-16 Stuart Sides - modified schema from astrogeology... isis.astrogeology...

2005-03-16 Leah Dahmer - modified file to support Doxygen documentation.

2006-04-05 Elizabeth Miller - Added error message to catch empty files

2007-01-04 Brendan George - Added comment recognition and it now only reads the first column

2007-02-19 Stacy Alley - modified the Read method such that if a file name and it's attributes are surround with double quotes, then don't use commas as a 'end of line' signal.

Definition at line 67 of file FileList.h.

Constructor & Destructor Documentation

Isis::FileList::FileList

(

FileName

listFile

)

Constructs a FileList from a stream.

Parameters

in	An input stream containing a list of files.

Definition at line 46 of file FileList.cpp.

Isis::FileList::FileList

(

)

Constructs an empty FileList.

Definition at line 38 of file FileList.cpp.

Isis::FileList::~FileList ( )

inline

Destroys the FileList object.

Definition at line 75 of file FileList.h.

Member Function Documentation

void Isis::FileList::read

(

FileName

listFile

)

Constructs a FileList from a stream.

Parameters

path	of a file containing a list of files. Opens and loads the list of files from a file.
list	Name of the file to open that contains the list of files.

Exceptions

Isis::iException::Io

- Cannot open file

Definition at line 66 of file FileList.cpp.

References _FILEINFO_, Isis::Message::FileOpen(), and read().

Referenced by read().

void Isis::FileList::read

(

std::istream &

in

)

Loads list of files from a stream.

This takes in a stream and loads a file list from it. The lines in the stream are considered separate entries, and comments are ignored. comments are considered to be any line starting with a '#' or '//', and anything after any whitespace following the first text on the line.

Parameters

in	An input stream containing a list of files.

Definition at line 101 of file FileList.cpp.

References _FILEINFO_, Isis::IString::Token(), Isis::IString::ToQt(), Isis::IString::TrimHead(), and Isis::IString::TrimTail().

void Isis::FileList::write

(

FileName

outputFileList

)

Writes a list of files to a file.

Parameters

list	The name of the file to create. The method will overwrite any existing files.

Exceptions

Isis::iException::Io

File could not be created.

Definition at line 174 of file FileList.cpp.

References _FILEINFO_, and Isis::Message::FileOpen().

void Isis::FileList::write

(

std::ostream &

out

)

Writes a list of files to a stream.

Parameters

out	The list will be written to this output stream.

Definition at line 196 of file FileList.cpp.

---

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

• src/base/objs/FileList/FileList.h
• src/base/objs/FileList/FileList.cpp