Extends TextFile to handle Cassini ISS calibration files. More...

#include <CisscalFile.h>

Inheritance diagram for Isis::CisscalFile:

Collaboration diagram for Isis::CisscalFile:

Public Member Functions
	CisscalFile (const QString &filename, const char openmode="input", const char extension="")
	Constructs a CisscalFile object and opens the specified file (including path).

	~CisscalFile ()
	‍Destructor closes the text file.

bool	GetLine (QString &line)
	Get next line of valid data.

void	Open (const QString &filename, const char openmode="input", const char extension="")
	Opens a text file.

void	Open (const char filename, const char openmode="input", const char *extension="")

bool	OpenChk (bool bailIfNotOpen=false)

void	Rewind ()
	Sets Read / Write pointer to begining of opened file.

void	Close ()
	Closes file. Called automatically by TextFile destructor.

void	GetFile (std::vector< QString > &lines, const int &maxLinesToRead=0, const bool skipComments=true)

void	GetFile (QString *lines, const int &maxLinesToRead, const bool skipComments=true)

void	PutFile (std::vector< QString > &lines, const int &maxLinesToWrite=0)

void	PutFile (const QString *lines, const int &maxLinesToWrite)

bool	GetLine (QString &line, const bool skipComments=true)
	Gets next line from file.

bool	GetLine (const bool skipComments=true)
	Gets next line from file.

bool	GetLineNoFilter (QString &line)
	Gets next NON-COMMENT line from file.

bool	GetLineNoFilter ()
	Gets next NON-COMMENT line from file.

void	PutLine (const QString &line)
	Writes string to file and appends a 'newline' string.

void	PutLine (const char *line="")
	Writes char string to file and appends a 'newline' string.

void	PutLineComment (const QString &line)
	Writes string to file, prepends a 'comment' string and appends a 'newline' string.

void	PutLineComment (const char *line="")
	Writes char string to file, prepends a 'comment' string and appends a 'newline' string.

QString	GetComment ()

QString	GetNewLine ()

void	SetComment (const char *commentString="#")
	Sets the 'comment' string.

void	SetNewLine (const char *newLineString="\n")
	Sets the 'newline' string.

int	LineCount (const int &maxLinesToRead=0)
	Counts number of lines in file.

std::streamsize	Size ()
	Counts number of bytes in file.

Protected Member Functions
bool	p_GetLine (QString &line)
	‍Flag variable indicates whether the tag `"\begindata"` has been found.

bool	p_GetLine (QString &line, bool chkComment)
	Gets next line from file.

Protected Attributes
bool	p_begindataFound

std::fstream	p_stream
	File stream handle.

int	p_openmode
	openmode of file: Input, Output, Overwrite, Append

QString	p_filename
	FileName of the opened file.

QString	p_commentString
	'comment' string used by GetLine and PutLineComment

QString	p_newLineString
	'newline' string used by PutLine and PutLineComment

Detailed Description

Extends TextFile to handle Cassini ISS calibration files.

This class was created as an extension of TextFile to be able to read in Cassini ISS calibration files used by the Isis ciss2isis and cisscal applications. It is able to read PDS style text files and skip all header info that exists before the tag "\begindata".

Author: 2008-03-27 Jeannie Walldren

History

2008-03-27 Jeannie Walldren - Original Version.

2011-05-03 Jeannie Walldren - Fixed documentation of ingroup name and added ISISdisclaimer.

Definition at line 36 of file CisscalFile.h.

Constructor & Destructor Documentation

◆ CisscalFile()

Isis::CisscalFile::CisscalFile	(	const QString &	filename,
		const char *	openmode = "input",
		const char *	extension = "" )

Constructs a CisscalFile object and opens the specified file (including path).

Parameters

filename	FileName (including path) to be opened by TextFile object.
openmode	Open Mode of file opened by TextFile object. `"input"` Opens file for Input: Read Only. Fails if file does not exist. `"output"` Opens file for Output: Read/Write. Creates file, fails if file exists. `"overwrite"` Opens file for Output: Read/Write. Creates file, truncates if file exists. `"append"` Opens file for Append: Read/Write. Creates file, appends if file exists. Defaults to `"input"`.
extension	Extension to be added to filename (added only if not already on filename). Defaults to ""

Definition at line 45 of file CisscalFile.cpp.

◆ ~CisscalFile()

Isis::CisscalFile::~CisscalFile ( )

inline

‍Destructor closes the text file.

Definition at line 41 of file CisscalFile.h.

References Isis::TextFile::Close().

Member Function Documentation

◆ Close()

void Isis::TextFile::Close ( )

inherited

Closes file. Called automatically by TextFile destructor.

Definition at line 326 of file TextFile.cpp.

References Isis::TextFile::p_stream.

Referenced by ~CisscalFile(), and Isis::TextFile::~TextFile().

◆ GetComment()

QString Isis::TextFile::GetComment ( )

inherited

Definition at line 564 of file TextFile.cpp.

◆ GetFile() [1/2]

void Isis::TextFile::GetFile	(	QString *	lines,
		const int &	maxLinesToRead,
		const bool	skipComments = true )

inherited

Definition at line 350 of file TextFile.cpp.

◆ GetFile() [2/2]

void Isis::TextFile::GetFile	(	std::vector< QString > &	lines,
		const int &	maxLinesToRead = 0,
		const bool	skipComments = true )

inherited

Definition at line 334 of file TextFile.cpp.

◆ GetLine() [1/3]

bool Isis::TextFile::GetLine ( const bool skipComments = true )

inherited

Gets next line from file.

Returns True if read a line, False if End Of File.

Parameters

skipComments Controls whether comments lines are filtered; true=filter, false=return any line read from fileDefaults to true

Returns: bool

Definition at line 424 of file TextFile.cpp.

References Isis::TextFile::p_GetLine().

◆ GetLine() [2/3]

bool Isis::CisscalFile::GetLine ( QString & line )

Get next line of valid data.

This protected method overrides the base class method from TextFile of the same name. It finds the next line of valid data. If the "\begindata" tag has not been already found, it searches for that tag. Once found, every line beyond that is considered data and the method will retrieve the next line. Returns True if read a line, False if End Of File.

Parameters

line	String to be rewritten with contents of the next line read from file

Returns: bool Indicates whether line was read

Exceptions

Isis::iException::Io "Error reading text file"

See also: p_GetLine()

Definition at line 111 of file CisscalFile.cpp.

References p_GetLine().

◆ GetLine() [3/3]

bool Isis::TextFile::GetLine	(	QString &	line,
		const bool	skipComments = true )

inherited

Gets next line from file.

Returns True if read a line, False if End Of File.

Parameters

line	Line read from file, with newline removed.
skipComments	Controls whether comments lines are filtered; true=filter, false=return any line read from fileDefaults to true

Returns: bool

Definition at line 411 of file TextFile.cpp.

References Isis::TextFile::p_GetLine().

◆ GetLineNoFilter() [1/2]

bool Isis::TextFile::GetLineNoFilter ( )

inherited

Gets next NON-COMMENT line from file.

Returns True if read a line, False if End Of File. See SetComment method.

Returns: bool

Definition at line 447 of file TextFile.cpp.

References Isis::TextFile::p_GetLine().

◆ GetLineNoFilter() [2/2]

bool Isis::TextFile::GetLineNoFilter ( QString & line )

inherited

Gets next NON-COMMENT line from file.

Returns True if read a line, False if End Of File. See SetComment method.

Parameters

line	Line read from file, with newline removed.

Returns: bool

Definition at line 437 of file TextFile.cpp.

References Isis::TextFile::p_GetLine().

◆ GetNewLine()

QString Isis::TextFile::GetNewLine ( )

inherited

Definition at line 582 of file TextFile.cpp.

◆ LineCount()

int Isis::TextFile::LineCount ( const int & maxLinesToRead = 0 )

inherited

Counts number of lines in file.

Parameters

maxLinesToRead Limits lines counted - intended for large files. 0=count all lines. n=count up to and including n lines; if file longer than n lines, returns n+1. Defaults to 0

Returns: streamsize

Definition at line 607 of file TextFile.cpp.

References Isis::TextFile::p_stream.

◆ Open()

void Isis::TextFile::Open	(	const QString &	filename,
		const char *	openmode = "input",
		const char *	extension = "" )

inherited

Opens a text file.

Parameters

filename	FileName (including path) to be opened.
openmode	Open Mode of file to be opened. There are four options, "input", "output", "overwrite", and "append". "input" opens with in fstream option, "output" opens with in, out, and trunc fstream options and verifies the file does not exist, "overwrite" opens with in, out, and trunc fstream options, and "append" opens with in, out, and ate(at end) fstream options, "append" will open with in and out options if the file does not exist.
extension	Extension to be added to filename (added only if not already on filename). Defaults to ""

Exceptions

Isis::IException::Programmer
Isis::IException::Io	- output file already exists
Isis::IException::Io	- unable to open file

Definition at line 217 of file TextFile.cpp.

References Isis::IString::DownCase(), Isis::IException::Io, Isis::TextFile::p_filename, Isis::TextFile::p_openmode, Isis::TextFile::p_stream, and Isis::IException::Programmer.

Referenced by Isis::UserInterface::loadBatchList(), Isis::TextFile::TextFile(), Isis::TextFile::TextFile(), and Isis::TextFile::TextFile().

◆ OpenChk()

bool Isis::TextFile::OpenChk ( bool bailIfNotOpen = false )

inherited

Definition at line 301 of file TextFile.cpp.

◆ p_GetLine() [1/2]

bool Isis::CisscalFile::p_GetLine ( QString & line )

protected

‍Flag variable indicates whether the tag "\begindata" has been found.

Get next line of valid data, protected.

This method overwrites TextFile's protected method of the same name. It is called by the public overwritten method GetLine(), as in the parent class.

Parameters

line	String to be rewritten with contents of the next line read from file

Returns: bool Indicates whether line was read

Exceptions

Isis::iException::Io "Error reading text file"

See also: GetLine()

Definition at line 63 of file CisscalFile.cpp.

References Isis::IException::Io, Isis::TextFile::p_filename, p_GetLine(), and Isis::TextFile::p_stream.

Referenced by GetLine(), and p_GetLine().

◆ p_GetLine() [2/2]

bool Isis::TextFile::p_GetLine	(	QString &	line,
		bool	chkComment )

protectedinherited

Gets next line from file.

Returns True if read a line, False if End Of File.

Parameters

line	Line read from file, with newline removed.
chkComment	True=Skip Comment Lines, False=Return All Lines.

Returns: bool

Exceptions

Isis::IException::Io - error reading text file

Definition at line 463 of file TextFile.cpp.

References Isis::IException::Io, Isis::TextFile::p_commentString, Isis::TextFile::p_filename, Isis::TextFile::p_GetLine(), and Isis::TextFile::p_stream.

Referenced by Isis::TextFile::GetLine(), Isis::TextFile::GetLine(), Isis::TextFile::GetLineNoFilter(), Isis::TextFile::GetLineNoFilter(), and Isis::TextFile::p_GetLine().

◆ PutFile() [1/2]

void Isis::TextFile::PutFile	(	const QString *	lines,
		const int &	maxLinesToWrite )

inherited

Definition at line 383 of file TextFile.cpp.

◆ PutFile() [2/2]

void Isis::TextFile::PutFile	(	std::vector< QString > &	lines,
		const int &	maxLinesToWrite = 0 )

inherited

Definition at line 370 of file TextFile.cpp.

◆ PutLine() [1/2]

void Isis::TextFile::PutLine ( const char * line = "" )

inherited

Writes char string to file and appends a 'newline' string.

See SetNewLine method.

Parameters

line	Char string to be written to file.Defaults to ""

Exceptions

Isis::IException::Io	- error writing text to file
Isis::IException::Programmer	- input is read only text file, cannot write to file

Definition at line 522 of file TextFile.cpp.

References Isis::IException::Io, Isis::TextFile::p_filename, Isis::TextFile::p_newLineString, Isis::TextFile::p_openmode, Isis::TextFile::p_stream, and Isis::IException::Programmer.

◆ PutLine() [2/2]

void Isis::TextFile::PutLine ( const QString & line )

inherited

Writes string to file and appends a 'newline' string.

See SetNewLine method.

Parameters

line	IString to be written to file. Defaults to ""

Definition at line 508 of file TextFile.cpp.

References Isis::TextFile::PutLine().

Referenced by Isis::TextFile::PutLine(), Isis::TextFile::PutLineComment(), and Isis::TextFile::PutLineComment().

◆ PutLineComment() [1/2]

void Isis::TextFile::PutLineComment ( const char * line = "" )

inherited

Writes char string to file, prepends a 'comment' string and appends a 'newline' string.

See SetComment method and SetNewLine method.

Parameters

line	Char string to be written to file.Defaults to ""

Definition at line 559 of file TextFile.cpp.

References Isis::TextFile::p_commentString, and Isis::TextFile::PutLine().

◆ PutLineComment() [2/2]

void Isis::TextFile::PutLineComment ( const QString & line )

inherited

Writes string to file, prepends a 'comment' string and appends a 'newline' string.

See SetComment method and SetNewLine method.

Parameters

line	IString to be written to file.Defaults to ""

Definition at line 549 of file TextFile.cpp.

References Isis::TextFile::p_commentString, and Isis::TextFile::PutLine().

◆ Rewind()

void Isis::TextFile::Rewind ( )

inherited

Sets Read / Write pointer to begining of opened file.

Definition at line 317 of file TextFile.cpp.

References Isis::TextFile::p_stream.

◆ SetComment()

void Isis::TextFile::SetComment ( const char * commentString = "#" )

inherited

Sets the 'comment' string.

Default = '#' See ReadFilter method. Skips lines that begin with this string. See PutLineComment method. Prepends 'comment' string to output line.

Parameters

commentString The string of characters to be used for 'comment' lines. Defaults to "#"

Definition at line 577 of file TextFile.cpp.

References Isis::TextFile::p_commentString.

Referenced by Isis::TextFile::TextFile(), Isis::TextFile::TextFile(), and Isis::TextFile::TextFile().

◆ SetNewLine()

void Isis::TextFile::SetNewLine ( const char * newLineString = "\n" )

inherited

Sets the 'newline' string.

Default = '
'. See PutLine and PutLineComment methods. Appends 'newline' string to output line.

Parameters

newLineString The string of characters to be used for 'comment' lines. Defaults to "\n"

Definition at line 593 of file TextFile.cpp.

References Isis::TextFile::p_newLineString.

Referenced by Isis::TextFile::TextFile(), Isis::TextFile::TextFile(), and Isis::TextFile::TextFile().

◆ Size()

streamsize Isis::TextFile::Size ( )

inherited

Counts number of bytes in file.

Returns: streamsize

Definition at line 652 of file TextFile.cpp.

References Isis::TextFile::p_stream.

Member Data Documentation

◆ p_begindataFound

bool Isis::CisscalFile::p_begindataFound

protected

Definition at line 46 of file CisscalFile.h.

◆ p_commentString

QString Isis::TextFile::p_commentString

protectedinherited

'comment' string used by GetLine and PutLineComment

Definition at line 45 of file TextFile.h.

Referenced by Isis::TextFile::p_GetLine(), Isis::TextFile::PutLineComment(), Isis::TextFile::PutLineComment(), and Isis::TextFile::SetComment().

◆ p_filename

QString Isis::TextFile::p_filename

protectedinherited

FileName of the opened file.

Definition at line 44 of file TextFile.h.

Referenced by Isis::TextFile::Open(), p_GetLine(), Isis::TextFile::p_GetLine(), and Isis::TextFile::PutLine().

◆ p_newLineString

QString Isis::TextFile::p_newLineString

protectedinherited

'newline' string used by PutLine and PutLineComment

Definition at line 47 of file TextFile.h.

Referenced by Isis::TextFile::PutLine(), and Isis::TextFile::SetNewLine().

◆ p_openmode

int Isis::TextFile::p_openmode

protectedinherited

openmode of file: Input, Output, Overwrite, Append

Definition at line 42 of file TextFile.h.

Referenced by Isis::TextFile::Open(), Isis::TextFile::PutLine(), Isis::TextFile::TextFile(), and Isis::TextFile::TextFile().

◆ p_stream

std::fstream Isis::TextFile::p_stream

protectedinherited

File stream handle.

Definition at line 41 of file TextFile.h.

Referenced by Isis::TextFile::Close(), Isis::TextFile::LineCount(), Isis::TextFile::Open(), p_GetLine(), Isis::TextFile::p_GetLine(), Isis::TextFile::PutLine(), Isis::TextFile::Rewind(), and Isis::TextFile::Size().

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

src/cassini/objs/CisscalFile/CisscalFile.h
src/cassini/objs/CisscalFile/CisscalFile.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CisscalFile()

◆ ~CisscalFile()

Member Function Documentation

◆ Close()

◆ GetComment()

◆ GetFile() [1/2]

◆ GetFile() [2/2]

◆ GetLine() [1/3]

◆ GetLine() [2/3]

◆ GetLine() [3/3]

◆ GetLineNoFilter() [1/2]

◆ GetLineNoFilter() [2/2]

◆ GetNewLine()

◆ LineCount()

◆ Open()

◆ OpenChk()

◆ p_GetLine() [1/2]

◆ p_GetLine() [2/2]

◆ PutFile() [1/2]

◆ PutFile() [2/2]

◆ PutLine() [1/2]

◆ PutLine() [2/2]

◆ PutLineComment() [1/2]

◆ PutLineComment() [2/2]

◆ Rewind()

◆ SetComment()

◆ SetNewLine()

◆ Size()

Member Data Documentation

◆ p_begindataFound

◆ p_commentString

◆ p_filename

◆ p_newLineString

◆ p_openmode

◆ p_stream