Isis 3 Programmer Reference
Isis::OriginalLabel Class Reference

Read and store original labels. More...

#include <OriginalLabel.h>

Inheritance diagram for Isis::OriginalLabel:
Inheritance graph
Collaboration diagram for Isis::OriginalLabel:
Collaboration graph

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 (Pvl pvl)
 Constructor for creating an original blob with a given name and Pvl container. More...
 
Pvl ReturnLabels ()
 Returns the labels in a Pvl object. More...
 
QString Type () const
 Accessor method that returns a string containing the Blob type. More...
 
QString Name () const
 Accessor method that returns a string containing the Blob name. More...
 
int Size () const
 Accessor method that returns the number of bytes in the blob data. More...
 
PvlObjectLabel ()
 Accessor method that returns a PvlObject containing the Blob label. More...
 
void Read (const QString &file)
 This method reads Pvl values from a specified file. More...
 
void Read (const QString &file, const Pvl &pvlLabels)
 This method reads the given a file and labels. More...
 
virtual void Read (const Pvl &pvl, std::istream &is)
 This method reads the Blob data from an open input file stream. More...
 
void Write (const QString &file)
 Write the blob data out to a file. More...
 
void Write (Pvl &pvl, std::fstream &stm, const QString &detachedFileName="")
 Write the blob data out to a Pvl object. More...
 

Protected Member Functions

void WriteInit ()
 Prepare labels for writing to the output cube. More...
 
void Find (const Pvl &pvl)
 This method searches the given Pvl for the Blob by the Blob's type and name. More...
 
virtual void ReadInit ()
 This virtual method for classes that inherit Blob. More...
 
virtual void ReadData (std::istream &is)
 Read binary data from an input stream into the Blob object. More...
 
virtual void WriteData (std::fstream &os)
 Writes blob data to a stream. More...
 

Protected Attributes

PvlObject p_blobPvl
 Pvl Blob object. More...
 
QString p_blobName
 Name of the Blob object. More...
 
char * p_buffer
 Buffer blob data is stored in. More...
 
BigInt p_startByte
 Byte blob data starts at in buffer. More...
 
int p_nbytes
 Size of blob data (in bytes) More...
 
QString p_type
 Type of data stored in the buffer. More...
 
QString p_detached
 Used for reading detached blobs. More...
 
QString p_labelFile
 The file containing the labels. 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

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.

2008-06-18 Steven Koechle - Fixed Documentation Errors

Definition at line 51 of file OriginalLabel.h.

Constructor & Destructor Documentation

◆ OriginalLabel() [1/3]

Isis::OriginalLabel::OriginalLabel ( )

Constructor for creating an original blob with a given name.

Definition at line 35 of file OriginalLabel.cpp.

References Isis::Pvl::setTerminator().

◆ OriginalLabel() [2/3]

Isis::OriginalLabel::OriginalLabel ( const QString &  file)

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

Parameters
fileFile to read labels from

Definition at line 45 of file OriginalLabel.cpp.

References Isis::Blob::Read().

◆ OriginalLabel() [3/3]

Isis::OriginalLabel::OriginalLabel ( Pvl  pvl)

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

Parameters
pvlPvl containing labels of the source

Definition at line 56 of file OriginalLabel.cpp.

Member Function Documentation

◆ Find()

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
pvlThe Pvl to be searched

Definition at line 179 of file Blob.cpp.

References _FILEINFO_, Isis::PvlContainer::isNamed(), Isis::PvlObject::object(), Isis::PvlObject::objects(), and Isis::FileName::path().

◆ Label()

◆ Name()

QString Isis::Blob::Name ( ) const
inherited

Accessor method that returns a string containing the Blob name.

Returns
string The name of the blob.

Definition at line 149 of file Blob.cpp.

Referenced by Isis::Shape::isFootprintable(), Isis::Image::isFootprintable(), Isis::SpicePosition::LoadCache(), and Isis::Cube::write().

◆ Read() [1/3]

void Isis::Blob::Read ( const QString &  file)
inherited

This method reads Pvl values from a specified file.

Parameters
fileThe filename to read from.
Exceptions
iException::Io- Unable to open file
iException::Pvl- Invalid label format

Definition at line 243 of file Blob.cpp.

References _FILEINFO_, and Isis::Pvl::read().

Referenced by Isis::History::History(), OriginalLabel(), Isis::OriginalXmlLabel::OriginalXmlLabel(), Isis::History::Read(), Isis::Cube::read(), and Isis::Table::Table().

◆ Read() [2/3]

void Isis::Blob::Read ( const QString &  file,
const Pvl pvlLabels 
)
inherited

This method reads the given a file and labels.

Parameters
fileThe filename to read from.
pvlLabelsA Pvl containing the label information.
Exceptions
iException::Io- Unable to open file

Definition at line 268 of file Blob.cpp.

References _FILEINFO_, and Isis::Message::FileOpen().

◆ Read() [3/3]

void Isis::Blob::Read ( const Pvl pvl,
std::istream &  istm 
)
virtualinherited

This method reads the Blob data from an open input file stream.

Parameters
pvlA Pvl containing the label information.
istmThe input file stream containing the blob data to be read.
Exceptions
iException::Io- Unable to open file

Reimplemented in Isis::History.

Definition at line 303 of file Blob.cpp.

References _FILEINFO_, and Isis::Message::FileOpen().

◆ ReadData()

void Isis::Blob::ReadData ( std::istream &  stream)
protectedvirtualinherited

Read binary data from an input stream into the Blob object.

Parameters
streamThe input stream to read from.
Exceptions
IException::Io- Error reading data from stream

Reimplemented in Isis::ImagePolygon, Isis::Table, and Isis::OriginalXmlLabel.

Definition at line 340 of file Blob.cpp.

References _FILEINFO_.

Referenced by Isis::OriginalXmlLabel::ReadData().

◆ ReadInit()

void Isis::Blob::ReadInit ( )
protectedvirtualinherited

This virtual method for classes that inherit Blob.

It is not defined in the Blob class.

Reimplemented in Isis::Table.

Definition at line 330 of file Blob.cpp.

◆ ReturnLabels()

Pvl Isis::OriginalLabel::ReturnLabels ( )

Returns the labels in a Pvl object.

Returns
(Isis::Pvl) original labels

Definition at line 92 of file OriginalLabel.cpp.

References Isis::Blob::p_buffer, and Isis::Blob::p_nbytes.

◆ Size()

int Isis::Blob::Size ( ) const
inherited

Accessor method that returns the number of bytes in the blob data.

Returns
int Number of bytes in the blob data.

Definition at line 158 of file Blob.cpp.

◆ Type()

QString Isis::Blob::Type ( ) const
inherited

Accessor method that returns a string containing the Blob type.

Returns
string Type of blob.

Definition at line 140 of file Blob.cpp.

Referenced by Isis::Shape::isFootprintable(), Isis::Image::isFootprintable(), and Isis::Cube::write().

◆ Write() [1/2]

void Isis::Blob::Write ( const QString &  file)
inherited

Write the blob data out to a file.

Parameters
fileThe filename to write to.
Exceptions
IException::Io- Unable to open file
IException::Io- Error preparing to write data to file
IException::Io- Error creating file

Definition at line 369 of file Blob.cpp.

References _FILEINFO_, Isis::PvlObject::addObject(), Isis::PvlObject::findObject(), Isis::toString(), and Isis::Pvl::write().

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

◆ Write() [2/2]

void Isis::Blob::Write ( Pvl pvl,
std::fstream &  stm,
const QString &  detachedFileName = "" 
)
inherited

Write the blob data out to a Pvl object.

Parameters
pvlThe pvl object to update
stmstream to write data to
detachedFileNameIf the stream is detached from the labels give the name of the file

Definition at line 418 of file Blob.cpp.

References Isis::PvlObject::addObject(), Isis::PvlContainer::name(), Isis::PvlObject::object(), Isis::PvlObject::objects(), and Isis::toString().

◆ WriteData()

void Isis::Blob::WriteData ( std::fstream &  stream)
protectedvirtualinherited

Writes blob data to a stream.

Parameters
streamOutput steam blob data will be written to
Exceptions
IException::Io- Error writing data to stream

Reimplemented in Isis::ImagePolygon, Isis::Table, and Isis::OriginalXmlLabel.

Definition at line 502 of file Blob.cpp.

References _FILEINFO_.

◆ WriteInit()

void Isis::OriginalLabel::WriteInit ( )
protectedvirtual

Prepare labels for writing to the output cube.

Reimplemented from Isis::Blob.

Definition at line 67 of file OriginalLabel.cpp.

References Isis::Blob::p_buffer, and Isis::Blob::p_nbytes.

Member Data Documentation

◆ p_blobName

QString Isis::Blob::p_blobName
protectedinherited

◆ p_blobPvl

◆ p_buffer

◆ p_detached

QString Isis::Blob::p_detached
protectedinherited

Used for reading detached blobs.

Definition at line 101 of file Blob.h.

Referenced by Isis::Blob::Blob(), and Isis::Blob::operator=().

◆ p_labelFile

QString Isis::Blob::p_labelFile
protectedinherited

The file containing the labels.

Definition at line 102 of file Blob.h.

Referenced by Isis::Blob::Blob(), and Isis::Blob::operator=().

◆ p_nbytes

◆ p_startByte

BigInt Isis::Blob::p_startByte
protectedinherited

Byte blob data starts at in buffer.

Definition at line 98 of file Blob.h.

Referenced by Isis::Blob::Blob(), Isis::Blob::operator=(), Isis::Table::ReadData(), and Isis::ImagePolygon::ReadData().

◆ p_type

QString Isis::Blob::p_type
protectedinherited

Type of data stored in the buffer.

Definition at line 100 of file Blob.h.

Referenced by Isis::Blob::Blob(), Isis::Blob::operator=(), and Isis::ImagePolygon::ReadData().


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