#include <History.h>

Inheritance diagram for Isis::History:

Collaboration diagram for Isis::History:

Public Member Functions
	History (const QString &name)
	Constructor for reading a history blob.

	History (const QString &name, const QString &file)
	Constructor for reading a history blob.

	~History ()
	Destructor.

void	AddEntry ()
	Adds History PvlObject.

void	AddEntry (Isis::PvlObject &obj)
	Adds given PvlObject to History Pvl.

Pvl	ReturnHist ()
	Reads p_buffer into a pvl.

void	Read (const Isis::Pvl &pvl, std::istream &is)
	Reads input stream into Pvl.

QString	Type () const
	Accessor method that returns a string containing the Blob type.

QString	Name () const
	Accessor method that returns a string containing the Blob name.

int	Size () const
	Accessor method that returns the number of bytes in the blob data.

PvlObject &	Label ()
	Accessor method that returns a PvlObject containing the Blob label.

void	Read (const QString &file)
	This method reads Pvl values from a specified file.

void	Read (const QString &file, const Pvl &pvlLabels)
	This method reads the given a file and labels.

void	Write (const QString &file)
	Write the blob data out to a file.

void	Write (Pvl &pvl, std::fstream &stm, const QString &detachedFileName="")
	Write the blob data out to a Pvl object.

Protected Member Functions
void	WriteInit ()
	This virtual method for classes that inherit Blob.

void	Find (const Pvl &pvl)
	This method searches the given Pvl for the Blob by the Blob's type and name.

virtual void	ReadInit ()
	This virtual method for classes that inherit Blob.

virtual void	ReadData (std::istream &is)
	Read binary data from an input stream into the Blob object.

virtual void	WriteData (std::fstream &os)
	Writes blob data to a stream.

Protected Attributes
PvlObject	p_blobPvl
	Pvl Blob object.

QString	p_blobName
	Name of the Blob object.

char *	p_buffer
	Buffer blob data is stored in.

BigInt	p_startByte
	Byte blob data starts at in buffer.

int	p_nbytes
	Size of blob data (in bytes)

QString	p_type
	Type of data stored in the buffer.

QString	p_detached
	Used for reading detached blobs.

QString	p_labelFile
	The file containing the labels.

Private Attributes
Pvl	p_history
	History Pvl.

Detailed Description

Author: ????-??-?? Unknown

History:

2006-12-11 Kris Becker Fixed bug in WriteInit method using a temporary string to reference a char pointer to its contents. The string remain after the reference or its toast.

2011-08-19 Jeannie Backer - Modified unitTest to use $temporary variable instead of /tmp directory. Added some documentation to methods.

2012-10-04 Jeannie Backer - Replaced if! defined with ifndef. Added forward declaration for PvlObject and include for Pvl since the include for Pvl was removed from Blob.h. Added padding to control statements. References #1169

Todo:: This class needs documentation.

Definition at line 51 of file History.h.

Constructor & Destructor Documentation

Isis::History::History ( const QString & name )

Constructor for reading a history blob.

Parameters

name

Definition at line 40 of file History.cpp.

References p_history, and Isis::Pvl::setTerminator().

Isis::History::History	(	const QString &	name,
		const QString &	file
	)

Constructor for reading a history blob.

Parameters

name
file

Definition at line 49 of file History.cpp.

References Isis::Blob::Read().

Isis::History::~History ( )

Destructor.

Definition at line 55 of file History.cpp.

Member Function Documentation

void Isis::History::AddEntry ( )

Adds History PvlObject.

Definition at line 61 of file History.cpp.

References Isis::Application::History().

Referenced by Isis::Process::WriteHistory().

void Isis::History::AddEntry ( Isis::PvlObject & obj )

Adds given PvlObject to History Pvl.

Parameters

obj	PvlObject to be added

Definition at line 71 of file History.cpp.

References Isis::PvlObject::addObject(), and p_history.

void Isis::Blob::Find ( const Pvl & pvl )

protectedinherited

This method searches the given Pvl for the Blob by the Blob's type and name.

If found, the start byte, number of bytes are read from the Pvl. Also, if a keyword label pointer is found, the filename for the detached blob is stored and the pointer is removed from the blob pvl.

Parameters