Isis::PvlObject Class Reference

Contains Pvl Groups and Pvl Objects. More...

#include <PvlObject.h>

Inheritance diagram for Isis::PvlObject:

Collaboration diagram for Isis::PvlObject:

Public Types
enum	FindOptions { None, Traverse }
	A collection of options to use when finding. More...
typedef QList< Isis::PvlGroup > ::iterator	PvlGroupIterator
	The counter for groups.
typedef QList< Isis::PvlGroup > ::const_iterator	ConstPvlGroupIterator
typedef QList< PvlObject > ::iterator	PvlObjectIterator
	The counter for objects.
typedef QList< PvlObject > ::const_iterator	ConstPvlObjectIterator
enum	InsertMode { Append, Replace }
	Contains both modes: Append or Replace. More...
typedef QList< PvlKeyword > ::iterator	PvlKeywordIterator
	The keyword iterator.
typedef QList< PvlKeyword > ::const_iterator	ConstPvlKeywordIterator
	The const keyword iterator.

Public Member Functions
	PvlObject ()
	Creates a blank PvlObject.
	PvlObject (const QString &name)
	Creates a PvlObject with a specified name.
	PvlObject (const PvlObject &other)
	Copy constructor.
int	groups () const
	Returns the number of groups contained.
PvlGroup &	group (const int index)
	Return the group at the specified index.
const PvlGroup &	group (const int index) const
	Return the group at the specified index.
PvlGroupIterator	beginGroup ()
	Returns the beginning group index.
ConstPvlGroupIterator	beginGroup () const
	Returns the beginning group index.
PvlGroupIterator	endGroup ()
	Returns the ending group index.
ConstPvlGroupIterator	endGroup () const
	Returns the const ending group index.
PvlGroupIterator	findGroup (const QString &name, PvlGroupIterator beg, PvlGroupIterator end)
	Find a group with the specified name, within these indexes.
ConstPvlGroupIterator	findGroup (const QString &name, ConstPvlGroupIterator beg, ConstPvlGroupIterator end) const
	Find a group with the specified name, within these indexes.
PvlKeyword &	findKeyword (const QString &kname, FindOptions opts)
	Finds a keyword in the current PvlObject, or deeper inside other PvlObjects and Pvlgroups within this one.
bool	hasKeyword (const QString &kname, FindOptions opts) const
	See if a keyword is in the current PvlObject, or deeper inside other PvlObjects and Pvlgroups within this one.
Isis::PvlGroup &	findGroup (const QString &name, FindOptions opts=None)
	Finds a group within the current PvlObject.
const Isis::PvlGroup &	findGroup (const QString &name, FindOptions opts=None) const
	Finds a group within the current PvlObject.
void	addGroup (const Isis::PvlGroup &group)
	Add a group to the object.
void	operator+= (const Isis::PvlGroup &group)
void	operator+= (const Isis::PvlObject &obj)
void	deleteGroup (const QString &name)
	Remove a group from the current PvlObject.
void	deleteGroup (const int index)
	Remove a group from the current PvlObject.
bool	hasGroup (const QString &name) const
	Returns a boolean value based on whether the object has the specified group or not.
int	objects () const
	Returns the number of objects.
PvlObject &	object (const int index)
	Return the object at the specified index.
const PvlObject &	object (const int index) const
	Return the object at the specified index.
PvlObjectIterator	beginObject ()
	Returns the index of the beginning object.
ConstPvlObjectIterator	beginObject () const
	Returns the const index of the beginning object.
PvlObjectIterator	endObject ()
	Returns the index of the ending object.
ConstPvlObjectIterator	endObject () const
	Returns the const index of the ending object.
PvlObjectIterator	findObject (const QString &name, PvlObjectIterator beg, PvlObjectIterator end)
	Find the index of object with a specified name, between two indexes.
ConstPvlObjectIterator	findObject (const QString &name, ConstPvlObjectIterator beg, ConstPvlObjectIterator end) const
	Find the index of object with a specified name, between two indexes.
PvlObject &	findObject (const QString &name, FindOptions opts=None)
	Find an object within the current PvlObject.
const PvlObject &	findObject (const QString &name, FindOptions opts=None) const
	Find an object within the current PvlObject.
void	addObject (const PvlObject &object)
	Add a PvlObject.
void	deleteObject (const QString &name)
	Remove an object from the current PvlObject.
void	deleteObject (const int index)
	Remove an object from the current PvlObject.
bool	hasObject (const QString &name) const
	Returns a boolean value based on whether the object exists in the current PvlObject or not.
bool	operator== (const PvlObject &object) const
	Compares two PvlObjects.
void	clear ()
	Remove everything from the current PvlObject.
const PvlObject &	operator= (const PvlObject &other)
	This is an assignment operator.
void	validateObject (PvlObject &pPvlObj)
	Validate Object.
void	setName (const QString &name)
	Set the name of the container.
QString	name () const
	Returns the container name.
bool	isNamed (const QString &match) const
	Returns whether the given string is equal to the container name or not.
QString	type () const
	Returns the container type.
int	keywords () const
	Returns the number of keywords contained in the PvlContainer.
void	addKeyword (const PvlKeyword &keyword, const InsertMode mode=Append)
	Add a keyword to the container.
PvlKeywordIterator	addKeyword (const PvlKeyword &keyword, PvlKeywordIterator pos)
	Insert a keyword at the specified iterator position.
void	operator+= (const PvlKeyword &keyword)
	When you use the += operator with a PvlKeyword, it will call the addKeyword() method.
PvlKeyword &	findKeyword (const QString &name)
	Find a keyword with a specified name.
const PvlKeyword &	findKeyword (const QString &name) const
	Find a keyword with a specified name.
PvlKeywordIterator	findKeyword (const QString &name, PvlKeywordIterator beg, PvlKeywordIterator end)
	Find the index of a keyword, using iterators.
ConstPvlKeywordIterator	findKeyword (const QString &name, ConstPvlKeywordIterator beg, ConstPvlKeywordIterator end) const
	Find the index of a keyword, using iterators.
PvlKeyword &	operator[] (const QString &name)
	When you use the [] operator with a (string) name, it will call the findKeyword() method.
PvlKeyword &	operator[] (const int index)
	Return the PvlKeyword object at the specified index.
PvlKeyword &	operator[] (const char *name)
	When you use the [] operator with a (char) name, it will call the findKeyword() method.
const PvlKeyword &	operator[] (const QString &name) const
	When you use the [] operator with a (string) name, it will call the findKeyword() method.
const PvlKeyword &	operator[] (const int index) const
	Return the PvlKeyword object at the specified index.
PvlKeyword	operator[] (const char *name) const
	When you use the [] operator with a (char) name, it will call the findKeyword() method.
bool	hasKeyword (const QString &name) const
	Check to see if a keyword exists.
PvlKeywordIterator	begin ()
	Return the beginning iterator.
ConstPvlKeywordIterator	begin () const
	Return the const beginning iterator.
PvlKeywordIterator	end ()
	Return the ending iterator.
ConstPvlKeywordIterator	end () const
	Return the const ending iterator.
void	deleteKeyword (const QString &name)
	Remove a specified keyword.
void	deleteKeyword (const int index)
	Remove the specified keyword.
bool	cleanDuplicateKeywords ()
	Removes keywords from the container that have BOTH the same name and value.
void	operator-= (const QString &name)
	When you use the -= operator with a (string) name, it will call the deleteKeyword() method.
void	operator-= (const PvlKeyword &key)
	When you use the -= operator with a PvlKeyword object, it will call the deleteKeyword() method.
QString	fileName () const
	Returns the filename used to initialise the Pvl object.
void	setFormatTemplate (PvlContainer &ref)
bool	hasFormatTemplate ()
PvlContainer *	formatTemplate ()
PvlFormat *	format ()
void	setFormat (PvlFormat *format)
int	indent ()
void	setIndent (int indent)
int	comments () const
QString	comment (const int index) const
void	addComment (const QString &comment)
PvlKeyword &	nameKeyword ()
const PvlKeyword &	nameKeyword () const

Protected Member Functions
void	init ()
	Sets the filename to blank.
void	setFileName (const QString &filename)
	Sets the filename to the specified string.
void	validateAllKeywords (PvlContainer &pPvlCont)
	Validate All the Keywords in a Container comparing with the Template.
void	validateRepeatOption (PvlKeyword &pPvlTmplKwrd, PvlContainer &pPvlCont)
	Validate the Repeat Option for a Keyword.

Protected Attributes
QString	m_filename
	This contains the filename used to initialize the pvl object.
PvlKeyword	m_name
	This is the name keyword.
QList< PvlKeyword >	m_keywords
	This is the vector of PvlKeywords the container is holding.
PvlContainer *	m_formatTemplate

Private Attributes
QList< PvlObject >	m_objects
	A vector of PvlObjects contained in the current PvlObject.
QList< PvlGroup >	m_groups
	A vector of PvlGroups contained in the current PvlObject.

Friends
std::ostream &	operator<< (std::ostream &os, Isis::PvlObject &object)
	Outputs the PvlObject data to a specified output stream.
std::istream &	operator>> (std::istream &is, PvlObject &result)
	This method reads a PvlObject from the input stream.

Detailed Description

Contains Pvl Groups and Pvl Objects.

Contains Pvl groups and objects. Organizes text on output to be indented correctly.

Author

2002-10-11 Jeff Anderson

History:

2005-04-04 Leah Dahmer wrote class documentation.

2006-04-21 Jacob Danton Added format templates abilities.

2006-05-18 Jacob Danton Added DeleteGroup by index

2006-09-11 Stuart Sides Added formatting ability

2007-08-11 Stuart Sides Added recursive FindKeyword and HasKeyword

2007-08-14 Steven Koechle Fixed missing pointers in FindKeyword and HasKeyword

2008-06-18 Steven Lambright Fixed documentation

2008-07-03 Steven Lambright Added const functionality and fixed +=

2008-07-10 Steven Lambright Compensated for PvlKeyword no longer being a parent

2008-09-30 Christopher Austin Replaced all std::endl in the << operator with PvlFormat.FormatEOL()

2009-10-28 Travis Addair Fixed bug causing a format template's object comments to not appear in the output

2009-12-17 Steven Lambright Added reading methods

2009-12-28 Steven Lambright Implemented const FindObject

2010-04-13 Eric Hyer - Added copy constructor Added assignment operator

2010-09-27 Sharmila Prasad - Validate an Object comparing with the corresponding Template Object

2013-03-11 Steven Lambright and Mathew Eis - Brought method names and member variable names up to the current Isis 3 coding standards. Fixes #1533.

Definition at line 71 of file PvlObject.h.

Member Typedef Documentation

typedef QList<PvlKeyword>::const_iterator Isis::PvlContainer::ConstPvlKeywordIterator

inherited

The const keyword iterator.

Definition at line 175 of file PvlContainer.h.

typedef QList<Isis::PvlGroup>::iterator Isis::PvlObject::PvlGroupIterator

The counter for groups.

Definition at line 92 of file PvlObject.h.

typedef QList<PvlKeyword>::iterator Isis::PvlContainer::PvlKeywordIterator

inherited

The keyword iterator.

Definition at line 172 of file PvlContainer.h.

typedef QList<PvlObject>::iterator Isis::PvlObject::PvlObjectIterator

The counter for objects.

Definition at line 236 of file PvlObject.h.

Member Enumeration Documentation

enum Isis::PvlObject::FindOptions

A collection of options to use when finding.

Enumerator
None	Search only the current level.
Traverse	Search child objects.

Definition at line 163 of file PvlObject.h.

enum Isis::PvlContainer::InsertMode

inherited

Contains both modes: Append or Replace.

Definition at line 110 of file PvlContainer.h.

Constructor & Destructor Documentation

Isis::PvlObject::PvlObject

(

)

Creates a blank PvlObject.

Definition at line 40 of file PvlObject.cpp.

Isis::PvlObject::PvlObject

(

const QString &

name

)

Creates a PvlObject with a specified name.

Parameters

name	The name of the PvlObject.

Definition at line 49 of file PvlObject.cpp.

Isis::PvlObject::PvlObject

(

const PvlObject &

other

)

Copy constructor.

Definition at line 55 of file PvlObject.cpp.

References m_groups, and m_objects.

Member Function Documentation

void Isis::PvlObject::addGroup ( const Isis::PvlGroup &  group )

inline

Add a group to the object.

Parameters

group

The PvlGroup object to add.

Definition at line 195 of file PvlObject.h.

References m_groups.

Referenced by Isis::ControlNetDiff::addUniqueMeasure(), Isis::Gruen::AlgorithmStatistics(), Isis::Camera::BasicMapping(), Isis::Camera::basicRingMapping(), Isis::NaifStatus::CheckErrors(), IsisAml::CommandLine(), Isis::ControlNetDiff::compareGroups(), Isis::TiffImporter::convertProjection(), Isis::FileTool::copyCubeDetails(), Isis::Cube::create(), Isis::UserInterface::evaluateOption(), Isis::Application::History(), Isis::ImageImporter::import(), Isis::operator<<(), Isis::operator>>(), Isis::Process::PropagateLabels(), Isis::Cube::putGroup(), Isis::AutoReg::RegistrationStatistics(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::UserInterface::SaveHistory(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::Process::SetOutputCube(), Isis::Table::Table(), Isis::IException::toPvl(), Isis::OverlapStatistics::toPvl(), Isis::ProcessImportPds::TranslatePdsProjection(), Isis::AlphaCube::UpdateGroup(), and Isis::ControlNetFileV0002::Write().

void Isis::PvlContainer::addKeyword ( const PvlKeyword &  keyword, const InsertMode  mode = Append  )

inherited

Add a keyword to the container.

Add a keyword to the PvlContainer object.

Parameters

keyword	The PvlKeyword object to append.
mode	Using the InsertMode value of Append.
key	The PvlKeyword object to add.
mode	The enum InsertMode has two possible values, Append or Replace. Use Append if you just want to add it to the end, Replace if you want to replace it.

Definition at line 218 of file PvlContainer.cpp.

References Isis::PvlKeyword::name().

Referenced by Isis::ControlNetDiff::addUniqueMeasure(), Isis::ControlNetDiff::addUniquePoint(), Isis::NaifStatus::CheckErrors(), Isis::ControlNetDiff::compare(), Isis::ControlNetDiff::compareGroups(), Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::CameraFactory::Create(), Isis::ProjectionFactory::CreateForCube(), Isis::ControlNetDiff::diff(), Isis::ProcessImportFits::extractFitsLabels(), Isis::ExportPdsTable::fillMetaData(), Isis::Application::GetEnviromentInfo(), Isis::CameraPointInfo::GetPointInfo(), Isis::Application::GetUnameInfo(), Isis::PvlContainer::operator+=(), Isis::operator<<(), Isis::operator>>(), Isis::LimitPolygonSeeder::PluginParameters(), Isis::StripPolygonSeeder::PluginParameters(), Isis::GridPolygonSeeder::PluginParameters(), Isis::PolygonSeeder::PluginParameters(), Isis::ProjectionFactory::RingsCreateForCube(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::Projection::SetUpperLeftCorner(), Isis::SubArea::UpdateLabel(), Isis::CubeTileHandler::updateLabels(), Isis::CubeBsqHandler::updateLabels(), and Isis::ControlNetFileV0002::Write().

PvlContainer::PvlKeywordIterator Isis::PvlContainer::addKeyword ( const PvlKeyword &  keyword, PvlKeywordIterator  pos  )

inherited

Insert a keyword at the specified iterator position.

This method provides the capability to insert a keyword at the specified iterator position. The process follows the description of the STL vector definition along with all the caveats (e.g., invalidation of iterators upon insert operations).

This method will not perform any checks for the existance of the keyword. This could lead to multiple instances of the same keyword in the same container. It is up to the caller to manage this issue.

Parameters

key	Keyword to insert
pos	Iterator position where to insert the new keyword

Returns

PvlContainer::PvlKeywordIterator Returns the position of the inserted keyword per the STL vector documentation.

Definition at line 249 of file PvlContainer.cpp.

void Isis::PvlObject::addObject ( const PvlObject &  object )

inline

Add a PvlObject.

Parameters

object

The PvlObject to add.

Definition at line 316 of file PvlObject.h.

References Isis::PvlContainer::fileName(), and m_objects.

Referenced by Isis::History::AddEntry(), Isis::ControlNetDiff::addUniquePoint(), Isis::ControlNetDiff::compare(), Isis::Cube::create(), Isis::ProcessExportPds::ExportTable(), Isis::ExportPdsTable::fillMetaData(), Isis::ProcessExportPds::FixedJP2ImageRoot(), Isis::operator<<(), Isis::operator>>(), Isis::Process::PropagateLabels(), Isis::Process::SetOutputCube(), Isis::ProcessExportPds::StreamJP2ImageRoot(), Isis::ControlNetFileV0002::toPvl(), Isis::ControlNetFileV0001::toPvl(), Isis::ControlNetFileV0002::Write(), and Isis::Blob::Write().

PvlKeywordIterator Isis::PvlContainer::begin ( )

inlineinherited

Return the beginning iterator.

Returns

The beginning iterator.

Definition at line 193 of file PvlContainer.h.

References Isis::PvlContainer::m_keywords.

Referenced by findKeyword(), hasKeyword(), Isis::PvlTranslationTable::InputGroup(), Isis::DbProfile::loadkeys(), and Isis::PvlTranslationTable::Translate().

ConstPvlKeywordIterator Isis::PvlContainer::begin ( ) const

inlineinherited

Return the const beginning iterator.

Returns

The const beginning iterator.

Definition at line 201 of file PvlContainer.h.

References Isis::PvlContainer::m_keywords.

PvlGroupIterator Isis::PvlObject::beginGroup ( )

inline

Returns the beginning group index.

Returns

The iterator of the beginning group..

Definition at line 100 of file PvlObject.h.

References m_groups.

Referenced by deleteGroup(), findGroup(), hasGroup(), and Isis::DbAccess::load().

ConstPvlGroupIterator Isis::PvlObject::beginGroup ( ) const

inline

Returns the beginning group index.

Returns

The iterator of the beginning group..

Definition at line 109 of file PvlObject.h.

References m_groups.

PvlObjectIterator Isis::PvlObject::beginObject ( )

inline

Returns the index of the beginning object.

Returns

The beginning object's index.

Definition at line 244 of file PvlObject.h.

References m_objects.

Referenced by deleteObject(), findObject(), hasObject(), and Isis::ImportPdsTable::loadLabel().

ConstPvlObjectIterator Isis::PvlObject::beginObject ( ) const

inline

Returns the const index of the beginning object.

Returns

The beginning object's index.

Definition at line 253 of file PvlObject.h.

References m_objects.

bool Isis::PvlContainer::cleanDuplicateKeywords ( )

inherited

Removes keywords from the container that have BOTH the same name and value.

Returns

bool True if one or more keywords were deleted; False if no keywords were deleted.

Definition at line 152 of file PvlContainer.cpp.

void Isis::PvlObject::clear ( )

inline

Remove everything from the current PvlObject.

Definition at line 350 of file PvlObject.h.

References Isis::PvlContainer::clear(), m_groups, and m_objects.

Referenced by IsisAml::CommandLine(), and Isis::ControlNetFileV0001::Read().

void Isis::PvlObject::deleteGroup

(

const QString &

name

)

Remove a group from the current PvlObject.

Parameters

name	The name of the PvlGroup to remove.

Exceptions

IException

Definition at line 379 of file PvlObject.cpp.

References _FILEINFO_, beginGroup(), endGroup(), findGroup(), Isis::PvlContainer::m_filename, m_groups, Isis::PvlContainer::name(), Isis::PvlContainer::type(), and Isis::IException::Unknown.

Referenced by Isis::Cube::deleteGroup(), Isis::UserInterface::SaveHistory(), validateObject(), and Isis::Pvl::validatePvl().

void Isis::PvlObject::deleteGroup

(

const int

index

)

Remove a group from the current PvlObject.

Parameters

index

The index of the PvlGroup to remove.

Exceptions

IException

Definition at line 399 of file PvlObject.cpp.

References _FILEINFO_, beginGroup(), Isis::PvlContainer::m_filename, m_groups, Isis::PvlContainer::name(), Isis::PvlContainer::type(), and Isis::IException::Unknown.

void Isis::PvlContainer::deleteKeyword ( const QString &  name )

inherited

Remove a specified keyword.

Parameters

name	The name of the keyword to remove.

Exceptions

iException::Pvl

Keyword doesn't exist.

Definition at line 113 of file PvlContainer.cpp.

References _FILEINFO_.

Referenced by IsisAml::CommandLine(), Isis::MosaicController::convertV1ToV2(), Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::ControlNetVersioner::Copy(), Isis::ControlNetVersioner::LatestPvlToBinary(), Isis::ObliqueCylindrical::ObliqueCylindrical(), Isis::PvlContainer::operator-=(), Isis::LimitPolygonSeeder::Parse(), Isis::GridPolygonSeeder::Parse(), Isis::StripPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::ProcessExportPds::StandardImageImage(), Isis::ProcessExportPds::StandardJP2Image(), Isis::TProjection::TargetRadii(), Isis::SubArea::UpdateLabel(), Isis::TiffImporter::upperLeftXY(), Isis::PvlContainer::validateAllKeywords(), Isis::PvlContainer::validateRepeatOption(), and Isis::Table::WriteInit().

void Isis::PvlContainer::deleteKeyword ( const int  index )

inherited

Remove the specified keyword.

Parameters

index

The index of the keyword to remove.

Exceptions

iException::Pvl

Keyword doesn't exist.

Definition at line 131 of file PvlContainer.cpp.

References _FILEINFO_.

void Isis::PvlObject::deleteObject

(

const QString &

name

)

Remove an object from the current PvlObject.

Parameters

name	The name of the PvlObject to remove.

Exceptions

IException

Definition at line 337 of file PvlObject.cpp.

References _FILEINFO_, beginObject(), endObject(), findObject(), Isis::PvlContainer::m_filename, m_objects, Isis::PvlContainer::name(), Isis::PvlContainer::type(), and Isis::IException::Unknown.

Referenced by Isis::Cube::deleteBlob(), validateObject(), and Isis::Pvl::validatePvl().

void Isis::PvlObject::deleteObject

(

const int

index

)

Remove an object from the current PvlObject.

Parameters

index

The index of the PvlObject to remove.

Exceptions

IException

Definition at line 357 of file PvlObject.cpp.

References _FILEINFO_, beginObject(), Isis::PvlContainer::m_filename, m_objects, Isis::PvlContainer::name(), Isis::PvlContainer::type(), and Isis::IException::Unknown.

PvlKeywordIterator Isis::PvlContainer::end ( )

inlineinherited

Return the ending iterator.

Returns

The ending iterator.

Definition at line 209 of file PvlContainer.h.

References Isis::PvlContainer::m_keywords.

Referenced by findKeyword(), hasKeyword(), Isis::PvlTranslationTable::InputGroup(), Isis::DbProfile::loadkeys(), and Isis::PvlTranslationTable::Translate().

ConstPvlKeywordIterator Isis::PvlContainer::end ( ) const

inlineinherited

Return the const ending iterator.

Returns

The const ending iterator.

Definition at line 217 of file PvlContainer.h.

References Isis::PvlContainer::m_keywords.

PvlGroupIterator Isis::PvlObject::endGroup ( )

inline

Returns the ending group index.

Returns

The iterator of the ending group.

Definition at line 118 of file PvlObject.h.

References m_groups.

Referenced by deleteGroup(), findGroup(), hasGroup(), and Isis::DbAccess::load().

ConstPvlGroupIterator Isis::PvlObject::endGroup ( ) const

inline

Returns the const ending group index.

Returns

The iterator of the ending group.

Definition at line 127 of file PvlObject.h.

References m_groups.

PvlObjectIterator Isis::PvlObject::endObject ( )

inline

Returns the index of the ending object.

Returns

The ending object's index.

Definition at line 262 of file PvlObject.h.

References m_objects.

Referenced by deleteObject(), findObject(), hasObject(), and Isis::ImportPdsTable::loadLabel().

ConstPvlObjectIterator Isis::PvlObject::endObject ( ) const

inline

Returns the const index of the ending object.

Returns

The ending object's index.

Definition at line 271 of file PvlObject.h.

References m_objects.

QString Isis::PvlContainer::fileName ( ) const

inlineinherited

Returns the filename used to initialise the Pvl object.

If the object was not initialized using a file, this string is empty.

Returns

The filename.

Definition at line 247 of file PvlContainer.h.

References Isis::PvlContainer::m_filename.

Referenced by addObject(), Isis::ObservationNumber::Compose(), Isis::SerialNumber::Compose(), Isis::ProjectionFactory::CreateForCube(), Isis::ProjectionFactory::CreateFromCube(), Isis::HrscCamera::HrscCamera(), Isis::Spice::init(), Isis::PvlTranslationTable::InputDefault(), Isis::LimitPolygonSeeder::Parse(), Isis::GridPolygonSeeder::Parse(), Isis::StripPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::InterestOperator::Parse(), Isis::AutoReg::Parse(), Isis::PvlEditDialog::PvlEditDialog(), Isis::ProjectionFactory::RingsCreateForCube(), Isis::ProjectionFactory::RingsCreateFromCube(), and Isis::PvlTranslationTable::Translate().

PvlGroupIterator Isis::PvlObject::findGroup ( const QString &  name, PvlGroupIterator  beg, PvlGroupIterator  end  )

inline

Find a group with the specified name, within these indexes.

Parameters

name	The name of the group to look for.
beg	The lower index
end	The higher index

Definition at line 138 of file PvlObject.h.

Referenced by Isis::SerialNumberList::Add(), Isis::ProcessMosaic::AddBandBinGroup(), Isis::ProjectionConfigDialog::addMissingKeywords(), Isis::ControlNetDiff::addTolerances(), Isis::AlphaCube::AlphaCube(), Isis::AmicaCamera::AmicaCamera(), Isis::ApolloMetricCamera::ApolloMetricCamera(), Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::Chandrayaan1M3Camera::Chandrayaan1M3Camera(), IsisAml::CheckFileNamePreference(), Isis::MdisCamera::computeFocalLength(), Isis::TiffImporter::convertProjection(), Isis::InterestOperatorFactory::Create(), Isis::CameraFactory::Create(), Isis::PolygonSeederFactory::Create(), Isis::AutoRegFactory::Create(), Isis::ProjectionFactory::Create(), Isis::ProjectionFactory::CreateForCube(), Isis::ProjectionFactory::CreateFromCube(), Isis::CrismCamera::CrismCamera(), Isis::CTXCamera::CTXCamera(), Isis::CubeIoHandler::CubeIoHandler(), Isis::DawnFcCamera::DawnFcCamera(), deleteGroup(), Isis::DemShape::DemShape(), Isis::Equirectangular::Equirectangular(), Isis::UserInterface::evaluateOption(), Isis::KernelDb::findAll(), Isis::Kernels::findKernels(), Isis::ObservationNumber::FindObservationTranslation(), Isis::SerialNumber::FindSerialTranslation(), Isis::MosaicSceneWidget::fromPvl(), Isis::TiffImporter::gdalItems(), Isis::CubeViewport::getBandFilterName(), Isis::ProcessMosaic::GetBandIndex(), Isis::Kernels::getCameraVersion(), Isis::Plugin::GetPlugin(), Isis::GroundGrid::GroundGrid(), Isis::Camera::GroundRange(), Isis::Cube::group(), hasGroup(), Isis::Spice::hasKernels(), Isis::HiresCamera::HiresCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::HrscCamera::HrscCamera(), Isis::IdealCamera::IdealCamera(), Isis::VimsSkyMap::Init(), Isis::VimsGroundMap::Init(), Isis::Gruen::init(), Isis::Spice::init(), Isis::DatabaseFactory::initPreferences(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::KaguyaMiCamera::KaguyaMiCamera(), Isis::LambertConformal::LambertConformal(), Isis::Stretch::Load(), Isis::DbAccess::load(), Isis::ProjectionConfigDialog::loadFromFile(), Isis::iTime::LoadLeapSecondKernel(), Isis::LoHighCamera::LoHighCamera(), Isis::LoMediumCamera::LoMediumCamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::LunarAzimuthalEqualArea::LunarAzimuthalEqualArea(), Isis::LwirCamera::LwirCamera(), Isis::MarciCamera::MarciCamera(), Isis::Mariner10Camera::Mariner10Camera(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::KernelDb::matches(), Isis::MdisCamera::MdisCamera(), Isis::Mercator::Mercator(), Isis::MiniRF::MiniRF(), Isis::Process::MissionData(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), Isis::MocWideAngleCamera::MocWideAngleCamera(), Isis::MsiCamera::MsiCamera(), Isis::NaifDskShape::NaifDskShape(), Isis::NewHorizonsLeisaCamera::NewHorizonsLeisaCamera(), Isis::NewHorizonsLorriCamera::NewHorizonsLorriCamera(), Isis::NewHorizonsMvicFrameCamera::NewHorizonsMvicFrameCamera(), Isis::NewHorizonsMvicTdiCamera::NewHorizonsMvicTdiCamera(), Isis::NirCamera::NirCamera(), Isis::ObliqueCylindrical::ObliqueCylindrical(), Isis::Orthographic::Orthographic(), Isis::LimitPolygonSeeder::Parse(), Isis::StripPolygonSeeder::Parse(), Isis::GridPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::ControlNetValidMeasure::Parse(), Isis::InterestOperator::Parse(), Isis::AutoReg::Parse(), Isis::Planar::Planar(), Isis::PointPerspective::PointPerspective(), Isis::PolarStereographic::PolarStereographic(), Isis::ProcessImportPds::ProcessImportPds(), Isis::Progress::Progress(), Isis::Projection::Projection(), Isis::Cube::putGroup(), Isis::ControlNetVersioner::ReadBinaryNetwork(), Isis::MocLabels::ReadLabels(), Isis::CissLabels::ReadLabels(), Isis::PvlKeyword::reform(), Isis::ReseauDistortionMap::ReseauDistortionMap(), Isis::TiffImporter::resolution(), Isis::RingCylindrical::RingCylindrical(), Isis::Camera::ringRange(), Isis::ProjectionFactory::RingsCreate(), Isis::ProjectionFactory::RingsCreateForCube(), Isis::ProjectionFactory::RingsCreateFromCube(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::Robinson::Robinson(), Isis::UserInterface::SaveHistory(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessMosaic::SetMosaicOrigin(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::ProcessGroundPolygons::SetStatCubes(), Isis::SimpleCylindrical::SimpleCylindrical(), Isis::Sinusoidal::Sinusoidal(), Isis::Spice::Spice(), Isis::SsiCamera::SsiCamera(), Isis::ProcessExportPds::StandardAllMapping(), Isis::Target::Target(), Isis::TProjection::TargetRadii(), Isis::Pipeline::TemporaryFolder(), Isis::ThemisIrCamera::ThemisIrCamera(), Isis::ThemisVisCamera::ThemisVisCamera(), Isis::AdvancedTrackTool::TrackMosaicOrigin(), Isis::ProcessImportPds::TranslateIsis2BandBin(), Isis::ProcessImportPds::TranslateIsis2Instrument(), Isis::ProcessImportPds::TranslatePdsProjection(), Isis::TransverseMercator::TransverseMercator(), Isis::AlphaCube::UpdateGroup(), Isis::Gui::UpdateHistory(), Isis::TiffImporter::upperLeftXY(), Isis::UvvisCamera::UvvisCamera(), validateObject(), Isis::Pvl::validatePvl(), Isis::VikingCamera::VikingCamera(), Isis::VimsCamera::VimsCamera(), and Isis::VoyagerCamera::VoyagerCamera().

ConstPvlGroupIterator Isis::PvlObject::findGroup ( const QString &  name, ConstPvlGroupIterator  beg, ConstPvlGroupIterator  end  ) const

inline

Find a group with the specified name, within these indexes.

Parameters

name	The name of the group to look for.
beg	The lower index
end	The higher index

Definition at line 152 of file PvlObject.h.

Isis::PvlGroup & Isis::PvlObject::findGroup	(	const QString &	name,
		PvlObject::FindOptions	opts = None
	)

Finds a group within the current PvlObject.

Parameters

name	The name of the group to look for.
opts	The FindOptions option (None or Traverse).

Returns

The PvlGroup object sought for.

Exceptions

IException

Definition at line 72 of file PvlObject.cpp.

References _FILEINFO_, beginGroup(), endGroup(), Isis::PvlContainer::m_filename, Traverse, and Isis::IException::Unknown.

const Isis::PvlGroup & Isis::PvlObject::findGroup	(	const QString &	name,
		PvlObject::FindOptions	opts = None
	)		const

Finds a group within the current PvlObject.

Parameters

name	The name of the group to look for.
opts	The FindOptions option (None or Traverse).

Returns

The PvlGroup object sought for.

Exceptions

IException

Definition at line 107 of file PvlObject.cpp.

References _FILEINFO_, beginGroup(), endGroup(), Isis::PvlContainer::m_filename, Traverse, and Isis::IException::Unknown.

Isis::PvlKeyword & Isis::PvlContainer::findKeyword ( const QString &  name )

inherited

Find a keyword with a specified name.

Parameters

name	The name of the keyword to look for.

Returns

The PvlKeyword object.

Exceptions

iException::Pvl

The keyword doesn't exist.

Definition at line 78 of file PvlContainer.cpp.

References _FILEINFO_.

Referenced by Isis::ApolloMetricCamera::ApolloMetricCamera(), IsisAml::CheckFileNamePreference(), Isis::ControlNetDiff::compare(), Isis::ControlNetDiff::compareGroups(), Isis::CubeIoHandler::CubeIoHandler(), Isis::SpectralPlotWindow::drawBandMarkers(), Isis::CubeViewport::getBandFilterName(), Isis::CameraPointInfo::GetPointInfo(), Isis::SpectralPlotTool::getSpectralStatistics(), Isis::PvlTranslationTable::InputGroup(), Isis::PvlTranslationManager::InputKeyword(), Isis::Stretch::Load(), Isis::ProcessMosaic::MatchDEMShapeModel(), Isis::PvlContainer::operator[](), Isis::ReseauDistortionMap::ReseauDistortionMap(), Isis::ProcessExportPds::StandardAllMapping(), Isis::TProjection::TargetRadii(), Isis::PvlTranslationTable::Translate(), Isis::PvlContainer::validateAllKeywords(), validateObject(), and Isis::Pvl::validatePvl().

const Isis::PvlKeyword & Isis::PvlContainer::findKeyword ( const QString &  name ) const

inherited

Find a keyword with a specified name.

Parameters

name	The name of the keyword to look for.

Returns

The PvlKeyword object.

Exceptions

IException

The keyword doesn't exist.

Definition at line 96 of file PvlContainer.cpp.

References _FILEINFO_.

PvlKeyword & Isis::PvlObject::findKeyword	(	const QString &	kname,
		FindOptions	opts
	)

Finds a keyword in the current PvlObject, or deeper inside other PvlObjects and Pvlgroups within this one.

Note: This member has the same name as the PvlContainer and hides those implementations, but with the using statement the parents FindKeyword members ar made visible. Note: If more than one occurance of a Keyword appears below this Object no guarantee is made as to which one is returned.

Parameters

kname	The name of the keyword to look for.
opts	The FindOptions option (None or Traverse).

Returns

The keyword sought

Exceptions

IException

Definition at line 148 of file PvlObject.cpp.

References _FILEINFO_, Isis::PvlContainer::begin(), Isis::PvlContainer::end(), group(), Isis::PvlContainer::m_filename, None, and Isis::IException::Unknown.

Referenced by Isis::ControlNetDiff::compare(), Isis::CubeIoHandler::CubeIoHandler(), Isis::Cube::deleteBlob(), Isis::ProcessMosaic::GetTrackStatus(), Isis::ControlNetVersioner::LatestPvlToBinary(), Isis::SpicePosition::LoadCache(), Isis::SpiceRotation::LoadCache(), Isis::ImportPdsTable::loadLabel(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::ProcessMosaic::SetMosaicOrigin(), Isis::SsiCamera::SsiCamera(), Isis::ProcessExportPds::StandardAllMapping(), validateObject(), and Isis::Pvl::validatePvl().

PvlContainer::PvlKeywordIterator Isis::PvlContainer::findKeyword ( const QString &  name, PvlContainer::PvlKeywordIterator  beg, PvlContainer::PvlKeywordIterator  end  )

inherited

Find the index of a keyword, using iterators.

Parameters

name	The name of the keyword.
beg	The beginning iterator.
end	The ending iterator.

Returns

The keyword index.

Definition at line 367 of file PvlContainer.cpp.

PvlContainer::ConstPvlKeywordIterator Isis::PvlContainer::findKeyword ( const QString &  name, PvlContainer::ConstPvlKeywordIterator  beg, PvlContainer::ConstPvlKeywordIterator  end  ) const

inherited

Find the index of a keyword, using iterators.

Parameters

name	The name of the keyword.
beg	The beginning iterator.
end	The ending iterator.

Returns

The keyword index.

Definition at line 382 of file PvlContainer.cpp.

PvlObjectIterator Isis::PvlObject::findObject ( const QString &  name, PvlObjectIterator  beg, PvlObjectIterator  end  )

inline

Find the index of object with a specified name, between two indexes.

Parameters

name	The name of the object to find.
beg	The lower index.
end	The higher index.

Returns

The index of the object.

Definition at line 283 of file PvlObject.h.

Referenced by Isis::SerialNumberList::Add(), Isis::ProcessMosaic::AddBandBinGroup(), Isis::ProcessMosaic::AddDefaultBandBinGroup(), Isis::AlbedoAtm::AlbedoAtm(), Isis::AlphaCube::AlphaCube(), Isis::AtmosModel::AtmosModel(), Isis::AutoReg::AutoReg(), Isis::Camera::Camera(), Isis::ControlNetDiff::compare(), Isis::MosaicController::convertV1ToV2(), Isis::FileTool::copyCubeDetails(), Isis::AtmosModelFactory::Create(), Isis::PhotoModelFactory::Create(), Isis::NormModelFactory::Create(), Isis::ProcessExportPds::CreateQubeLabel(), Isis::ProcessExportPds::CreateSpectralQubeLabel(), Isis::CubeIoHandler::CubeIoHandler(), Isis::CubeTileHandler::CubeTileHandler(), Isis::Cube::deleteGroup(), deleteObject(), Isis::SpectralPlotWindow::drawBandMarkers(), Isis::Cube::externalCubeFileName(), Isis::KernelDb::findAll(), Isis::Image::fromPvl(), Isis::MosaicSceneWidget::fromPvl(), Isis::CubeViewport::getBandFilterName(), Isis::ProcessImportPds::GetProjectionOffsetMults(), Isis::SpectralPlotTool::getSpectralStatistics(), Isis::Cube::group(), Isis::Cube::hasGroup(), hasObject(), Isis::ImageImporter::import(), Isis::Spice::init(), Isis::DbAccess::load(), Isis::ImportPdsTable::loadLabel(), Isis::ProcessMosaic::MatchDEMShapeModel(), Isis::KernelDb::matches(), Isis::Cube::open(), Isis::AutoReg::Parse(), Isis::PhotoModel::PhotoModel(), Isis::Process::PropagateLabels(), Isis::Cube::putGroup(), Isis::ControlNetFileV0001::Read(), Isis::ControlNetFileV0002::Read(), Isis::ControlNetVersioner::ReadBinaryNetwork(), Isis::ControlNetVersioner::ReadPvlNetwork(), Isis::Cube::realDataFileName(), Isis::BandSpinBox::setBandBin(), Isis::BandTool::setBandBin(), Isis::BandTool::setList(), Isis::Process::SetOutputCube(), Isis::ProcessMosaic::SetOutputCube(), Isis::ProcessExportPds::StandardAllMapping(), Isis::ProcessExportPds::StandardImageImage(), Isis::ProcessExportPds::StandardJP2Image(), Isis::ProcessMosaic::StartProcess(), Isis::ControlNetFileV0002::toPvl(), Isis::ControlNetFileV0001::toPvl(), Isis::AdvancedTrackTool::TrackMosaicOrigin(), Isis::AlphaCube::UpdateGroup(), Isis::SubArea::UpdateLabel(), Isis::CubeTileHandler::updateLabels(), Isis::CubeBsqHandler::updateLabels(), Isis::SpectralPlotTool::updateTool(), validateObject(), Isis::Pvl::validatePvl(), and Isis::Blob::Write().

ConstPvlObjectIterator Isis::PvlObject::findObject ( const QString &  name, ConstPvlObjectIterator  beg, ConstPvlObjectIterator  end  ) const

inline

Find the index of object with a specified name, between two indexes.

Parameters

name	The name of the object to find.
beg	The lower index.
end	The higher index.

Returns

The index of the object.

Definition at line 298 of file PvlObject.h.

PvlObject & Isis::PvlObject::findObject	(	const QString &	name,
		PvlObject::FindOptions	opts = None
	)

Find an object within the current PvlObject.

Parameters

name	The object name to look for.
opts	The FindOptions option (None or Traverse).

Returns

The PvlObject sought for.

Exceptions

IException

Definition at line 261 of file PvlObject.cpp.

References _FILEINFO_, beginObject(), endObject(), Isis::PvlContainer::m_filename, Traverse, and Isis::IException::Unknown.

const PvlObject & Isis::PvlObject::findObject	(	const QString &	name,
		FindOptions	opts = None
	)		const

Find an object within the current PvlObject.

Parameters

name	The object name to look for.
opts	The FindOptions option (None or Traverse).

Returns

The PvlObject sought for.

Exceptions

IException

Definition at line 296 of file PvlObject.cpp.

References _FILEINFO_, beginObject(), endObject(), Isis::PvlContainer::m_filename, Traverse, and Isis::IException::Unknown.

Isis::PvlGroup & Isis::PvlObject::group

(

const int

index

)

Return the group at the specified index.

Parameters

index

The index of the group.

Returns

The PvlGroup sought for.

Exceptions

IException

Definition at line 423 of file PvlObject.cpp.

References _FILEINFO_, Isis::Message::ArraySubscriptNotInRange(), m_groups, and Isis::IException::Programmer.

Referenced by Isis::ControlNetDiff::compare(), Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::FileTool::copyCubeDetails(), Isis::KernelDb::findAll(), findKeyword(), Isis::ProcessImportPds::GetProjectionOffsetMults(), hasKeyword(), Isis::UserInterface::loadHistory(), Isis::KernelDb::loadKernelDbFiles(), Isis::operator<<(), Isis::Process::PropagateLabels(), Isis::Table::ReadInit(), Isis::Application::SendParentErrors(), Isis::Process::SetOutputCube(), Isis::Gui::UpdateHistory(), validateObject(), and Isis::Pvl::validatePvl().

const Isis::PvlGroup & Isis::PvlObject::group

(

const int

index

)

const

Return the group at the specified index.

Parameters

index

The index of the group.

Returns

The PvlGroup sought for.

Exceptions

IException

Definition at line 442 of file PvlObject.cpp.

References _FILEINFO_, Isis::Message::ArraySubscriptNotInRange(), m_groups, and Isis::IException::Programmer.

int Isis::PvlObject::groups ( ) const

inline

Returns the number of groups contained.

Returns

The number of groups.

Definition at line 84 of file PvlObject.h.

References m_groups.

Referenced by Isis::ControlNetDiff::compare(), Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::FileTool::copyCubeDetails(), Isis::KernelDb::findAll(), Isis::ProcessImportPds::GetProjectionOffsetMults(), Isis::UserInterface::loadHistory(), Isis::KernelDb::loadKernelDbFiles(), Isis::operator<<(), Isis::Process::PropagateLabels(), Isis::Table::ReadInit(), Isis::UserInterface::SaveHistory(), Isis::Application::SendParentErrors(), Isis::Process::SetOutputCube(), Isis::IException::toString(), Isis::Gui::UpdateHistory(), validateObject(), and Isis::Pvl::validatePvl().

bool Isis::PvlObject::hasGroup ( const QString &  name ) const

inline

Returns a boolean value based on whether the object has the specified group or not.

Parameters

name	The name of the group to look for.

Returns

True if the object has the group, false if not.

Definition at line 219 of file PvlObject.h.

References beginGroup(), endGroup(), and findGroup().

Referenced by Isis::SerialNumberList::Add(), Isis::ControlNetDiff::addTolerances(), Isis::AlphaCube::AlphaCube(), Isis::ControlNetValidMeasure::ControlNetValidMeasure(), Isis::Cube::deleteGroup(), Isis::KernelDb::findAll(), Isis::CubeViewport::getBandFilterName(), Isis::Cube::hasGroup(), Isis::DatabaseFactory::initPreferences(), Isis::operator<<(), Isis::AutoReg::Parse(), Isis::Cube::putGroup(), Isis::AlphaCube::UpdateGroup(), validateObject(), and Isis::Pvl::validatePvl().

bool Isis::PvlContainer::hasKeyword ( const QString &  name ) const

inherited

Check to see if a keyword exists.

Parameters

name	The name of the keyword to check for.

Returns

True if the keyword exists, false if it doesn't.

Definition at line 175 of file PvlContainer.cpp.

Referenced by Isis::Latitude::add(), Isis::ProjectionConfigDialog::addMissingKeywords(), Isis::PvlTranslationTable::AddTable(), Isis::AlbedoAtm::AlbedoAtm(), Isis::AtmosModel::AtmosModel(), Isis::Camera::Camera(), IsisAml::CommandLine(), Isis::ControlNetDiff::compareGroups(), Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::ControlNetVersioner::Copy(), Isis::CameraFactory::Create(), Isis::AtmosModelFactory::Create(), Isis::PhotoModelFactory::Create(), Isis::NormModelFactory::Create(), Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Isis::DemShape::DemShape(), Isis::PvlTranslationManager::DoTranslation(), Isis::SpectralPlotWindow::drawBandMarkers(), Isis::Equirectangular::Equirectangular(), Isis::ProcessImportFits::extractFitsLabels(), Isis::KernelDb::findAll(), Isis::Kernels::findKernels(), Isis::FeatureNomenclatureTool::findMissingNomenclature(), Isis::CubeViewport::getBandFilterName(), Isis::Kernels::getCameraVersion(), Isis::SpectralPlotTool::getSpectralStatistics(), Isis::UniversalGroundMap::GroundRange(), Isis::Camera::GroundRange(), Isis::Spice::hasKernels(), Isis::HiLab::HiLab(), Isis::IdealCamera::IdealCamera(), Isis::Spice::init(), Isis::DatabaseFactory::initPreferences(), Isis::PvlTranslationTable::InputDefault(), Isis::PvlTranslationManager::InputHasKeyword(), Isis::PvlTranslationManager::InputKeyword(), Isis::PvlTranslationTable::InputKeywordName(), Isis::LambertConformal::LambertConformal(), Isis::ControlNetVersioner::LatestPvlToBinary(), Isis::Latitude::Latitude(), Isis::LoMediumCamera::LoMediumCamera(), Isis::RingPlaneProjection::Mapping(), Isis::TProjection::Mapping(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::ProcessMosaic::MatchDEMShapeModel(), Isis::KernelDb::matches(), Isis::Mercator::Mercator(), Isis::NaifDskShape::NaifDskShape(), Isis::ObliqueCylindrical::ObliqueCylindrical(), Isis::operator<<(), Isis::Orthographic::Orthographic(), Isis::LimitPolygonSeeder::Parse(), Isis::GridPolygonSeeder::Parse(), Isis::StripPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::AutoReg::Parse(), Isis::PhotoModel::PhotoModel(), Isis::Planar::Planar(), Isis::ControlNetFilter::PointDistanceFilter(), Isis::ControlNetFilter::PointEditLockFilter(), Isis::ControlNetFilter::PointGoodnessOfFitFilter(), Isis::ControlNetFilter::PointLatLonFilter(), Isis::ControlNetFilter::PointMeasurePropertiesFilter(), Isis::ControlNetFilter::PointMeasuresFilter(), Isis::ControlNetFilter::PointNumMeasuresEditLockFilter(), Isis::PointPerspective::PointPerspective(), Isis::ControlNetFilter::PointPixelShiftFilter(), Isis::ControlNetFilter::PointPropertiesFilter(), Isis::ControlNetFilter::PointResMagnitudeFilter(), Isis::PolarStereographic::PolarStereographic(), Isis::Projection::Projection(), Isis::ControlNetVersioner::ReadBinaryNetwork(), Isis::MocLabels::ReadLabels(), Isis::AutoReg::RegTemplate(), Isis::RingCylindrical::RingCylindrical(), Isis::RingPlaneProjection::RingPlaneProjection(), Isis::Camera::ringRange(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::Robinson::Robinson(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::ProcessImportFits::setProcessFileStructure(), Isis::SimpleCylindrical::SimpleCylindrical(), Isis::Sinusoidal::Sinusoidal(), Isis::ProcessImportFits::standardInstrumentGroup(), Isis::Target::Target(), Isis::TProjection::TargetRadii(), Isis::ThemisIrCamera::ThemisIrCamera(), Isis::ControlNetFileV0002::toPvl(), Isis::IException::toString(), Isis::TProjection::TProjection(), Isis::PvlTranslationManager::Translate(), Isis::PvlTranslationTable::Translate(), Isis::ProcessImportPds::TranslateIsis2Instrument(), Isis::TransverseMercator::TransverseMercator(), Isis::SubArea::UpdateLabel(), Isis::SpectralPlotTool::updateTool(), Isis::TiffImporter::upperLeftXY(), Isis::PvlContainer::validateAllKeywords(), validateObject(), and Isis::Pvl::validatePvl().

bool Isis::PvlObject::hasKeyword	(	const QString &	kname,
		FindOptions	opts
	)		const

See if a keyword is in the current PvlObject, or deeper inside other PvlObjects and Pvlgroups within this one.

Note: This member has the same name as the PvlContainer and hides those implementations, but with the using statement the parents FindKeyword members ar made visible.

Parameters

kname	The name of the keyword to look for.
opts	The FindOptions option (None or Traverse).

Returns

True if the Keyword exists False otherwise.

Definition at line 207 of file PvlObject.cpp.

References Isis::PvlContainer::begin(), Isis::PvlContainer::end(), group(), and None.

Referenced by Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::ControlNetVersioner::ConvertVersion2ToVersion3(), Isis::CubeTileHandler::CubeTileHandler(), Isis::Image::fromPvl(), Isis::MosaicGridTool::fromPvl(), Isis::ProcessMosaic::GetTrackStatus(), Isis::Cube::hasTable(), Isis::Image::isFootprintable(), Isis::SpicePosition::LoadCache(), Isis::SpiceRotation::LoadCache(), Isis::ImportPdsTable::loadLabel(), Isis::Cube::open(), Isis::operator<<(), Isis::Table::ReadInit(), Isis::ControlNetVersioner::ReadPvlNetwork(), Isis::ProcessMosaic::SetMosaicOrigin(), Isis::ProcessExportPds::StandardAllMapping(), Isis::ProcessExportPds::StandardImageImage(), Isis::ProcessExportPds::StandardJP2Image(), validateObject(), Isis::Pvl::validatePvl(), and Isis::Table::WriteInit().

bool Isis::PvlObject::hasObject ( const QString &  name ) const

inline

Returns a boolean value based on whether the object exists in the current PvlObject or not.

Parameters

name	The name of the object to search for.

Returns

True if the current PvlObject has the specified object, false if it does not.

Definition at line 332 of file PvlObject.h.

References beginObject(), endObject(), and findObject().

Referenced by Isis::MosaicController::convertV1ToV2(), Isis::ProjectionFactory::CreateForCube(), Isis::ProcessExportPds::CreateQubeLabel(), Isis::ProcessExportPds::CreateSpectralQubeLabel(), Isis::KernelDb::findAll(), Isis::MosaicSceneWidget::fromPvl(), Isis::ProcessMosaic::GetTrackStatus(), Isis::Gruen::init(), Isis::Spice::init(), Isis::ImportPdsTable::loadLabel(), Isis::operator<<(), Isis::Photometry::Photometry(), Isis::Process::PropagateLabels(), Isis::ProjectionFactory::RingsCreateForCube(), Isis::ProcessMosaic::SetMosaicOrigin(), Isis::ProcessExportPds::StandardAllMapping(), validateObject(), and Isis::Pvl::validatePvl().

void Isis::PvlContainer::init ( )

protectedinherited

Sets the filename to blank.

Definition at line 67 of file PvlContainer.cpp.

bool Isis::PvlContainer::isNamed ( const QString &  match ) const

inlineinherited

Returns whether the given string is equal to the container name or not.

Parameters

match

The string to compare to the name.

Returns

True if the name and string are the same, false if they are not.

Definition at line 87 of file PvlContainer.h.

References Isis::PvlContainer::m_name, and Isis::PvlKeyword::stringEqual().

Referenced by Isis::FileTool::copyCubeDetails(), Isis::Blob::Find(), Isis::KernelDb::findAll(), Isis::Cube::hasTable(), Isis::IsBlob(), Isis::Image::isFootprintable(), Isis::UserInterface::loadHistory(), Isis::KernelDb::loadKernelDbFiles(), Isis::Table::ReadInit(), Isis::Process::SetOutputCube(), Isis::Gui::UpdateHistory(), and Isis::Process::WriteHistory().

int Isis::PvlContainer::keywords ( ) const

inlineinherited

Returns the number of keywords contained in the PvlContainer.

Returns

The number of keywords.

Definition at line 101 of file PvlContainer.h.

References Isis::PvlContainer::m_keywords.

Referenced by Isis::ProcessMosaic::AddBandBinGroup(), Isis::PvlTranslationTable::AddTable(), Isis::ControlNetDiff::addTolerances(), Isis::ControlNetDiff::compare(), Isis::ControlNetDiff::compareGroups(), Isis::MosaicController::convertV1ToV2(), Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::KernelDb::files(), Isis::KernelDb::findAll(), Isis::ObservationNumber::FindObservationTranslation(), Isis::SerialNumber::FindSerialTranslation(), Isis::MosaicSceneWidget::fromPvl(), Isis::CameraPointInfo::GetPointInfo(), Isis::ImageImporter::import(), Isis::ControlNetVersioner::LatestPvlToBinary(), Isis::UserInterface::loadHistory(), Isis::KernelDb::loadKernelDbFiles(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::KernelDb::matches(), Isis::operator<<(), Isis::ControlNetFilter::PointCubeNamesFilter(), Isis::BandSpinBox::setBandBin(), Isis::BandTool::setBandBin(), Isis::BandTool::setList(), Isis::AdvancedTrackTool::TrackMosaicOrigin(), Isis::Gui::UpdateHistory(), Isis::PvlGroup::validateGroup(), validateObject(), Isis::Pvl::validatePvl(), and Isis::PvlContainer::validateRepeatOption().

QString Isis::PvlContainer::name ( ) const

inlineinherited

Returns the container name.

Returns

The container name.

Definition at line 78 of file PvlContainer.h.

References Isis::PvlContainer::m_name.

Referenced by Isis::PvlTranslationTable::AddTable(), Isis::ControlNetDiff::addTolerances(), Isis::FileTool::copyCubeDetails(), Isis::Cube::deleteBlob(), deleteGroup(), deleteObject(), Isis::KernelDb::files(), Isis::ControlNetVersioner::LatestPvlToBinary(), Isis::UserInterface::loadHistory(), Isis::ImportPdsTable::loadLabel(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::operator<<(), Isis::PvlGroup::operator==(), operator==(), Isis::operator>>(), Isis::Cube::putGroup(), Isis::BandSpinBox::setBandBin(), Isis::BandTool::setBandBin(), Isis::Process::SetOutputCube(), Isis::OverlapStatistics::toPvl(), Isis::Gui::UpdateHistory(), Isis::PvlGroup::validateGroup(), validateObject(), Isis::Pvl::validatePvl(), and Isis::Blob::Write().

PvlObject & Isis::PvlObject::object

(

const int

index

)

Return the object at the specified index.

Parameters

index

The index of the object.

Returns

The PvlObject sought for.

Exceptions

IException::Programmer

Definition at line 460 of file PvlObject.cpp.

References _FILEINFO_, Isis::Message::ArraySubscriptNotInRange(), m_objects, and Isis::IException::Programmer.

Referenced by Isis::ControlNetDiff::compare(), Isis::MosaicController::convertV1ToV2(), Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::ControlNetVersioner::ConvertVersion2ToVersion3(), Isis::ControlNetVersioner::ConvertVersion3ToVersion4(), Isis::FileTool::copyCubeDetails(), Isis::Cube::deleteBlob(), Isis::Blob::Find(), Isis::KernelDb::findAll(), Isis::ProcessMosaic::GetTrackStatus(), Isis::Cube::hasTable(), Isis::Image::isFootprintable(), Isis::ControlNetVersioner::LatestPvlToBinary(), Isis::UserInterface::loadHistory(), Isis::ImportPdsTable::loadLabel(), Isis::operator<<(), Isis::Process::PropagateTables(), Isis::ProcessMosaic::SetMosaicOrigin(), Isis::Process::SetOutputCube(), validateObject(), Isis::Pvl::validatePvl(), Isis::Blob::Write(), and Isis::Process::WriteHistory().

const PvlObject & Isis::PvlObject::object

(

const int

index

)

const

Return the object at the specified index.

Parameters

index

The index of the object.

Returns

The PvlObject sought for.

Exceptions

IException::Programmer

Definition at line 478 of file PvlObject.cpp.

References _FILEINFO_, Isis::Message::ArraySubscriptNotInRange(), m_objects, and Isis::IException::Programmer.

int Isis::PvlObject::objects ( ) const

inline

Returns the number of objects.

Returns

The number of objects.

Definition at line 228 of file PvlObject.h.

References m_objects.

Referenced by Isis::ControlNetDiff::compare(), Isis::MosaicController::convertV1ToV2(), Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::ControlNetVersioner::ConvertVersion2ToVersion3(), Isis::ControlNetVersioner::ConvertVersion3ToVersion4(), Isis::FileTool::copyCubeDetails(), Isis::Blob::Find(), Isis::KernelDb::findAll(), Isis::ProcessMosaic::GetTrackStatus(), Isis::Image::isFootprintable(), Isis::ControlNetVersioner::LatestPvlToBinary(), Isis::ImportPdsTable::loadLabel(), Isis::operator<<(), Isis::Process::PropagateTables(), Isis::ProcessMosaic::SetMosaicOrigin(), Isis::Process::SetOutputCube(), validateObject(), Isis::Pvl::validatePvl(), Isis::Blob::Write(), and Isis::Process::WriteHistory().

void Isis::PvlContainer::operator+= ( const PvlKeyword &  keyword )

inlineinherited

When you use the += operator with a PvlKeyword, it will call the addKeyword() method.

Parameters

keyword

The PvlKeyword to be added.

Definition at line 125 of file PvlContainer.h.

References Isis::PvlContainer::addKeyword().

void Isis::PvlContainer::operator-= ( const QString &  name )

inlineinherited

When you use the -= operator with a (string) name, it will call the deleteKeyword() method.

Parameters

name	The name of the keyword to remove.

Definition at line 231 of file PvlContainer.h.

References Isis::PvlContainer::deleteKeyword().

void Isis::PvlContainer::operator-= ( const PvlKeyword &  key )

inlineinherited

When you use the -= operator with a PvlKeyword object, it will call the deleteKeyword() method.

Parameters

key	The PvlKeyword object to remove.

Definition at line 239 of file PvlContainer.h.

References Isis::PvlContainer::deleteKeyword(), and Isis::PvlKeyword::name().

const PvlObject & Isis::PvlObject::operator=

(

const PvlObject &

other

)

This is an assignment operator.

Definition at line 792 of file PvlObject.cpp.

References m_groups, m_objects, and Isis::PvlContainer::operator=().

Referenced by Isis::Pvl::operator=().

bool Isis::PvlObject::operator== ( const PvlObject &  object ) const

inline

Compares two PvlObjects.

Returns a boolean value based on the StringEqual() method.

Parameters

object

The PvlObject to compare.

Returns

True if they are equal, false if not.

Definition at line 344 of file PvlObject.h.

References Isis::PvlContainer::name(), and Isis::PvlKeyword::stringEqual().

PvlKeyword& Isis::PvlContainer::operator[] ( const QString &  name )

inlineinherited

When you use the [] operator with a (string) name, it will call the findKeyword() method.

Parameters

name	The name of the keyword to find.

Definition at line 135 of file PvlContainer.h.

References Isis::PvlContainer::findKeyword().

Referenced by Isis::PvlContainer::operator[]().

PvlKeyword & Isis::PvlContainer::operator[] ( const int  index )

inherited

Return the PvlKeyword object at the specified index.

Parameters

index

The index to use.

Returns

The PvlKeyword at the specified index.

Exceptions

iException::Message

The index is out of bounds.

Definition at line 188 of file PvlContainer.cpp.

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

PvlKeyword& Isis::PvlContainer::operator[] ( const char *  name )

inlineinherited

When you use the [] operator with a (char) name, it will call the findKeyword() method.

Parameters

name	The name of the keyword to find.

Definition at line 145 of file PvlContainer.h.

References Isis::PvlContainer::operator[]().

const PvlKeyword& Isis::PvlContainer::operator[] ( const QString &  name ) const

inlineinherited

When you use the [] operator with a (string) name, it will call the findKeyword() method.

Parameters

name	The name of the keyword to find.

Definition at line 156 of file PvlContainer.h.

References Isis::PvlContainer::findKeyword().

const Isis::PvlKeyword & Isis::PvlContainer::operator[] ( const int  index ) const

inherited

Return the PvlKeyword object at the specified index.

Parameters

index

The index to use.

Returns

The PvlKeyword at the specified index.

Exceptions

iException::Message

The index is out of bounds.

Definition at line 203 of file PvlContainer.cpp.

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

PvlKeyword Isis::PvlContainer::operator[] ( const char *  name ) const

inlineinherited

When you use the [] operator with a (char) name, it will call the findKeyword() method.

Parameters

name	The name of the keyword to find.

Definition at line 166 of file PvlContainer.h.

References Isis::PvlContainer::operator[]().

void Isis::PvlContainer::setFileName ( const QString &  filename )

inlineprotectedinherited

Sets the filename to the specified string.

Parameters

filename

The new filename to use.

Definition at line 316 of file PvlContainer.h.

References Isis::PvlContainer::m_filename.

void Isis::PvlContainer::setName ( const QString &  name )

inlineinherited

Set the name of the container.

Definition at line 71 of file PvlContainer.h.

References Isis::PvlContainer::m_name, and Isis::PvlKeyword::setValue().

Referenced by Isis::MosaicController::convertV1ToV2(), and Isis::operator>>().

QString Isis::PvlContainer::type ( ) const

inlineinherited

Returns the container type.

Returns

The container type.

Definition at line 94 of file PvlContainer.h.

References Isis::PvlContainer::m_name, and Isis::PvlKeyword::name().

Referenced by deleteGroup(), deleteObject(), and Isis::operator<<().

void Isis::PvlContainer::validateAllKeywords ( PvlContainer &  pPvlCont )

protectedinherited

Validate All the Keywords in a Container comparing with the Template.

Validate all the PvlKeywords in this container.

Author

Sharmila Prasad (9/24/2010)

Parameters

pPvlCont

- Container to be Validated

History:

2010-10-18 Sharmila Prasad - Added options "Type", "Range", "Value" for the keyword validation

Definition at line 410 of file PvlContainer.cpp.

References _FILEINFO_, Isis::PvlContainer::deleteKeyword(), Isis::PvlContainer::findKeyword(), Isis::PvlContainer::hasKeyword(), Isis::PvlKeyword::name(), and Isis::PvlKeyword::validateKeyword().

Referenced by Isis::PvlGroup::validateGroup(), validateObject(), and Isis::Pvl::validatePvl().

void Isis::PvlObject::validateObject

(

PvlObject &

pPvlObj

)

Validate Object.

Validate a PvlObject, comparing against corresponding Template PvlObject.

If the Objects are nested, it will recursively validate the PvlObject.

Template PvlObject has the format: Object = (objectName, optional/required)

Author

Sharmila Prasad (9/22/2010)

Parameters

pvlObj-

PvlObject to be validated

Definition at line 812 of file PvlObject.cpp.

References _FILEINFO_, deleteGroup(), deleteObject(), findGroup(), Isis::PvlContainer::findKeyword(), findKeyword(), findObject(), group(), groups(), hasGroup(), Isis::PvlContainer::hasKeyword(), hasKeyword(), hasObject(), Isis::PvlContainer::keywords(), Isis::PvlContainer::name(), object(), objects(), Isis::IException::User, Isis::PvlContainer::validateAllKeywords(), Isis::PvlGroup::validateGroup(), and validateObject().

Referenced by validateObject(), and Isis::Pvl::validatePvl().

void Isis::PvlContainer::validateRepeatOption ( PvlKeyword &  pPvlTmplKwrd, PvlContainer &  pPvlCont  )

protectedinherited

Validate the Repeat Option for a Keyword.

Validate Repeat Option in the Template Group.

This option indicates that a particular keyname can be repeated several times

Author

Sharmila Prasad (9/24/2010)

Parameters

pPvlTmplKwrd	- Template Keyword wit
pPvlCont	- Container with all the Keywords

History:

2010-10-18 Sharmila Prasad - Added option "Type" for the keyword validation

Definition at line 486 of file PvlContainer.cpp.

References Isis::PvlContainer::deleteKeyword(), Isis::PvlContainer::keywords(), Isis::PvlKeyword::name(), and Isis::PvlKeyword::validateKeyword().

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, Isis::PvlObject &  object  )

friend

Outputs the PvlObject data to a specified output stream.

Parameters

os	The output stream to write to.
object	The PvlObject to send to the output stream.

Definition at line 494 of file PvlObject.cpp.

std::istream& operator>> ( std::istream &  is, PvlObject &  result  )

friend

This method reads a PvlObject from the input stream.

Definition at line 676 of file PvlObject.cpp.

Member Data Documentation

QString Isis::PvlContainer::m_filename

protectedinherited

               This contains the filename

used to initialize the pvl object.

If the object was not initialized using a filename the string is empty.

Definition at line 298 of file PvlContainer.h.

Referenced by deleteGroup(), deleteObject(), Isis::PvlContainer::fileName(), findGroup(), findKeyword(), findObject(), Isis::Pvl::init(), Isis::PvlContainer::operator=(), Isis::Pvl::read(), and Isis::PvlContainer::setFileName().

QList<PvlGroup> Isis::PvlObject::m_groups

private

A vector of PvlGroups contained in the current PvlObject.

Definition at line 364 of file PvlObject.h.

Referenced by addGroup(), beginGroup(), clear(), deleteGroup(), endGroup(), group(), groups(), operator=(), and PvlObject().

QList<PvlKeyword> Isis::PvlContainer::m_keywords

protectedinherited

This is the vector of PvlKeywords the container is holding.

Definition at line 305 of file PvlContainer.h.

Referenced by Isis::PvlContainer::begin(), Isis::PvlContainer::clear(), Isis::PvlContainer::end(), Isis::PvlContainer::keywords(), and Isis::PvlContainer::operator=().

PvlKeyword Isis::PvlContainer::m_name

protectedinherited

This is the name keyword.

Definition at line 304 of file PvlContainer.h.

Referenced by Isis::PvlContainer::isNamed(), Isis::PvlContainer::name(), Isis::PvlContainer::operator=(), Isis::PvlContainer::setName(), and Isis::PvlContainer::type().

QList<PvlObject> Isis::PvlObject::m_objects

private

A vector of PvlObjects contained in the current PvlObject.

Definition at line 362 of file PvlObject.h.

Referenced by addObject(), beginObject(), clear(), deleteObject(), endObject(), object(), objects(), operator=(), and PvlObject().

---

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

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