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

#include <PvlContainer.h>

Inheritance diagram for Isis::PvlContainer:

Collaboration diagram for Isis::PvlContainer:

Public Types
enum	InsertMode { Append, Replace }
	Contains both modes: Append or Replace. More...

typedef QList< PvlKeyword >::iterator	PvlKeywordIterator
	The keyword iterator. More...

typedef QList< PvlKeyword >::const_iterator	ConstPvlKeywordIterator
	The const keyword iterator. More...

Public Member Functions
	PvlContainer (const QString &type)
	Constructs a PvlContainer object with a type. More...

	PvlContainer (const QString &type, const QString &name)
	Constructs a PvlContainer object with a keyword name and a container name. More...

	PvlContainer (const PvlContainer &other)

void	setName (const QString &name)
	Set the name of the container. More...

QString	name () const
	Returns the container name. More...

bool	isNamed (const QString &match) const
	Returns whether the given string is equal to the container name or not. More...

QString	type () const
	Returns the container type. More...

int	keywords () const
	Returns the number of keywords contained in the PvlContainer. More...

void	clear ()
	Clears PvlKeywords. More...

void	addKeyword (const PvlKeyword &keyword, const InsertMode mode=Append)
	Add a keyword to the container. More...

void	operator+= (const PvlKeyword &keyword)
	When you use the += operator with a PvlKeyword, it will call the addKeyword() method. More...

PvlKeyword &	findKeyword (const QString &name)
	Find a keyword with a specified name. More...

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

PvlKeyword &	operator[] (const int index)
	Return the PvlKeyword object at the specified index. More...

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

const PvlKeyword &	findKeyword (const QString &name) const
	Find a keyword with a specified name. More...

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

const PvlKeyword &	operator[] (const int index) const
	Return the PvlKeyword object at the specified index. More...

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

bool	hasKeyword (const QString &name) const
	Check to see if a keyword exists. More...

PvlKeywordIterator	findKeyword (const QString &name, PvlKeywordIterator beg, PvlKeywordIterator end)
	Find the index of a keyword, using iterators. More...

ConstPvlKeywordIterator	findKeyword (const QString &name, ConstPvlKeywordIterator beg, ConstPvlKeywordIterator end) const
	Find the index of a keyword, using iterators. More...

PvlKeywordIterator	addKeyword (const PvlKeyword &keyword, PvlKeywordIterator pos)
	Insert a keyword at the specified iterator position. More...

PvlKeywordIterator	begin ()
	Return the beginning iterator. More...

ConstPvlKeywordIterator	begin () const
	Return the const beginning iterator. More...

PvlKeywordIterator	end ()
	Return the ending iterator. More...

ConstPvlKeywordIterator	end () const
	Return the const ending iterator. More...

void	deleteKeyword (const QString &name)
	Remove a specified keyword. More...

void	deleteKeyword (const int index)
	Remove the specified keyword. More...

bool	cleanDuplicateKeywords ()
	Removes keywords from the container that have BOTH the same name and value. More...

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

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

QString	fileName () const
	Returns the filename used to initialise the Pvl object. More...

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

const PvlContainer &	operator= (const PvlContainer &other)
	This is an assignment operator. More...

Protected Member Functions
void	init ()
	Sets the filename to blank. More...

void	setFileName (const QString &filename)
	Sets the filename to the specified string. More...

void	validateAllKeywords (PvlContainer &pPvlCont)
	Validate All the Keywords in a Container comparing with the Template. More...

void	validateRepeatOption (PvlKeyword &pPvlTmplKwrd, PvlContainer &pPvlCont)
	Validate the Repeat Option for a Keyword. More...

Protected Attributes
QString	m_filename
	This contains the filename used to initialize the pvl object. More...

PvlKeyword	m_name
	This is the name keyword. More...

QList< PvlKeyword >	m_keywords
	This is the vector of PvlKeywords the container is holding. More...

PvlContainer *	m_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

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

History:: 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.

History:: 2015-05-15 J Bonn - fixed usage of iterator that had been deleted.

Definition at line 49 of file PvlContainer.h.

Member Typedef Documentation

◆ ConstPvlKeywordIterator

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

The const keyword iterator.

Definition at line 160 of file PvlContainer.h.

◆ PvlKeywordIterator

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

The keyword iterator.

Definition at line 157 of file PvlContainer.h.

Member Enumeration Documentation

◆ InsertMode

enum Isis::PvlContainer::InsertMode

Contains both modes: Append or Replace.

Definition at line 95 of file PvlContainer.h.

Constructor & Destructor Documentation

◆ PvlContainer() [1/2]

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

Constructs a PvlContainer object with a type.

Parameters

type	The type of the container.

Definition at line 26 of file PvlContainer.cpp.

◆ PvlContainer() [2/2]

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 37 of file PvlContainer.cpp.

Member Function Documentation

◆ addKeyword() [1/2]

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 202 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::CameraFactory::Create(), Isis::ShapeModelFactory::create(), Isis::ProjectionFactory::CreateForCube(), Isis::ControlNetDiff::diff(), Isis::ProcessImportFits::extractFitsLabels(), Isis::ExportPdsTable::fillMetaData(), Isis::Application::GetEnviromentInfo(), Isis::CameraPointInfo::GetPointInfo(), Isis::Application::GetUnameInfo(), Isis::PvlObject::operator+=(), Isis::operator<<(), Isis::operator>>(), Isis::GridPolygonSeeder::PluginParameters(), Isis::LimitPolygonSeeder::PluginParameters(), Isis::PolygonSeeder::PluginParameters(), Isis::StripPolygonSeeder::PluginParameters(), Isis::PvlObject::PvlObject(), Isis::Target::radiiGroup(), Isis::ProjectionFactory::RingsCreateForCube(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::Projection::SetUpperLeftCorner(), Isis::ProcessMosaic::StartProcess(), Isis::SubArea::UpdateLabel(), Isis::CubeTileHandler::updateLabels(), Isis::CubeBsqHandler::updateLabels(), and Isis::ControlNetVersioner::write().

◆ addKeyword() [2/2]

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 233 of file PvlContainer.cpp.

◆ begin() [1/2]

PvlKeywordIterator Isis::PvlContainer::begin ( )

inline

Return the beginning iterator.

Returns: The beginning iterator.

Definition at line 178 of file PvlContainer.h.

References m_keywords.

Referenced by Isis::PvlToPvlTranslationManager::DoTranslation(), Isis::PvlObject::findKeyword(), Isis::PvlObject::hasKeyword(), Isis::PvlTranslationTable::InputGroup(), Isis::DbProfile::loadkeys(), Isis::PvlFlatMap::loadKeywords(), Isis::pvlContainerToJSON(), Isis::PvlTranslationTable::Translate(), and Isis::XmlToPvlTranslationManager::Translate().

◆ begin() [2/2]

ConstPvlKeywordIterator Isis::PvlContainer::begin ( ) const

inline

Return the const beginning iterator.

Returns: The const beginning iterator.

Definition at line 186 of file PvlContainer.h.

References m_keywords.

◆ cleanDuplicateKeywords()

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 136 of file PvlContainer.cpp.

◆ clear()

void Isis::PvlContainer::clear ( )

inline

Clears PvlKeywords.

Definition at line 91 of file PvlContainer.h.

References m_keywords.

Referenced by Isis::Cube::applyVirtualBandsToLabel(), and Isis::PvlObject::clear().

◆ deleteKeyword() [1/2]

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 115 of file PvlContainer.cpp.

◆ deleteKeyword() [2/2]

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 97 of file PvlContainer.cpp.

Referenced by IsisAml::CommandLine(), Isis::ControlPointV0001::ControlPointV0001(), Isis::ControlPointV0002::ControlPointV0002(), Isis::ControlPointV0003::ControlPointV0003(), Isis::MosaicController::convertV1ToV2(), Isis::ControlPointV0001::copy(), Isis::ControlPointV0002::copy(), Isis::ControlPointV0003::copy(), Isis::ObliqueCylindrical::ObliqueCylindrical(), operator-=(), Isis::GridPolygonSeeder::Parse(), Isis::LimitPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::StripPolygonSeeder::Parse(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::ProcessExportPds::StandardImageImage(), Isis::ProcessExportPds::StandardJP2Image(), Isis::SubArea::UpdateLabel(), Isis::TiffImporter::upperLeftXY(), validateAllKeywords(), and validateRepeatOption().

◆ end() [1/2]

PvlKeywordIterator Isis::PvlContainer::end ( )

inline

Return the ending iterator.

Returns: The ending iterator.

Definition at line 194 of file PvlContainer.h.

References m_keywords.

Referenced by Isis::PvlToPvlTranslationManager::DoTranslation(), Isis::PvlObject::findGroup(), Isis::PvlObject::findKeyword(), Isis::PvlObject::findObject(), Isis::PvlObject::hasKeyword(), Isis::PvlTranslationTable::InputGroup(), Isis::DbProfile::loadkeys(), Isis::PvlFlatMap::loadKeywords(), Isis::pvlContainerToJSON(), Isis::PvlTranslationTable::Translate(), and Isis::XmlToPvlTranslationManager::Translate().

◆ end() [2/2]

ConstPvlKeywordIterator Isis::PvlContainer::end ( ) const

inline

Return the const ending iterator.

Returns: The const ending iterator.

Definition at line 202 of file PvlContainer.h.

References m_keywords.

◆ fileName()

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

References m_filename.

Referenced by Isis::PvlObject::addObject(), Isis::ClipperNacRollingShutterCamera::ClipperNacRollingShutterCamera(), Isis::ClipperPushBroomCamera::ClipperPushBroomCamera(), Isis::ObservationNumber::Compose(), Isis::SerialNumber::Compose(), Isis::ProjectionFactory::CreateForCube(), Isis::ProjectionFactory::CreateFromCube(), Isis::DawnVirCamera::DawnVirCamera(), Isis::PvlTranslationTable::findTranslationGroup(), Isis::HrscCamera::HrscCamera(), Isis::Spice::init(), Isis::PvlToPvlTranslationManager::InputKeyword(), Isis::PvlToXmlTranslationManager::InputKeyword(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::InterestOperator::Parse(), Isis::AutoReg::Parse(), Isis::GridPolygonSeeder::Parse(), Isis::LimitPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::StripPolygonSeeder::Parse(), Isis::PvlEditDialog::PvlEditDialog(), Isis::ProjectionFactory::RingsCreateForCube(), Isis::ProjectionFactory::RingsCreateFromCube(), Isis::RosettaVirtisCamera::RosettaVirtisCamera(), Isis::PvlTranslationTable::Translate(), Isis::ControlPointEditWidget::viewTemplateFile(), Isis::MatchTool::viewTemplateFile(), Isis::QnetTool::viewTemplateFile(), and Isis::StereoTool::viewTemplateFile().

◆ findKeyword() [1/4]

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 62 of file PvlContainer.cpp.

Referenced by IsisAml::CheckFileNamePreference(), Isis::ClipperNacRollingShutterCamera::ClipperNacRollingShutterCamera(), Isis::ControlNetDiff::compare(), Isis::ControlNetDiff::compareGroups(), Isis::CubeIoHandler::CubeIoHandler(), Isis::PvlToPvlTranslationManager::DoTranslation(), Isis::PvlToXmlTranslationManager::doTranslation(), Isis::SpectralPlotWindow::drawBandMarkers(), Isis::ProcessImportFits::extractFitsLabels(), Isis::CubeViewport::getBandFilterName(), Isis::CameraPointInfo::GetPointInfo(), Isis::SpectralPlotTool::getSpectralStatistics(), Isis::PvlTranslationTable::InputGroup(), Isis::PvlToPvlTranslationManager::InputKeyword(), Isis::PvlToXmlTranslationManager::InputKeyword(), Isis::JunoCamera::JunoCamera(), Isis::Stretch::Load(), Isis::ProcessMosaic::MatchDEMShapeModel(), operator[](), Isis::Target::radiiGroup(), Isis::ReseauDistortionMap::ReseauDistortionMap(), Isis::MosaicSceneWidget::setProjection(), Isis::CubeViewport::setTrackingCube(), Isis::ProcessExportPds4::StandardAllMapping(), Isis::ProcessExportPds::StandardAllMapping(), Isis::PvlTranslationTable::Translate(), Isis::XmlToPvlTranslationManager::Translate(), validateAllKeywords(), Isis::PvlObject::validateObject(), and Isis::Pvl::validatePvl().

◆ findKeyword() [2/4]

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 80 of file PvlContainer.cpp.

◆ findKeyword() [3/4]

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 366 of file PvlContainer.cpp.

◆ findKeyword() [4/4]

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 351 of file PvlContainer.cpp.

◆ hasKeyword()

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 159 of file PvlContainer.cpp.

Referenced by Isis::Latitude::add(), Isis::SerialNumberList::add(), Isis::ProjectionConfigDialog::addMissingKeywords(), Isis::PvlTranslationTable::AddTable(), Isis::Albedo::Albedo(), Isis::AlbedoAtm::AlbedoAtm(), Isis::AtmosModel::AtmosModel(), Isis::BulletShapeModel::BulletShapeModel(), Isis::Camera::Camera(), Isis::CameraFactory::CameraVersion(), Isis::ClipperNacRollingShutterCamera::ClipperNacRollingShutterCamera(), IsisAml::CommandLine(), Isis::ControlNetDiff::compareGroups(), Isis::ControlPointV0001::ControlPointV0001(), Isis::ControlPointV0002::ControlPointV0002(), Isis::ControlPointV0003::ControlPointV0003(), Isis::ControlPointV0001::copy(), Isis::ControlPointV0002::copy(), Isis::ControlPointV0003::copy(), Isis::CameraFactory::Create(), Isis::PhotoModelFactory::Create(), Isis::AtmosModelFactory::Create(), Isis::NormModelFactory::Create(), Isis::ShapeModelFactory::create(), Isis::ProcessExportPds4::createUnitMap(), Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Isis::DemShape::DemShape(), Isis::PvlToPvlTranslationManager::DoTranslation(), Isis::PvlToXmlTranslationManager::doTranslation(), Isis::SpectralPlotWindow::drawBandMarkers(), Isis::EmbreeShapeModel::EmbreeShapeModel(), 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::PvlTranslationTable::hasInputDefault(), Isis::Spice::hasKernels(), Isis::HiLab::HiLab(), Isis::IdealCamera::IdealCamera(), Isis::Equalization::importStatistics(), Isis::Spice::init(), Isis::Image::initCamStats(), Isis::Shape::initCamStats(), Isis::DatabaseFactory::initPreferences(), Isis::PvlTranslationTable::InputDefault(), Isis::PvlToPvlTranslationManager::InputHasKeyword(), Isis::PvlToXmlTranslationManager::InputHasKeyword(), Isis::PvlToPvlTranslationManager::InputKeyword(), Isis::PvlToXmlTranslationManager::InputKeyword(), Isis::PvlTranslationTable::InputKeywordName(), Isis::PvlTranslationTable::IsAuto(), Isis::PvlTranslationTable::IsOptional(), Isis::LambertConformal::LambertConformal(), 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::Mollweide::Mollweide(), Isis::NaifDskShape::NaifDskShape(), Isis::ObliqueCylindrical::ObliqueCylindrical(), Isis::operator<<(), Isis::Orthographic::Orthographic(), Isis::OsirisRexOcamsCamera::OsirisRexOcamsCamera(), Isis::PvlTranslationTable::OutputName(), Isis::PvlTranslationTable::OutputPosition(), Isis::AutoReg::Parse(), Isis::GridPolygonSeeder::Parse(), Isis::LimitPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::StripPolygonSeeder::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::Target::radiiGroup(), Isis::MocLabels::ReadLabels(), Isis::ControlNetVersioner::readProtobuf(), Isis::ControlNetVersioner::readProtobufV0005(), Isis::AutoReg::RegTemplate(), Isis::RingCylindrical::RingCylindrical(), Isis::RingPlaneProjection::RingPlaneProjection(), Isis::Camera::ringRange(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::Robinson::Robinson(), Isis::ProcessImportFits::setFitsFile(), Isis::FileName::Data::setOriginal(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::ProcessImportFits::setProcessFileStructure(), Isis::ControlNet::SetTarget(), Isis::SimpleCylindrical::SimpleCylindrical(), Isis::Sinusoidal::Sinusoidal(), Isis::ProcessExportPds::StandardAllMapping(), Isis::ProcessImportFits::standardInstrumentGroup(), Isis::Target::Target(), Isis::ThemisIrCamera::ThemisIrCamera(), Isis::IException::toString(), Isis::TProjection::TProjection(), Isis::PvlTranslationTable::Translate(), Isis::PvlToPvlTranslationManager::Translate(), Isis::XmlToPvlTranslationManager::Translate(), Isis::PvlToXmlTranslationManager::Translate(), Isis::ProcessExportPds4::translateBandBinSpectrumBinSet(), Isis::ProcessExportPds4::translateBandBinSpectrumUniform(), Isis::ProcessImportPds::TranslateIsis2Instrument(), Isis::TransverseMercator::TransverseMercator(), Isis::SubArea::UpdateLabel(), Isis::SpectralPlotTool::updateTool(), Isis::TiffImporter::upperLeftXY(), 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(), and Isis::ControlNetValidMeasure::ValidatePvlShiftTolerances().

◆ init()

void Isis::PvlContainer::init ( )

protected

Sets the filename to blank.

Definition at line 51 of file PvlContainer.cpp.

◆ isNamed()

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

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

Referenced by Isis::Cube::copy(), Isis::FileTool::copyCubeDetails(), Isis::Blob::Find(), Isis::KernelDb::findAll(), Isis::Cube::hasBlob(), Isis::IsBlob(), Isis::Image::isFootprintable(), Isis::Shape::isFootprintable(), Isis::UserInterface::loadHistory(), Isis::KernelDb::loadKernelDbFiles(), Isis::RemoveHiBlobs(), Isis::Process::SetOutputCube(), Isis::Gui::UpdateHistory(), and Isis::Process::WriteHistory().

◆ keywords()

int Isis::PvlContainer::keywords ( ) const

inline

Returns the number of keywords contained in the PvlContainer.

Returns: The number of keywords.

Definition at line 86 of file PvlContainer.h.

References m_keywords.

Referenced by Isis::ProcessMosaic::AddBandBinGroup(), Isis::PvlTranslationTable::AddTable(), Isis::ControlNetDiff::addTolerances(), Isis::Cube::applyVirtualBandsToLabel(), Isis::ControlNetDiff::compare(), Isis::ControlNetDiff::compareGroups(), Isis::ControlPointV0001::ControlPointV0001(), Isis::ControlPointV0002::ControlPointV0002(), Isis::ControlPointV0003::ControlPointV0003(), Isis::MosaicController::convertV1ToV2(), Isis::KernelDb::files(), Isis::ImageFileListWidget::find(), Isis::KernelDb::findAll(), Isis::ObservationNumber::FindObservationTranslation(), Isis::SerialNumber::FindSerialTranslation(), Isis::MosaicSceneWidget::fromPvl(), Isis::CameraPointInfo::GetPointInfo(), Isis::ImageImporter::import(), Isis::Equalization::importStatistics(), 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(), Isis::PvlGroup::validateGroup(), Isis::PvlObject::validateObject(), Isis::Pvl::validatePvl(), and validateRepeatOption().

◆ name()

QString Isis::PvlContainer::name ( ) const

inline

Returns the container name.

Returns: The container name.

Definition at line 63 of file PvlContainer.h.

References m_name.

Referenced by Isis::PvlTranslationTable::AddTable(), Isis::ControlNetDiff::addTolerances(), Isis::LabelTranslationManager::Auto(), Isis::PvlToPvlTranslationManager::Auto(), Isis::PvlToXmlTranslationManager::Auto(), Isis::ControlPointV0003::ControlPointV0003(), Isis::Cube::copy(), Isis::FileTool::copyCubeDetails(), Isis::CorrelationMatrix::CorrelationMatrix(), Isis::ProcessExportPds4::createUnitMap(), Isis::Cube::deleteBlob(), Isis::PvlObject::deleteGroup(), Isis::PvlObject::deleteObject(), Isis::PvlToXmlTranslationManager::doTranslation(), Isis::KernelDb::files(), Isis::PvlObject::findGroup(), Isis::PvlObject::findObject(), Isis::ImageFileListWidget::fromPvl(), Isis::PvlObject::hasGroup(), Isis::PvlObject::hasObject(), Isis::Image::initCamStats(), Isis::Shape::initCamStats(), Isis::PvlFlatMap::loadGroup(), Isis::UserInterface::loadHistory(), Isis::ImportPdsTable::loadLabel(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::JigsawRunWidget::on_JigsawAcceptButton_clicked(), operator-=(), Isis::operator<<(), Isis::PvlGroup::operator==(), Isis::PvlObject::operator==(), Isis::operator>>(), operator[](), Isis::Cube::putGroup(), Isis::BandTool::setBandBin(), Isis::BandSpinBox::setBandBin(), setName(), Isis::Process::SetOutputCube(), Isis::OverlapStatistics::toPvl(), Isis::Gui::UpdateHistory(), Isis::PvlGroup::validateGroup(), Isis::PvlObject::validateObject(), Isis::Pvl::validatePvl(), and Isis::Blob::Write().

◆ operator+=()

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

◆ operator-=() [1/2]

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

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

◆ operator-=() [2/2]

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

References deleteKeyword(), and name().

◆ operator=()

const PvlContainer & Isis::PvlContainer::operator= ( const PvlContainer & other )

This is an assignment operator.

Definition at line 375 of file PvlContainer.cpp.

References m_filename, m_keywords, and m_name.

Referenced by Isis::PvlGroup::operator=(), and Isis::PvlObject::operator=().

◆ operator[]() [1/6]

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

References name(), and operator[]().

◆ operator[]() [2/6]

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

References name(), and operator[]().

◆ operator[]() [3/6]

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 172 of file PvlContainer.cpp.

◆ operator[]() [4/6]

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 187 of file PvlContainer.cpp.

◆ operator[]() [5/6]

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

References findKeyword(), and name().

Referenced by operator[]().

◆ operator[]() [6/6]

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

References findKeyword(), and name().

◆ setFileName()

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

inlineprotected

Sets the filename to the specified string.

Parameters

filename The new filename to use.

Definition at line 301 of file PvlContainer.h.

References m_filename.

◆ setName()

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

inline

Set the name of the container.

Definition at line 56 of file PvlContainer.h.

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

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

◆ type()

QString Isis::PvlContainer::type ( ) const

inline

Returns the container type.

Returns: The container type.

Definition at line 79 of file PvlContainer.h.

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

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

◆ validateAllKeywords()

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 394 of file PvlContainer.cpp.

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

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

◆ validateRepeatOption()

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 470 of file PvlContainer.cpp.

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

Member Data Documentation

◆ m_filename

QString Isis::PvlContainer::m_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 283 of file PvlContainer.h.

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

◆ m_keywords

QList<PvlKeyword> Isis::PvlContainer::m_keywords

protected

This is the vector of PvlKeywords the container is holding.

Definition at line 290 of file PvlContainer.h.

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

◆ m_name

PvlKeyword Isis::PvlContainer::m_name

protected

This is the name keyword.

Definition at line 289 of file PvlContainer.h.

Referenced by isNamed(), name(), operator=(), 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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ ConstPvlKeywordIterator

◆ PvlKeywordIterator

Member Enumeration Documentation

◆ InsertMode

Constructor & Destructor Documentation

◆ PvlContainer() [1/2]

◆ PvlContainer() [2/2]

Member Function Documentation

◆ addKeyword() [1/2]

◆ addKeyword() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ cleanDuplicateKeywords()

◆ clear()

◆ deleteKeyword() [1/2]

◆ deleteKeyword() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ fileName()

◆ findKeyword() [1/4]

◆ findKeyword() [2/4]

◆ findKeyword() [3/4]

◆ findKeyword() [4/4]

◆ hasKeyword()

◆ init()

◆ isNamed()

◆ keywords()

◆ name()

◆ operator+=()

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator=()

◆ operator[]() [1/6]

◆ operator[]() [2/6]

◆ operator[]() [3/6]

◆ operator[]() [4/6]

◆ operator[]() [5/6]

◆ operator[]() [6/6]

◆ setFileName()

◆ setName()

◆ type()

◆ validateAllKeywords()

◆ validateRepeatOption()

Member Data Documentation

◆ m_filename

◆ m_keywords

◆ m_name