Isis 3 Programmer Reference
Public Member Functions | Private Attributes | List of all members
Isis::History Class Reference

#include <History.h>

Collaboration diagram for Isis::History:
Collaboration graph

Public Member Functions

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

Private Attributes

Pvl p_history
 History Pvl. More...
 
char * p_histBuffer = nullptr
 Store for read in history data. More...
 
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.
History:
2011-08-19 Jeannie Backer - Modified unitTest to use $temporary variable instead of /tmp directory. Added some documentation to methods.
History:
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
History:
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.

◆ 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 Isis::Blob::getBuffer(), and Isis::Blob::Size().

◆ ~History()

Isis::History::~History ( )

Destructor.

Definition at line 42 of file History.cpp.

Member Function Documentation

◆ AddEntry() [1/2]

void Isis::History::AddEntry ( )

Adds History PvlObject.

Definition at line 52 of file History.cpp.

References Isis::Application::History().

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

◆ AddEntry() [2/2]

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

Adds given PvlObject to History Pvl.

Parameters
objPvlObject to be added

Definition at line 63 of file History.cpp.

◆ ReturnHist()

Pvl Isis::History::ReturnHist ( )

Reads p_histBuffer into a pvl.

Returns
Pvl

Definition at line 99 of file History.cpp.

References Isis::PvlObject::object().

◆ toBlob()

Blob Isis::History::toBlob ( const QString &  name = "IsisCube")

Converts a history object into a new blob object.

Parameters
nameName of the History object to create
Returns
Blob

Definition at line 75 of file History.cpp.

References Isis::Blob::takeData().

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

Member Data Documentation

◆ p_histBuffer

char* Isis::History::p_histBuffer = nullptr
private

Store for read in history data.

Definition at line 52 of file History.h.

◆ p_history

Pvl Isis::History::p_history
private

History Pvl.

Definition at line 51 of file History.h.

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