Isis::OriginalLabel Class Reference

Read and store original labels. More...

#include <OriginalLabel.h>

Collaboration diagram for Isis::OriginalLabel:

Public Member Functions
	OriginalLabel ()
	Constructor for creating an original blob with a given name. More...
	OriginalLabel (const QString &file)
	Constructor for creating an original blob with a given name and file to read labels from. More...
	OriginalLabel (Isis::Blob &blob)
	Constructor for creating an original label from a blob object. More...
	OriginalLabel (Pvl pvl)
	Constructor for creating an original blob with a given name and Pvl container. More...
Pvl	ReturnLabels () const
	Returns the labels in a Pvl object. More...
Isis::Blob	toBlob ()
	Serialize the OriginalLabel data to a Blob. More...

Protected Member Functions
void	WriteInit ()

Private Member Functions
void	fromBlob (Isis::Blob blob)
	Initialize the OriginalLabel from a Blob. More...

Private Attributes
Pvl	m_originalLabel

Detailed Description

Read and store original labels.

This class provides a means to read and store the labels from the original source. The labels can be retreived in a Pvl object.

Author

2006-02-23 Robert Wallace and Brian Lipkowitz

History:

2006-06-13 Brendan George - Modified to throw error when called file does not contain an Original Label

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:

2008-06-18 Steven Koechle - Fixed Documentation Errors

Definition at line 35 of file OriginalLabel.h.

Constructor & Destructor Documentation

OriginalLabel() [1/4]

Isis::OriginalLabel::OriginalLabel

(

)

Constructor for creating an original blob with a given name.

Definition at line 19 of file OriginalLabel.cpp.

OriginalLabel() [2/4]

Isis::OriginalLabel::OriginalLabel

(

const QString &

file

)

Constructor for creating an original blob with a given name and file to read labels from.

Parameters

file	File to read labels from

Definition at line 38 of file OriginalLabel.cpp.

References Isis::Blob::Read().

OriginalLabel() [3/4]

Isis::OriginalLabel::OriginalLabel

(

Isis::Blob &

blob

)

Constructor for creating an original label from a blob object.

Definition at line 27 of file OriginalLabel.cpp.

OriginalLabel() [4/4]

Isis::OriginalLabel::OriginalLabel

(

Pvl

pvl

)

Constructor for creating an original blob with a given name and Pvl container.

Parameters

pvl	Pvl containing labels of the source

Definition at line 51 of file OriginalLabel.cpp.

Member Function Documentation

fromBlob()

void Isis::OriginalLabel::fromBlob ( Isis::Blob  blob )

private

Initialize the OriginalLabel from a Blob.

Parameters

blob	The Blob to extract data from

Definition at line 65 of file OriginalLabel.cpp.

References Isis::Blob::getBuffer(), and Isis::Blob::Size().

ReturnLabels()

Pvl Isis::OriginalLabel::ReturnLabels

(

)

const

Returns the labels in a Pvl object.

Returns

(Isis::Pvl) original labels

Definition at line 97 of file OriginalLabel.cpp.

toBlob()

Isis::Blob Isis::OriginalLabel::toBlob

(

)

Serialize the OriginalLabel data to a Blob.

Returns

Blob

Definition at line 82 of file OriginalLabel.cpp.

References Isis::Blob::setData().

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

---

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

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