Isis::History Class Reference

#include <History.h>

Collaboration diagram for Isis::History:

Public Member Functions
	History ()
	Default Constructor for history.
	History (Isis::Blob &blob)
	Constructor for reading a blob.
	~History ()
	Destructor.
void	AddEntry ()
	Adds History PvlObject.
void	AddEntry (Isis::PvlObject &obj)
	Adds given PvlObject to History Pvl.
Pvl	ReturnHist ()
	Reads p_histBuffer into a pvl.
Blob	toBlob (const QString &name="IsisCube")
	Converts a history object into a new blob object.

Private Attributes
Pvl	p_history
	History Pvl.
char *	p_histBuffer = nullptr
	Store for read in history data.
int	p_bufferSize = 0

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

2021-03-05 Adam Paquette - Refactored History to no longer be a child class of a blob for a cleaner definition of responsabilities for the object

Todo

This class needs documentation.

Definition at line 38 of file History.h.

Constructor & Destructor Documentation

History() [1/2]

Isis::History::History

(

)

Default Constructor for history.

Definition at line 22 of file History.cpp.

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

History() [2/2]

Isis::History::History

(

Isis::Blob &

blob

)

Constructor for reading a blob.

Parameters

blob

Definition at line 31 of file History.cpp.

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

~History()

Isis::History::~History

(

)

Destructor.

Definition at line 46 of file History.cpp.

References p_histBuffer.

Member Function Documentation

AddEntry() [1/2]

void Isis::History::AddEntry

(

)

Adds History PvlObject.

Definition at line 56 of file History.cpp.

References AddEntry(), and Isis::Application::History().

Referenced by AddEntry(), and Isis::Process::WriteHistory().

AddEntry() [2/2]

void Isis::History::AddEntry

(

Isis::PvlObject &

obj

)

Adds given PvlObject to History Pvl.

Parameters

obj	PvlObject to be added

Definition at line 67 of file History.cpp.

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

ReturnHist()

Pvl Isis::History::ReturnHist

(

)

Reads p_histBuffer into a pvl.

Returns

Pvl

Definition at line 103 of file History.cpp.

References Isis::PvlObject::object(), Isis::PvlObject::objects(), p_histBuffer, and p_history.

toBlob()

Blob Isis::History::toBlob

(

const QString &

name = "IsisCube"

)

Converts a history object into a new blob object.

Parameters

name	Name of the History object to create

Returns

Blob

Definition at line 79 of file History.cpp.

References p_histBuffer, and p_history.

Referenced by Isis::Cube::write().

Member Data Documentation

p_bufferSize

int Isis::History::p_bufferSize = 0

private

Definition at line 53 of file History.h.

p_histBuffer

char* Isis::History::p_histBuffer = nullptr

private

Store for read in history data.

Definition at line 52 of file History.h.

Referenced by History(), ReturnHist(), toBlob(), and ~History().

p_history

Pvl Isis::History::p_history

private

History Pvl.

Definition at line 51 of file History.h.

Referenced by AddEntry(), History(), History(), ReturnHist(), and toBlob().

---

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

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