Isis::OriginalXmlLabel Class Reference

Read and store original Xml labels. More...

#include <OriginalXmlLabel.h>

Collaboration diagram for Isis::OriginalXmlLabel:

Public Member Functions
	OriginalXmlLabel ()
	Constructors a default OriginalXmlLabel with an empty label.
	OriginalXmlLabel (const QString &file)
	Constructs an OriginalXmlLabel from a cube label file.
	OriginalXmlLabel (Blob &blob)
	Constructs an OriginalXmlLabel from a blob.
	~OriginalXmlLabel ()
	Destructor.
Blob	toBlob () const
	Serialize the OriginalXmlLabel to a Blob.
void	fromBlob (Isis::Blob blob)
void	readFromXmlFile (const FileName &xmlFileName)
	Read the original label from an Xml file.
const QDomDocument &	ReturnLabels () const
	Returns the original Xml label.

Protected Member Functions
void	ReadData (std::istream &stream)

Private Attributes
QDomDocument	m_originalLabel
	Original Xml Label.

Detailed Description

Read and store original Xml labels.

This class provides a means to read and store the Xml labels from the original source.

Author

2017-01-30 Jesse Mapel

History

2017-01-30 Jesse Mapel - Original version, adapted from OriginalLabel. Fixes #4584.

Definition at line 32 of file OriginalXmlLabel.h.

Constructor & Destructor Documentation

OriginalXmlLabel() [1/3]

Isis::OriginalXmlLabel::OriginalXmlLabel

(

)

Constructors a default OriginalXmlLabel with an empty label.

Definition at line 23 of file OriginalXmlLabel.cpp.

OriginalXmlLabel() [2/3]

Isis::OriginalXmlLabel::OriginalXmlLabel

(

const QString &

file

)

Constructs an OriginalXmlLabel from a cube label file.

Parameters

file	Xml file to read labels from

Definition at line 32 of file OriginalXmlLabel.cpp.

OriginalXmlLabel() [3/3]

Isis::OriginalXmlLabel::OriginalXmlLabel

(

Isis::Blob &

blob

)

Constructs an OriginalXmlLabel from a blob.

Parameters

blob	Blob from which to create the OriginalXmlLabel

Definition at line 43 of file OriginalXmlLabel.cpp.

~OriginalXmlLabel()

Isis::OriginalXmlLabel::~OriginalXmlLabel

(

)

Destructor.

Definition at line 51 of file OriginalXmlLabel.cpp.

Member Function Documentation

fromBlob()

void Isis::OriginalXmlLabel::fromBlob

(

Isis::Blob

blob

)

Definition at line 58 of file OriginalXmlLabel.cpp.

readFromXmlFile()

void Isis::OriginalXmlLabel::readFromXmlFile

(

const FileName &

xmlFileName

)

Read the original label from an Xml file.

Parameters

FileName

The Xml file containing the original label.

Exceptions

IException::Io	"Could not open label file."
IException::Unknown	"XML read/parse error in file."

Definition at line 103 of file OriginalXmlLabel.cpp.

References Isis::IException::Io, m_originalLabel, Isis::toString(), and Isis::IException::Unknown.

ReturnLabels()

const QDomDocument & Isis::OriginalXmlLabel::ReturnLabels

(

)

const

Returns the original Xml label.

Returns

QDomDocument The parsed original label

Definition at line 130 of file OriginalXmlLabel.cpp.

References m_originalLabel.

toBlob()

Blob Isis::OriginalXmlLabel::toBlob

(

)

const

Serialize the OriginalXmlLabel to a Blob.

Returns

Blob

Definition at line 78 of file OriginalXmlLabel.cpp.

References Isis::IsLsb(), and m_originalLabel.

Member Data Documentation

m_originalLabel

QDomDocument Isis::OriginalXmlLabel::m_originalLabel

private

Original Xml Label.

Definition at line 49 of file OriginalXmlLabel.h.

Referenced by readFromXmlFile(), ReturnLabels(), and toBlob().

---

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

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