Isis::PvlContainer Class Reference
[Parsing]

Contains more than one keyword-value pair. More...

#include <PvlContainer.h>

Inheritance diagram for Isis::PvlContainer:

[legend]

Collaboration diagram for Isis::PvlContainer:

[legend]

List of all members.

Public Types
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
	PvlContainer (const QString &type)
	Constructs a PvlContainer object with a type.
	PvlContainer (const QString &type, const QString &name)
	Constructs a PvlContainer object with a keyword name and a container name.
	PvlContainer (const PvlContainer &other)
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	Clear ()
	Clears PvlKeywords.
void	AddKeyword (const PvlKeyword &keyword, const InsertMode mode=Append)
	Add a keyword to the container.
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.
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 &	FindKeyword (const QString &name) const
	Find a keyword with a specified name.
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	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.
PvlKeywordIterator	AddKeyword (const PvlKeyword &keyword, PvlKeywordIterator pos)
	Insert a keyword at the specified iterator position.
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 *	GetFormat ()
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 &	GetNameKeyword ()
const PvlKeyword &	GetNameKeyword () const
const PvlContainer &	operator= (const PvlContainer &other)
	This is an assignment operator.
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	p_filename
	This contains the filename used to initialize the pvl object.
PvlKeyword	p_name
	This is the name keyword.
QList< PvlKeyword >	p_keywords
	This is the vector of PvlKeywords the container is holding.
PvlContainer *	p_formatTemplate

---

Detailed Description

Contains more than one keyword-value pair.

This is the container for PvlKeywords. It holds information about more than one set of PvlKeywords.

Author:

2002-10-11 Jeff Anderson

For internal use only.

History:

2005-04-04 Leah Dahmer wrote class documentation.

History:

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

History:

2006-05-17 Jacob Danton Added DeleteKeyword by index method

History:

2006-09-11 Stuart Sides Added formatting ability

History:

2008-07-02 Steven Lambright Added const functionality

History:

2008-07-10 Steven Lambright PvlContainer is no longer a PvlKeyword, but rather has a set of pvl keywords

History:

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

History:

2008-10-30 Steven Lambright Moved Find methods' implementations to the cpp file from the header file, added <algorithm> include, problem pointed out by "novas0x2a" (Support Forum Member)

History:

2009-06-01 Kris Becker - Added a new AddKeyword method that provides insert capabilities at iterator positions.

History:

2010-01-06 Christopher Austin - Added CleanDuplicateKeywords()

History:

2010-04-13 Eric Hyer - Added Copy constructor

• Added Assignment operator

History:

2010-09-27 Sharmila Prasad - Validate all the Keywords in a Container and verify the 'Repeat' Option also

History:

2010-10-18 Sharmila Prasad - Added more options for the keyword validation

Todo:

2005-04-04 Need coded example.

Definition at line 63 of file PvlContainer.h.

---

Member Typedef Documentation

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

The const keyword iterator.

Definition at line 174 of file PvlContainer.h.

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

The keyword iterator.

Definition at line 171 of file PvlContainer.h.

---

Member Enumeration Documentation

enum Isis::PvlContainer::InsertMode

Contains both modes: Append or Replace.

Definition at line 109 of file PvlContainer.h.

---

Constructor & Destructor Documentation

Isis::PvlContainer::PvlContainer

(

const QString &

type

)

Constructs a PvlContainer object with a type.

Parameters:

type

The type of the container.

Definition at line 42 of file PvlContainer.cpp.

References Init(), p_name, and Isis::PvlKeyword::SetName().

Isis::PvlContainer::PvlContainer	(	const QString &	type,
		const QString &	name
	)

Constructs a PvlContainer object with a keyword name and a container name.

Parameters:

	type	The type of container.
	name	The name of the container.

Definition at line 53 of file PvlContainer.cpp.

References Init(), p_name, SetName(), and Isis::PvlKeyword::SetName().

---

Member Function Documentation

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

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.

References p_keywords.

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

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 FindKeyword(), HasKeyword(), Isis::PvlKeyword::Name(), and p_keywords.

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::ExportPdsTable::fillMetaData(), Isis::Application::GetEnviromentInfo(), Isis::CameraPointInfo::GetPointInfo(), Isis::Application::GetUnameInfo(), operator+=(), Isis::operator<<(), Isis::operator>>(), Isis::StripPolygonSeeder::PluginParameters(), Isis::PolygonSeeder::PluginParameters(), Isis::LimitPolygonSeeder::PluginParameters(), Isis::GridPolygonSeeder::PluginParameters(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::Projection::SetUpperLeftCorner(), Isis::SubArea::UpdateLabel(), Isis::CubeTileHandler::updateLabels(), Isis::CubeBsqHandler::updateLabels(), and Isis::ControlNetFileV0002::Write().

ConstPvlKeywordIterator Isis::PvlContainer::Begin

(

)

const [inline]

Return the const beginning iterator.

Returns:

The const beginning iterator.

Definition at line 200 of file PvlContainer.h.

References p_keywords.

PvlKeywordIterator Isis::PvlContainer::Begin

(

)

[inline]

Return the beginning iterator.

Returns:

The beginning iterator.

Definition at line 192 of file PvlContainer.h.

References p_keywords.

Referenced by CleanDuplicateKeywords(), DeleteKeyword(), Isis::PvlObject::FindKeyword(), FindKeyword(), Isis::PvlObject::HasKeyword(), HasKeyword(), Isis::PvlTranslationTable::InputGroup(), Isis::DbProfile::loadkeys(), and Isis::PvlTranslationTable::Translate().

bool Isis::PvlContainer::CleanDuplicateKeywords

(

)

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.

References Begin(), End(), and p_keywords.

void Isis::PvlContainer::Clear

(

)

[inline]

Clears PvlKeywords.

Reimplemented in Isis::PvlObject.

Definition at line 105 of file PvlContainer.h.

References p_keywords.

void Isis::PvlContainer::DeleteKeyword

(

const int

index

)

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_, Begin(), Name(), p_filename, p_keywords, Type(), and Isis::IException::Unknown.

void Isis::PvlContainer::DeleteKeyword

(

const QString &

name

)

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_, Begin(), End(), FindKeyword(), Name(), p_filename, p_keywords, Type(), and Isis::IException::Unknown.

Referenced by IsisAml::CommandLine(), Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::ControlNetVersioner::Copy(), Isis::Blob::Find(), Isis::ControlNetVersioner::LatestPvlToBinary(), Isis::ObliqueCylindrical::ObliqueCylindrical(), operator-=(), Isis::StripPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::LimitPolygonSeeder::Parse(), Isis::GridPolygonSeeder::Parse(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::Projection::TargetRadii(), Isis::SubArea::UpdateLabel(), ValidateAllKeywords(), ValidateRepeatOption(), Isis::Blob::Write(), and Isis::Table::WriteInit().

ConstPvlKeywordIterator Isis::PvlContainer::End

(

)

const [inline]

Return the const ending iterator.

Returns:

The const ending iterator.

Definition at line 216 of file PvlContainer.h.

References p_keywords.

PvlKeywordIterator Isis::PvlContainer::End

(

)

[inline]

Return the ending iterator.

Returns:

The ending iterator.

Definition at line 208 of file PvlContainer.h.

References p_keywords.

Referenced by CleanDuplicateKeywords(), DeleteKeyword(), Isis::PvlObject::FindKeyword(), FindKeyword(), Isis::PvlObject::HasKeyword(), HasKeyword(), Isis::PvlTranslationTable::InputGroup(), Isis::DbProfile::loadkeys(), and Isis::PvlTranslationTable::Translate().

QString Isis::PvlContainer::FileName

(

)

const [inline]

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 246 of file PvlContainer.h.

References p_filename.

Referenced by Isis::PvlObject::AddObject(), Isis::SerialNumber::Compose(), Isis::ObservationNumber::Compose(), Isis::ProjectionFactory::Create(), Isis::ProjectionFactory::CreateForCube(), Isis::ProjectionFactory::CreateFromCube(), Isis::HrscCamera::HrscCamera(), Isis::UniversalGroundMap::Init(), Isis::Spice::init(), Isis::ApolloPanoramicDetectorMap::initializeInteriorOrientation(), Isis::PvlTranslationTable::InputDefault(), Isis::PvlTranslationTable::InputGroup(), Isis::PvlTranslationManager::InputKeyword(), Isis::PvlTranslationTable::InputKeywordName(), Isis::InterestOperator::Parse(), Isis::StripPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::LimitPolygonSeeder::Parse(), Isis::GridPolygonSeeder::Parse(), Isis::AutoReg::Parse(), Isis::PvlEditDialog::PvlEditDialog(), and Isis::PvlTranslationTable::Translate().

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

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.

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

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.

const Isis::PvlKeyword & Isis::PvlContainer::FindKeyword

(

const QString &

name

)

const

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_, Begin(), End(), FindKeyword(), Name(), p_filename, Type(), and Isis::IException::Unknown.

Isis::PvlKeyword & Isis::PvlContainer::FindKeyword

(

const QString &

name

)

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_, Begin(), End(), Name(), p_filename, Type(), and Isis::IException::Unknown.

Referenced by AddKeyword(), Isis::ApolloMetricCamera::ApolloMetricCamera(), IsisAml::CheckFileNamePreference(), Isis::ControlNetDiff::compare(), Isis::ControlNetDiff::compareGroups(), Isis::CubeIoHandler::CubeIoHandler(), DeleteKeyword(), Isis::SpectralPlotWindow::drawBandMarkers(), FindKeyword(), Isis::CubeViewport::getBandFilterName(), Isis::CameraPointInfo::GetPointInfo(), Isis::SpectralPlotTool::getSpectralStatistics(), HasKeyword(), Isis::PvlTranslationTable::InputGroup(), Isis::PvlTranslationManager::InputKeyword(), Isis::Stretch::Load(), Isis::ProcessMosaic::MatchDEMShapeModel(), operator[](), Isis::ReseauDistortionMap::ReseauDistortionMap(), Isis::Projection::TargetRadii(), Isis::PvlTranslationTable::Translate(), ValidateAllKeywords(), Isis::PvlObject::ValidateObject(), Isis::Pvl::ValidatePvl(), and ValidateRepeatOption().

bool Isis::PvlContainer::HasKeyword

(

const QString &

name

)

const

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.

References Begin(), End(), and FindKeyword().

Referenced by Isis::Latitude::add(), AddKeyword(), Isis::ProjectionConfigDialog::addMissingKeywords(), Isis::PvlTranslationTable::AddTable(), Isis::AlbedoAtm::AlbedoAtm(), Isis::AtmosModel::AtmosModel(), Isis::Camera::Camera(), Isis::CameraFactory::CameraVersion(), IsisAml::CommandLine(), Isis::ControlNetDiff::compareGroups(), Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::ControlNetVersioner::Copy(), Isis::PhotoModelFactory::Create(), Isis::NormModelFactory::Create(), Isis::CameraFactory::Create(), Isis::AtmosModelFactory::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::KernelDb::findAll(), Isis::Kernels::findKernels(), Isis::FeatureNomenclatureTool::findMissingNomenclature(), Isis::CubeViewport::getBandFilterName(), Isis::Kernels::getCameraVersion(), Isis::SpectralPlotTool::getSpectralStatistics(), Isis::GroundGrid::GroundGrid(), 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::Projection::Mapping(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::ProcessMosaic::MatchDEMShapeModel(), Isis::KernelDb::matches(), Isis::Mercator::Mercator(), Isis::ObliqueCylindrical::ObliqueCylindrical(), Isis::Orthographic::Orthographic(), Isis::StripPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::LimitPolygonSeeder::Parse(), Isis::GridPolygonSeeder::Parse(), Isis::AutoReg::Parse(), Isis::PhotoModel::PhotoModel(), 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::Robinson::Robinson(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::SimpleCylindrical::SimpleCylindrical(), Isis::Sinusoidal::Sinusoidal(), Isis::Target::Target(), Isis::Projection::TargetRadii(), Isis::ThemisIrCamera::ThemisIrCamera(), Isis::ControlNetFileV0002::ToPvl(), Isis::IException::toString(), Isis::PvlTranslationTable::Translate(), Isis::PvlTranslationManager::Translate(), Isis::ProcessImportPds::TranslateIsis2Instrument(), Isis::TransverseMercator::TransverseMercator(), Isis::SubArea::UpdateLabel(), Isis::SpectralPlotTool::updateTool(), ValidateAllKeywords(), Isis::PvlObject::ValidateObject(), Isis::Pvl::ValidatePvl(), Isis::ControlNetValidMeasure::ValidatePvlDN(), Isis::ControlNetValidMeasure::ValidatePvlEmissionAngle(), Isis::ControlNetValidMeasure::ValidatePvlFromEdge(), Isis::ControlNetValidMeasure::ValidatePvlIncidenceAngle(), Isis::ControlNetValidMeasure::ValidatePvlResidualTolerances(), Isis::ControlNetValidMeasure::ValidatePvlResolution(), Isis::ControlNetValidMeasure::ValidatePvlShiftTolerances(), and ValidateRepeatOption().

void Isis::PvlContainer::Init

(

)

[protected]

Sets the filename to blank.

Reimplemented in Isis::Pvl.

Definition at line 67 of file PvlContainer.cpp.

References p_filename.

Referenced by PvlContainer().

bool Isis::PvlContainer::IsNamed

(

const QString &

match

)

const [inline]

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 86 of file PvlContainer.h.

References p_name, and Isis::PvlKeyword::StringEqual().

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

int Isis::PvlContainer::Keywords

(

)

const [inline]

Returns the number of keywords contained in the PvlContainer.

Returns:

The number of keywords.

Definition at line 100 of file PvlContainer.h.

References p_keywords.

Referenced by Isis::ProcessMosaic::AddBandBinGroup(), Isis::PvlTranslationTable::AddTable(), Isis::ControlNetDiff::addTolerances(), Isis::ControlNetDiff::compare(), Isis::ControlNetDiff::compareGroups(), Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::KernelDb::files(), Isis::KernelDb::findAll(), Isis::ObservationNumber::FindObservationTranslation(), Isis::SerialNumber::FindSerialTranslation(), Isis::MosaicSceneWidget::fromPvl(), Isis::CameraPointInfo::GetPointInfo(), Isis::ControlNetVersioner::LatestPvlToBinary(), Isis::UserInterface::LoadHistory(), Isis::KernelDb::loadKernelDbFiles(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::KernelDb::matches(), Isis::operator<<(), Isis::ControlNetFilter::PointCubeNamesFilter(), Isis::BandTool::setBandBin(), Isis::BandSpinBox::setBandBin(), Isis::BandTool::setList(), Isis::AdvancedTrackTool::TrackMosaicOrigin(), Isis::Gui::UpdateHistory(), ValidateAllKeywords(), Isis::PvlGroup::ValidateGroup(), Isis::PvlObject::ValidateObject(), Isis::Pvl::ValidatePvl(), and ValidateRepeatOption().

QString Isis::PvlContainer::Name

(

)

const [inline]

Returns the container name.

Returns:

The container name.

Definition at line 77 of file PvlContainer.h.

References p_name.

Referenced by Isis::PvlTranslationTable::AddTable(), Isis::ControlNetDiff::addTolerances(), Isis::FileTool::copyCubeDetails(), Isis::Cube::deleteBlob(), Isis::PvlObject::DeleteGroup(), DeleteKeyword(), Isis::PvlObject::DeleteObject(), Isis::KernelDb::files(), FindKeyword(), Isis::ControlNetVersioner::LatestPvlToBinary(), Isis::UserInterface::LoadHistory(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::operator<<(), Isis::PvlObject::operator==(), Isis::PvlGroup::operator==(), Isis::operator>>(), Isis::Cube::putGroup(), Isis::BandTool::setBandBin(), Isis::BandSpinBox::setBandBin(), Isis::Process::SetOutputCube(), Isis::Gui::UpdateHistory(), Isis::PvlGroup::ValidateGroup(), Isis::PvlObject::ValidateObject(), Isis::Pvl::ValidatePvl(), and Isis::Blob::Write().

void Isis::PvlContainer::operator+=

(

const PvlKeyword &

keyword

)

[inline]

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

Parameters:

keyword

The PvlKeyword to be added.

Definition at line 124 of file PvlContainer.h.

References AddKeyword().

void Isis::PvlContainer::operator-=

(

const PvlKeyword &

key

)

[inline]

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 238 of file PvlContainer.h.

References DeleteKeyword(), and Isis::PvlKeyword::Name().

void Isis::PvlContainer::operator-=

(

const QString &

name

)

[inline]

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 230 of file PvlContainer.h.

References DeleteKeyword().

const PvlContainer & Isis::PvlContainer::operator=

(

const PvlContainer &

other

)

This is an assignment operator.

Reimplemented in Isis::Preference, Isis::Pvl, Isis::PvlGroup, and Isis::PvlObject.

Definition at line 391 of file PvlContainer.cpp.

References p_filename, p_keywords, and p_name.

PvlKeyword Isis::PvlContainer::operator[]

(

const char *

name

)

const [inline]

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 165 of file PvlContainer.h.

References operator[]().

const Isis::PvlKeyword & Isis::PvlContainer::operator[]

(

const int

index

)

const

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_, Isis::Message::ArraySubscriptNotInRange(), p_keywords, and Isis::IException::Programmer.

const PvlKeyword& Isis::PvlContainer::operator[]

(

const QString &

name

)

const [inline]

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 155 of file PvlContainer.h.

References FindKeyword().

PvlKeyword& Isis::PvlContainer::operator[]

(

const char *

name

)

[inline]

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 144 of file PvlContainer.h.

References operator[]().

PvlKeyword & Isis::PvlContainer::operator[]

(

const int

index

)

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_, Isis::Message::ArraySubscriptNotInRange(), p_keywords, and Isis::IException::Programmer.

PvlKeyword& Isis::PvlContainer::operator[]

(

const QString &

name

)

[inline]

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 134 of file PvlContainer.h.

References FindKeyword().

Referenced by operator[]().

void Isis::PvlContainer::SetFileName

(

const QString &

filename

)

[inline, protected]

Sets the filename to the specified string.

Parameters:

filename

The new filename to use.

Definition at line 315 of file PvlContainer.h.

References p_filename.

void Isis::PvlContainer::SetName

(

const QString &

name

)

[inline]

Set the name of the container.

Definition at line 70 of file PvlContainer.h.

References p_name, and Isis::PvlKeyword::SetValue().

Referenced by Isis::Blob::Blob(), Isis::operator>>(), and PvlContainer().

QString Isis::PvlContainer::Type

(

)

const [inline]

Returns the container type.

Returns:

The container type.

Definition at line 93 of file PvlContainer.h.

References Isis::PvlKeyword::Name(), and p_name.

Referenced by Isis::PvlObject::DeleteGroup(), DeleteKeyword(), Isis::PvlObject::DeleteObject(), and FindKeyword().

void Isis::PvlContainer::ValidateAllKeywords

(

PvlContainer &

pPvlCont

)

[protected]

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_, DeleteKeyword(), FindKeyword(), HasKeyword(), Keywords(), Isis::PvlKeyword::Name(), Isis::IException::User, Isis::PvlKeyword::ValidateKeyword(), and ValidateRepeatOption().

Referenced by Isis::PvlGroup::ValidateGroup(), Isis::PvlObject::ValidateObject(), and Isis::Pvl::ValidatePvl().

void Isis::PvlContainer::ValidateRepeatOption	(	PvlKeyword &	pPvlTmplKwrd,
		PvlContainer &	pPvlCont
	)			[protected]

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 DeleteKeyword(), FindKeyword(), HasKeyword(), Keywords(), Isis::PvlKeyword::Name(), and Isis::PvlKeyword::ValidateKeyword().

Referenced by ValidateAllKeywords().

---

Member Data Documentation

QString Isis::PvlContainer::p_filename [protected]

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 297 of file PvlContainer.h.

Referenced by Isis::PvlObject::DeleteGroup(), DeleteKeyword(), Isis::PvlObject::DeleteObject(), FileName(), Isis::PvlObject::FindGroup(), Isis::PvlObject::FindKeyword(), FindKeyword(), Isis::PvlObject::FindObject(), Init(), Isis::Pvl::Init(), operator=(), Isis::Pvl::Read(), and SetFileName().

QList<PvlKeyword> Isis::PvlContainer::p_keywords [protected]

This is the vector of PvlKeywords the container is holding.

Definition at line 304 of file PvlContainer.h.

Referenced by AddKeyword(), Begin(), CleanDuplicateKeywords(), Clear(), DeleteKeyword(), End(), Keywords(), operator=(), and operator[]().

PvlKeyword Isis::PvlContainer::p_name [protected]

This is the name keyword.

Definition at line 303 of file PvlContainer.h.

Referenced by IsNamed(), Name(), operator=(), PvlContainer(), SetName(), and Type().

---

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

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