Isis 3 Programmer Reference
Isis::Preference Class Reference

Reads user preferences from a data file. More...

#include <Preference.h>

Inheritance diagram for Isis::Preference:
Inheritance graph
Collaboration diagram for Isis::Preference:
Collaboration graph

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. More...
 
typedef QList< Isis::PvlGroup >::const_iterator ConstPvlGroupIterator
 
typedef QList< PvlObject >::iterator PvlObjectIterator
 The counter for objects. More...
 
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. More...
 
typedef QList< PvlKeyword >::const_iterator ConstPvlKeywordIterator
 The const keyword iterator. More...
 

Public Member Functions

void Load (const QString &file)
 
bool IsUnitTest ()
 Tests whether or not a file is a unitTest. More...
 
void read (const QString &file)
 Loads PVL information from a stream. More...
 
void write (const QString &file)
 Opens and writes PVL information to a file and handles the end of line sequence. More...
 
void append (const QString &file)
 Appends PVL information to a file and handles the end of line sequence. More...
 
void setTerminator (const QString &term)
 Sets the terminator used to signify the end of the PVL informationDefaults to "END". More...
 
QString terminator () const
 Returns the terminator used to signify the end of the PVL informationDefaults to "END". More...
 
void setFormatTemplate (Isis::Pvl &temp)
 
void setFormatTemplate (const QString &filename)
 
void setFormatTemplate (PvlContainer &ref)
 
void validatePvl (const Pvl &pPvl, Pvl &pPvlResults)
 Validate a Pvl with the Template Pvl. More...
 
int groups () const
 Returns the number of groups contained. More...
 
PvlGroupgroup (const int index)
 Return the group at the specified index. More...
 
const PvlGroupgroup (const int index) const
 Return the group at the specified index. More...
 
PvlGroupIterator beginGroup ()
 Returns the beginning group index. More...
 
ConstPvlGroupIterator beginGroup () const
 Returns the beginning group index. More...
 
PvlGroupIterator endGroup ()
 Returns the ending group index. More...
 
ConstPvlGroupIterator endGroup () const
 Returns the const ending group index. More...
 
PvlGroupIterator findGroup (const QString &name, PvlGroupIterator beg, PvlGroupIterator end)
 Find a group with the specified name, within these indexes. More...
 
ConstPvlGroupIterator findGroup (const QString &name, ConstPvlGroupIterator beg, ConstPvlGroupIterator end) const
 Find a group with the specified name, within these indexes. More...
 
Isis::PvlGroupfindGroup (const QString &name, FindOptions opts=None)
 Finds a group within the current PvlObject. More...
 
const Isis::PvlGroupfindGroup (const QString &name, FindOptions opts=None) const
 Finds a group within the current PvlObject. More...
 
PvlKeywordfindKeyword (const QString &kname, FindOptions opts)
 Finds a keyword in the current PvlObject, or deeper inside other PvlObjects and Pvlgroups within this one. More...
 
PvlKeywordfindKeyword (const QString &name)
 Find a keyword with a specified name. More...
 
const PvlKeywordfindKeyword (const QString &name) const
 Find a keyword with a specified name. 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...
 
PvlKeywordfindKeyword (const QString &name)
 Find a keyword with a specified name. More...
 
const PvlKeywordfindKeyword (const QString &name) const
 Find a keyword with a specified name. 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...
 
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. More...
 
bool hasKeyword (const QString &name) const
 Check to see if a keyword exists. More...
 
bool hasKeyword (const QString &name) const
 Check to see if a keyword exists. More...
 
void addGroup (const Isis::PvlGroup &group)
 Add a group to the object. More...
 
void operator+= (const Isis::PvlGroup &group)
 
void operator+= (const Isis::PvlObject &obj)
 
void operator+= (const PvlKeyword &keyword)
 When you use the += operator with a PvlKeyword, it will call the addKeyword() method. More...
 
void operator+= (const PvlKeyword &keyword)
 When you use the += operator with a PvlKeyword, it will call the addKeyword() method. More...
 
void deleteGroup (const QString &name)
 Remove a group from the current PvlObject. More...
 
void deleteGroup (const int index)
 Remove a group from the current PvlObject. More...
 
bool hasGroup (const QString &name) const
 Returns a boolean value based on whether the object has the specified group or not. More...
 
int objects () const
 Returns the number of objects. More...
 
PvlObjectobject (const int index)
 Return the object at the specified index. More...
 
const PvlObjectobject (const int index) const
 Return the object at the specified index. More...
 
PvlObjectIterator beginObject ()
 Returns the index of the beginning object. More...
 
ConstPvlObjectIterator beginObject () const
 Returns the const index of the beginning object. More...
 
PvlObjectIterator endObject ()
 Returns the index of the ending object. More...
 
ConstPvlObjectIterator endObject () const
 Returns the const index of the ending object. More...
 
PvlObjectIterator findObject (const QString &name, PvlObjectIterator beg, PvlObjectIterator end)
 Find the index of object with a specified name, between two indexes. More...
 
ConstPvlObjectIterator findObject (const QString &name, ConstPvlObjectIterator beg, ConstPvlObjectIterator end) const
 Find the index of object with a specified name, between two indexes. More...
 
PvlObjectfindObject (const QString &name, FindOptions opts=None)
 Find an object within the current PvlObject. More...
 
const PvlObjectfindObject (const QString &name, FindOptions opts=None) const
 Find an object within the current PvlObject. More...
 
void addObject (const PvlObject &object)
 Add a PvlObject. More...
 
void deleteObject (const QString &name)
 Remove an object from the current PvlObject. More...
 
void deleteObject (const int index)
 Remove an object from the current PvlObject. More...
 
bool hasObject (const QString &name) const
 Returns a boolean value based on whether the object exists in the current PvlObject or not. More...
 
bool operator== (const PvlObject &object) const
 Compares two PvlObjects. More...
 
void clear ()
 Remove everything from the current PvlObject. More...
 
void validateObject (PvlObject &pPvlObj)
 Validate Object. More...
 
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 addKeyword (const PvlKeyword &keyword, const InsertMode mode=Append)
 Add a keyword to the container. More...
 
PvlKeywordIterator addKeyword (const PvlKeyword &keyword, PvlKeywordIterator pos)
 Insert a keyword at the specified iterator position. More...
 
PvlKeywordoperator[] (const QString &name)
 When you use the [] operator with a (string) name, it will call the findKeyword() method. More...
 
PvlKeywordoperator[] (const int index)
 Return the PvlKeyword object at the specified index. More...
 
PvlKeywordoperator[] (const char *name)
 When you use the [] operator with a (char) name, it will call the findKeyword() method. More...
 
const PvlKeywordoperator[] (const QString &name) const
 When you use the [] operator with a (string) name, it will call the findKeyword() method. More...
 
const PvlKeywordoperator[] (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...
 
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...
 
bool hasFormatTemplate ()
 
PvlContainerformatTemplate ()
 
PvlFormatformat ()
 
void setFormat (PvlFormat *format)
 
int indent ()
 
void setIndent (int indent)
 
int comments () const
 
QString comment (const int index) const
 
void addComment (const QString &comment)
 
PvlKeywordnameKeyword ()
 
const PvlKeywordnameKeyword () const
 

Static Public Member Functions

static PreferencePreferences (bool unitTest=false)
 

Protected Member Functions

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< PvlKeywordm_keywords
 This is the vector of PvlKeywords the container is holding. More...
 
PvlContainerm_formatTemplate
 

Private Member Functions

 Preference ()
 Constructs a Preference object. More...
 
 ~Preference ()
 Destroys the Preference object. More...
 
 Preference (const Preference &p)
 
Preferenceoperator= (const Preference &p)
 

Static Private Member Functions

static void Shutdown ()
 

Static Private Attributes

static Preferencep_preference = NULL
 Pointer to a Preference object. More...
 
static bool p_unitTest = false
 Flag indicating whether the file is a unitTest or not. More...
 

Detailed Description

Reads user preferences from a data file.

This class is used to load, set, and obtain user preferences for the operation of Isis. User preferences for Isis are items such as the name of the log file, default data directories, and processing status. This is essentially a specialized version of a Label object. It reads a system-wide preference file and overwrites values in the label with a user preference file. This object does not need to be modified to add new prefences ... simply edit the system wide preference file, add the new group and keywords, update the preference document (user documentation) explaining the new keywords.

Author
2002-03-13 Jeff Anderson
Todo:
The Preference class needs private methods & variables documented. The documentation shows methods that don't exist in the code. It also needs an example.
History:

2003-04-23 Jeff Anderson - reworked the class to use the Label object.

2003-05-16 Stuart Sides - Modified schema from astrogeoloy... isis.astrogeology

2003-12-03 Stuart Sides - added HasGroup member.

2005-10-03 Elizabeth Miller - changed

2008-01-09 Steven Lambright - Made Application a friend for destruction purposes

2008-07-08 Steven Lambright - Now uses atexit for destruction

2010-05-28 Steven Lambright - More resilient to $HOME/.Isis problems

2010-07-19 Jeannie Walldren - Added FileCustomization group to TestPreferences file

2012-02-24 Steven Lambright - This class now sets the thread limit in the Qt global thread pool.

2013-03-27 Jeannie Backer - Added Near mission to DataDirectory group to TestPreferences file. References #1248.

2015-05-27 Andrew Stebenne - Backwards Compatibility Issue: Preference now throws an exception when Preference.Load() is called on a nonexistent preference file. This may cause issues for anyone who has been using a nonexistent preference file.

Definition at line 77 of file Preference.h.

Member Typedef Documentation

◆ ConstPvlKeywordIterator

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

The const keyword iterator.

Definition at line 174 of file PvlContainer.h.

◆ PvlGroupIterator

The counter for groups.

Definition at line 95 of file PvlObject.h.

◆ PvlKeywordIterator

The keyword iterator.

Definition at line 171 of file PvlContainer.h.

◆ PvlObjectIterator

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

The counter for objects.

Definition at line 239 of file PvlObject.h.

Member Enumeration Documentation

◆ FindOptions

A collection of options to use when finding.

Enumerator
None 

Search only the current level.

Traverse 

Search child objects.

Definition at line 166 of file PvlObject.h.

◆ InsertMode

Contains both modes: Append or Replace.

Definition at line 109 of file PvlContainer.h.

Constructor & Destructor Documentation

◆ Preference()

Isis::Preference::Preference ( )
private

Constructs a Preference object.

Definition at line 40 of file Preference.cpp.

◆ ~Preference()

Isis::Preference::~Preference ( )
inlineprivate

Destroys the Preference object.

Definition at line 97 of file Preference.h.

Member Function Documentation

◆ addGroup()

◆ addKeyword() [1/2]

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
keywordThe PvlKeyword object to append.
modeUsing the InsertMode value of Append.
keyThe PvlKeyword object to add.
modeThe 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::ShapeModelFactory::create(), 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::Target::radiiGroup(), Isis::ProjectionFactory::RingsCreateForCube(), Isis::ProcessMapMosaic::RingsSetOutputCube(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::Projection::SetUpperLeftCorner(), 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 
)
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
keyKeyword to insert
posIterator 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.

◆ addObject()

◆ append()

void Isis::Pvl::append ( const QString &  file)
inherited

Appends PVL information to a file and handles the end of line sequence.

Parameters
fileName of the file to append to.
Exceptions
Isis::iException::Io

Definition at line 170 of file Pvl.cpp.

References _FILEINFO_, Isis::FileName::expanded(), Isis::Message::FileOpen(), Isis::IException::Io, and Isis::Pvl::terminator().

◆ begin() [1/2]

◆ begin() [2/2]

ConstPvlKeywordIterator Isis::PvlContainer::begin ( ) const
inlineinherited

Return the const beginning iterator.

Returns
The const beginning iterator.

Definition at line 200 of file PvlContainer.h.

References Isis::PvlContainer::m_keywords.

◆ beginGroup() [1/2]

PvlGroupIterator Isis::PvlObject::beginGroup ( )
inlineinherited

Returns the beginning group index.

Returns
The iterator of the beginning group..

Definition at line 103 of file PvlObject.h.

References Isis::PvlObject::m_groups.

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

◆ beginGroup() [2/2]

ConstPvlGroupIterator Isis::PvlObject::beginGroup ( ) const
inlineinherited

Returns the beginning group index.

Returns
The iterator of the beginning group..

Definition at line 112 of file PvlObject.h.

References Isis::PvlObject::m_groups.

◆ beginObject() [1/2]

PvlObjectIterator Isis::PvlObject::beginObject ( )
inlineinherited

Returns the index of the beginning object.

Returns
The beginning object's index.

Definition at line 247 of file PvlObject.h.

References Isis::PvlObject::m_objects.

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

◆ beginObject() [2/2]

ConstPvlObjectIterator Isis::PvlObject::beginObject ( ) const
inlineinherited

Returns the const index of the beginning object.

Returns
The beginning object's index.

Definition at line 256 of file PvlObject.h.

References Isis::PvlObject::m_objects.

◆ cleanDuplicateKeywords()

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.

◆ clear()

void Isis::PvlObject::clear ( )
inlineinherited

◆ deleteGroup() [1/2]

◆ deleteGroup() [2/2]

void Isis::PvlObject::deleteGroup ( const int  index)
inherited

Remove a group from the current PvlObject.

Parameters
indexThe index of the PvlGroup to remove.
Exceptions
IException

Definition at line 399 of file PvlObject.cpp.

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

◆ deleteKeyword() [1/2]

◆ deleteKeyword() [2/2]

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

Remove the specified keyword.

Parameters
indexThe index of the keyword to remove.
Exceptions
iException::PvlKeyword doesn't exist.

Definition at line 131 of file PvlContainer.cpp.

References _FILEINFO_.

◆ deleteObject() [1/2]

◆ deleteObject() [2/2]

void Isis::PvlObject::deleteObject ( const int  index)
inherited

Remove an object from the current PvlObject.

Parameters
indexThe index of the PvlObject to remove.
Exceptions
IException

Definition at line 357 of file PvlObject.cpp.

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

◆ end() [1/2]

◆ end() [2/2]

ConstPvlKeywordIterator Isis::PvlContainer::end ( ) const
inlineinherited

Return the const ending iterator.

Returns
The const ending iterator.

Definition at line 216 of file PvlContainer.h.

References Isis::PvlContainer::m_keywords.

◆ endGroup() [1/2]

PvlGroupIterator Isis::PvlObject::endGroup ( )
inlineinherited

Returns the ending group index.

Returns
The iterator of the ending group.

Definition at line 121 of file PvlObject.h.

References Isis::PvlObject::m_groups.

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

◆ endGroup() [2/2]

ConstPvlGroupIterator Isis::PvlObject::endGroup ( ) const
inlineinherited

Returns the const ending group index.

Returns
The iterator of the ending group.

Definition at line 130 of file PvlObject.h.

References Isis::PvlObject::m_groups.

◆ endObject() [1/2]

PvlObjectIterator Isis::PvlObject::endObject ( )
inlineinherited

Returns the index of the ending object.

Returns
The ending object's index.

Definition at line 265 of file PvlObject.h.

References Isis::PvlObject::m_objects.

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

◆ endObject() [2/2]

ConstPvlObjectIterator Isis::PvlObject::endObject ( ) const
inlineinherited

Returns the const index of the ending object.

Returns
The ending object's index.

Definition at line 274 of file PvlObject.h.

References Isis::PvlObject::m_objects.

◆ fileName()

◆ findGroup() [1/4]

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

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

Parameters
nameThe name of the group to look for.
begThe lower index
endThe higher index

Definition at line 141 of file PvlObject.h.

References Isis::PvlContainer::end(), and Isis::PvlContainer::name().

Referenced by Isis::SerialNumberList::add(), Isis::ProcessMosaic::AddBandBinGroup(), Isis::ProjectionConfigDialog::addMissingKeywords(), Isis::ControlNetDiff::addTolerances(), Isis::AlphaCube::AlphaCube(), Isis::ApolloMetricCamera::ApolloMetricCamera(), Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::Cube::applyVirtualBandsToLabel(), Isis::BulletShapeModel::BulletShapeModel(), Isis::Camera::Camera(), Isis::CameraFactory::CameraVersion(), Isis::Chandrayaan1M3Camera::Chandrayaan1M3Camera(), IsisAml::CheckFileNamePreference(), Isis::MdisCamera::computeFocalLength(), Isis::TiffImporter::convertProjection(), Isis::CorrelationMatrix::CorrelationMatrix(), Isis::InterestOperatorFactory::Create(), Isis::ShapeModelFactory::create(), Isis::PolygonSeederFactory::Create(), Isis::CameraFactory::Create(), Isis::AutoRegFactory::Create(), Isis::ProjectionFactory::Create(), Isis::LabelTranslationManager::CreateContainer(), Isis::ProjectionFactory::CreateForCube(), Isis::ProjectionFactory::CreateFromCube(), Isis::CrismCamera::CrismCamera(), Isis::CTXCamera::CTXCamera(), Isis::CubeIoHandler::CubeIoHandler(), Isis::DawnFcCamera::DawnFcCamera(), Isis::DawnVirCamera::DawnVirCamera(), Isis::PvlObject::deleteGroup(), Isis::DemShape::DemShape(), Isis::PvlToPvlTranslationManager::DoTranslation(), Isis::EmbreeShapeModel::EmbreeShapeModel(), Isis::Equirectangular::Equirectangular(), Isis::UserInterface::evaluateOption(), Isis::KernelDb::findAll(), Isis::Kernels::findKernels(), Isis::ObservationNumber::FindObservationTranslation(), Isis::SerialNumber::FindSerialTranslation(), Isis::MultivariateStatistics::fromPvl(), Isis::MosaicSceneWidget::fromPvl(), Isis::Equalization::fromPvl(), Isis::OverlapStatistics::fromPvl(), Isis::TiffImporter::gdalItems(), Isis::CubeViewport::getBandFilterName(), Isis::ProcessMosaic::GetBandIndex(), Isis::Kernels::getCameraVersion(), Isis::PvlToXmlTranslationManager::GetContainer(), Isis::PvlToPvlTranslationManager::GetContainer(), Isis::Plugin::GetPlugin(), Isis::GroundGrid::GroundGrid(), Isis::Camera::GroundRange(), Isis::Cube::group(), Isis::PvlObject::hasGroup(), Isis::Spice::hasKernels(), Isis::HayabusaAmicaCamera::HayabusaAmicaCamera(), Isis::HayabusaNirsCamera::HayabusaNirsCamera(), Isis::HiresCamera::HiresCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::HrscCamera::HrscCamera(), Isis::Hyb2OncCamera::Hyb2OncCamera(), Isis::IdealCamera::IdealCamera(), Isis::ImportImagesWorkOrder::importConfirmedImages(), Isis::Equalization::importStatistics(), Isis::VimsSkyMap::Init(), Isis::VimsGroundMap::Init(), Isis::Gruen::init(), Isis::Spice::init(), Isis::Shape::initCamStats(), Isis::Image::initCamStats(), Isis::Cube::initCoreFromLabel(), Isis::DatabaseFactory::initPreferences(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::JunoCamera::JunoCamera(), Isis::KaguyaMiCamera::KaguyaMiCamera(), Isis::KaguyaTcCamera::KaguyaTcCamera(), 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::Mollweide::Mollweide(), 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::OsirisRexOcamsCamera::OsirisRexOcamsCamera(), Isis::LimitPolygonSeeder::Parse(), Isis::GridPolygonSeeder::Parse(), Isis::StripPolygonSeeder::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::Target::radiiGroup(), Isis::MocLabels::ReadLabels(), Isis::CissLabels::ReadLabels(), Isis::ControlNetVersioner::readProtobuf(), Isis::ControlNetVersioner::readProtobufV0005(), 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::RosettaOsirisCamera::RosettaOsirisCamera(), Isis::RosettaVirtisCamera::RosettaVirtisCamera(), Isis::UserInterface::SaveHistory(), Isis::ProcessMosaic::SetInputCube(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::ProcessGroundPolygons::SetStatCubes(), Isis::ControlNet::SetTarget(), Isis::SimpleCylindrical::SimpleCylindrical(), Isis::Sinusoidal::Sinusoidal(), Isis::Spice::Spice(), Isis::SsiCamera::SsiCamera(), Isis::ProcessExportPds4::StandardAllMapping(), Isis::ProcessExportPds::StandardAllMapping(), Isis::Target::Target(), Isis::Pipeline::TemporaryFolder(), Isis::TgoCassisCamera::TgoCassisCamera(), Isis::ThemisIrCamera::ThemisIrCamera(), Isis::ThemisVisCamera::ThemisVisCamera(), Isis::AdvancedTrackTool::TrackMosaicOrigin(), Isis::XmlToPvlTranslationManager::Translate(), Isis::ProcessImportPds::TranslateIsis2BandBin(), Isis::ProcessImportPds::TranslateIsis2Instrument(), Isis::ProcessImportPds::TranslatePdsProjection(), Isis::TransverseMercator::TransverseMercator(), Isis::AlphaCube::UpdateGroup(), Isis::Gui::UpdateHistory(), Isis::TiffImporter::upperLeftXY(), Isis::UvvisCamera::UvvisCamera(), Isis::PvlObject::validateObject(), Isis::Pvl::validatePvl(), Isis::VikingCamera::VikingCamera(), Isis::VimsCamera::VimsCamera(), and Isis::VoyagerCamera::VoyagerCamera().

◆ findGroup() [2/4]

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

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

Parameters
nameThe name of the group to look for.
begThe lower index
endThe higher index

Definition at line 155 of file PvlObject.h.

References Isis::PvlContainer::end(), and Isis::PvlContainer::name().

◆ findGroup() [3/4]

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

Finds a group within the current PvlObject.

Parameters
nameThe name of the group to look for.
optsThe FindOptions option (None or Traverse).
Returns
The PvlGroup object sought for.
Exceptions
IException

Definition at line 72 of file PvlObject.cpp.

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

◆ findGroup() [4/4]

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

Finds a group within the current PvlObject.

Parameters
nameThe name of the group to look for.
optsThe FindOptions option (None or Traverse).
Returns
The PvlGroup object sought for.
Exceptions
IException

Definition at line 107 of file PvlObject.cpp.

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

◆ findKeyword() [1/9]

◆ findKeyword() [2/9]

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

Find a keyword with a specified name.

Parameters
nameThe name of the keyword to look for.
Returns
The PvlKeyword object.
Exceptions
IExceptionThe keyword doesn't exist.

Definition at line 96 of file PvlContainer.cpp.

References _FILEINFO_.

◆ findKeyword() [3/9]

Isis::PvlKeyword & Isis::PvlContainer::findKeyword
inherited

Find a keyword with a specified name.

Parameters
nameThe name of the keyword to look for.
Returns
The PvlKeyword object.
Exceptions
iException::PvlThe keyword doesn't exist.

Definition at line 78 of file PvlContainer.cpp.

◆ findKeyword() [4/9]

PvlContainer::PvlKeywordIterator Isis::PvlContainer::findKeyword
inherited

Find the index of a keyword, using iterators.

Parameters
nameThe name of the keyword.
begThe beginning iterator.
endThe ending iterator.
Returns
The keyword index.

Definition at line 367 of file PvlContainer.cpp.

◆ findKeyword() [5/9]

const Isis::PvlKeyword & Isis::PvlContainer::findKeyword
inherited

Find a keyword with a specified name.

Parameters
nameThe name of the keyword to look for.
Returns
The PvlKeyword object.
Exceptions
IExceptionThe keyword doesn't exist.

Definition at line 96 of file PvlContainer.cpp.

◆ findKeyword() [6/9]

PvlContainer::ConstPvlKeywordIterator Isis::PvlContainer::findKeyword
inherited

Find the index of a keyword, using iterators.

Parameters
nameThe name of the keyword.
begThe beginning iterator.
endThe ending iterator.
Returns
The keyword index.

Definition at line 382 of file PvlContainer.cpp.

◆ findKeyword() [7/9]

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

Find the index of a keyword, using iterators.

Parameters
nameThe name of the keyword.
begThe beginning iterator.
endThe ending iterator.
Returns
The keyword index.

Definition at line 367 of file PvlContainer.cpp.

◆ findKeyword() [8/9]

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

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
knameThe name of the keyword to look for.
optsThe 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(), Isis::PvlObject::group(), Isis::PvlContainer::m_filename, Isis::PvlObject::None, and Isis::IException::Unknown.

Referenced by Isis::ControlNetDiff::compare(), Isis::CorrelationMatrix::CorrelationMatrix(), Isis::CubeIoHandler::CubeIoHandler(), Isis::Cube::deleteBlob(), Isis::SpicePosition::LoadCache(), Isis::ImportPdsTable::loadLabel(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::ProcessImportPds::ProcessLabel(), Isis::Target::radiiGroup(), Isis::ControlNetVersioner::readPvlV0001(), Isis::ControlNetVersioner::readPvlV0002(), Isis::ControlNetVersioner::readPvlV0003(), Isis::ControlNetVersioner::readPvlV0004(), Isis::ControlNetVersioner::readPvlV0005(), Isis::SsiCamera::SsiCamera(), Isis::ProcessExportPds::StandardAllMapping(), Isis::PvlObject::validateObject(), and Isis::Pvl::validatePvl().

◆ findKeyword() [9/9]

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
nameThe name of the keyword.
begThe beginning iterator.
endThe ending iterator.
Returns
The keyword index.

Definition at line 382 of file PvlContainer.cpp.

◆ findObject() [1/4]

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

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

Parameters
nameThe name of the object to find.
begThe lower index.
endThe higher index.
Returns
The index of the object.

Definition at line 286 of file PvlObject.h.

References Isis::PvlContainer::end(), and Isis::PvlContainer::name().

Referenced by Isis::SerialNumberList::add(), Isis::ProcessMosaic::AddBandBinGroup(), Isis::ProcessMosaic::AddDefaultBandBinGroup(), Isis::Albedo::Albedo(), Isis::AlbedoAtm::AlbedoAtm(), Isis::PhotometricFunction::algorithmName(), Isis::AlphaCube::AlphaCube(), Isis::Cube::applyVirtualBandsToLabel(), Isis::AtmosModel::AtmosModel(), Isis::AutoReg::AutoReg(), Isis::Camera::Camera(), Isis::ControlNetDiff::compare(), Isis::MosaicController::convertV1ToV2(), Isis::Cube::copy(), Isis::FileTool::copyCubeDetails(), Isis::AtmosModelFactory::Create(), Isis::PhotoModelFactory::Create(), Isis::NormModelFactory::Create(), Isis::LabelTranslationManager::CreateContainer(), Isis::ProcessExportPds::CreateQubeLabel(), Isis::ProcessExportPds::CreateSpectralQubeLabel(), Isis::CubeIoHandler::CubeIoHandler(), Isis::CubeTileHandler::CubeTileHandler(), Isis::Cube::deleteGroup(), Isis::PvlObject::deleteObject(), Isis::SpectralPlotWindow::drawBandMarkers(), Isis::Cube::externalCubeFileName(), Isis::ProcessExportPds4::fileAreaObservational(), Isis::KernelDb::findAll(), Isis::Shape::fromPvl(), Isis::Image::fromPvl(), Isis::MosaicSceneWidget::fromPvl(), Isis::Equalization::fromPvl(), Isis::OverlapStatistics::fromPvl(), Isis::CubeViewport::getBandFilterName(), Isis::PvlToXmlTranslationManager::GetContainer(), Isis::PvlToPvlTranslationManager::GetContainer(), Isis::ProcessImportPds::GetProjectionOffsetMults(), Isis::SpectralPlotTool::getSpectralStatistics(), Isis::Cube::group(), Isis::Cube::hasGroup(), Isis::PvlObject::hasObject(), Isis::ImageImporter::import(), Isis::Equalization::importStatistics(), Isis::Spice::init(), Isis::Cube::initCoreFromLabel(), Isis::DbAccess::load(), Isis::ImportPdsTable::loadLabel(), Isis::Target::lookupNaifBodyCode(), Isis::ProcessMosaic::MatchDEMShapeModel(), Isis::KernelDb::matches(), Isis::Cube::open(), Isis::AutoReg::Parse(), Isis::PhotoModel::PhotoModel(), Isis::ProcessImportPds::ProcessLabel(), Isis::Process::PropagateLabels(), Isis::Cube::putGroup(), Isis::Target::radiiGroup(), Isis::ControlNetVersioner::readProtobuf(), Isis::ControlNetVersioner::readProtobufV0001(), Isis::ControlNetVersioner::readProtobufV0002(), Isis::ControlNetVersioner::readProtobufV0005(), Isis::ControlNetVersioner::readPvl(), Isis::Cube::realDataFileLabel(), Isis::Cube::realDataFileName(), Isis::BandSpinBox::setBandBin(), Isis::BandTool::setBandBin(), Isis::BandTool::setList(), Isis::Process::SetOutputCube(), Isis::ProcessMosaic::SetOutputCube(), Isis::ControlNet::SetTarget(), Isis::ProcessExportPds4::StandardAllMapping(), Isis::ProcessExportPds::StandardAllMapping(), Isis::ProcessExportPds4::standardBandBin(), Isis::ProcessExportPds::StandardImageImage(), Isis::ProcessExportPds4::standardInstrument(), Isis::ProcessExportPds::StandardJP2Image(), Isis::ProcessMosaic::StartProcess(), Isis::ControlNetVersioner::toPvl(), Isis::AdvancedTrackTool::TrackMosaicOrigin(), Isis::ProcessExportPds4::translateBandBinSpectrumBinSet(), Isis::ProcessExportPds4::translateBandBinSpectrumUniform(), Isis::AlphaCube::UpdateGroup(), Isis::SubArea::UpdateLabel(), Isis::CubeTileHandler::updateLabels(), Isis::CubeBsqHandler::updateLabels(), Isis::SpectralPlotTool::updateTool(), Isis::Equalization::validateInputStatistics(), Isis::PvlObject::validateObject(), Isis::Pvl::validatePvl(), and Isis::Blob::Write().

◆ findObject() [2/4]

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

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

Parameters
nameThe name of the object to find.
begThe lower index.
endThe higher index.
Returns
The index of the object.

Definition at line 301 of file PvlObject.h.

References Isis::PvlContainer::end(), and Isis::PvlContainer::name().

◆ findObject() [3/4]

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

Find an object within the current PvlObject.

Parameters
nameThe object name to look for.
optsThe FindOptions option (None or Traverse).
Returns
The PvlObject sought for.
Exceptions
IException

Definition at line 261 of file PvlObject.cpp.

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

◆ findObject() [4/4]

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

Find an object within the current PvlObject.

Parameters
nameThe object name to look for.
optsThe FindOptions option (None or Traverse).
Returns
The PvlObject sought for.
Exceptions
IException

Definition at line 296 of file PvlObject.cpp.

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

◆ group() [1/2]

◆ group() [2/2]

const Isis::PvlGroup & Isis::PvlObject::group ( const int  index) const
inherited

Return the group at the specified index.

Parameters
indexThe index of the group.
Returns
The PvlGroup sought for.
Exceptions
IException

Definition at line 442 of file PvlObject.cpp.

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

◆ groups()

◆ hasGroup()

◆ hasKeyword() [1/3]

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

Check to see if a keyword exists.

Parameters
nameThe 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::SerialNumberList::add(), Isis::Latitude::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(), IsisAml::CommandLine(), Isis::ControlNetDiff::compareGroups(), Isis::ControlPointV0001::copy(), Isis::ControlPointV0002::copy(), Isis::ControlPointV0003::copy(), Isis::ShapeModelFactory::create(), Isis::AtmosModelFactory::Create(), Isis::CameraFactory::Create(), Isis::PhotoModelFactory::Create(), Isis::NormModelFactory::Create(), Isis::ProcessExportPds4::createUnitMap(), Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Isis::DemShape::DemShape(), Isis::PvlToXmlTranslationManager::doTranslation(), Isis::PvlToPvlTranslationManager::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::Shape::initCamStats(), Isis::Image::initCamStats(), Isis::DatabaseFactory::initPreferences(), Isis::PvlTranslationTable::InputDefault(), Isis::PvlToXmlTranslationManager::InputHasKeyword(), Isis::PvlToPvlTranslationManager::InputHasKeyword(), Isis::PvlToXmlTranslationManager::InputKeyword(), Isis::PvlToPvlTranslationManager::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::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::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::PvlToXmlTranslationManager::Translate(), Isis::PvlToPvlTranslationManager::Translate(), Isis::PvlTranslationTable::Translate(), Isis::XmlToPvlTranslationManager::Translate(), Isis::ProcessExportPds4::translateBandBinSpectrumBinSet(), Isis::ProcessExportPds4::translateBandBinSpectrumUniform(), Isis::ProcessImportPds::TranslateIsis2Instrument(), Isis::TransverseMercator::TransverseMercator(), Isis::SubArea::UpdateLabel(), Isis::SpectralPlotTool::updateTool(), Isis::TiffImporter::upperLeftXY(), Isis::PvlContainer::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().

◆ hasKeyword() [2/3]

bool Isis::PvlContainer::hasKeyword
inherited

Check to see if a keyword exists.

Parameters
nameThe 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.

◆ hasKeyword() [3/3]

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

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
knameThe name of the keyword to look for.
optsThe 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(), Isis::PvlObject::group(), and Isis::PvlObject::None.

Referenced by Isis::ControlPointV0001::ControlPointV0001(), Isis::ControlPointV0002::ControlPointV0002(), Isis::ControlPointV0003::ControlPointV0003(), Isis::CubeTileHandler::CubeTileHandler(), Isis::ImageFileListWidget::fromPvl(), Isis::Shape::fromPvl(), Isis::MosaicGridTool::fromPvl(), Isis::Image::fromPvl(), Isis::ImportPdsTable::getColumnDescription(), Isis::Cube::hasTable(), Isis::Cube::initCoreFromLabel(), Isis::Shape::isFootprintable(), Isis::Image::isFootprintable(), Isis::SpicePosition::LoadCache(), Isis::SpiceRotation::LoadCache(), Isis::ImportPdsTable::loadLabel(), Isis::SpiceRotation::loadPCFromTable(), Isis::Cube::open(), Isis::operator<<(), Isis::Target::radiiGroup(), Isis::Table::ReadInit(), Isis::ControlNetVersioner::readPvl(), Isis::Cube::realDataFileLabel(), Isis::ProcessExportPds::StandardAllMapping(), Isis::ProcessExportPds::StandardImageImage(), Isis::ProcessExportPds::StandardJP2Image(), Isis::PvlObject::validateObject(), Isis::Pvl::validatePvl(), and Isis::Table::WriteInit().

◆ hasObject()

◆ isNamed()

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

◆ IsUnitTest()

bool Isis::Preference::IsUnitTest ( )
inline

Tests whether or not a file is a unitTest.

Returns
bool True if it is a unitTest, and false if it is not

Definition at line 87 of file Preference.h.

References p_unitTest.

◆ keywords()

◆ name()

QString Isis::PvlContainer::name ( ) const
inlineinherited

Returns the container name.

Returns
The container name.

Definition at line 77 of file PvlContainer.h.

References Isis::PvlContainer::m_name.

Referenced by Isis::PvlTranslationTable::AddTable(), Isis::ControlNetDiff::addTolerances(), Isis::LabelTranslationManager::Auto(), Isis::PvlToXmlTranslationManager::Auto(), Isis::PvlToPvlTranslationManager::Auto(), 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::Shape::initCamStats(), Isis::Image::initCamStats(), Isis::PvlFlatMap::loadGroup(), Isis::UserInterface::loadHistory(), Isis::ImportPdsTable::loadLabel(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::JigsawRunWidget::on_JigsawAcceptButton_clicked(), Isis::PvlContainer::operator-=(), Isis::operator<<(), Isis::PvlGroup::operator==(), Isis::PvlObject::operator==(), Isis::operator>>(), Isis::PvlContainer::operator[](), Isis::Cube::putGroup(), Isis::BandSpinBox::setBandBin(), Isis::BandTool::setBandBin(), Isis::PvlContainer::setName(), Isis::Process::SetOutputCube(), Isis::OverlapStatistics::toPvl(), Isis::Gui::UpdateHistory(), Isis::PvlGroup::validateGroup(), Isis::PvlObject::validateObject(), Isis::Pvl::validatePvl(), and Isis::Blob::Write().

◆ object() [1/2]

◆ object() [2/2]

const PvlObject & Isis::PvlObject::object ( const int  index) const
inherited

Return the object at the specified index.

Parameters
indexThe 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(), Isis::PvlObject::m_objects, and Isis::IException::Programmer.

◆ objects()

◆ operator+=() [1/2]

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

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

Parameters
keywordThe PvlKeyword to be added.

Definition at line 124 of file PvlContainer.h.

References Isis::PvlContainer::addKeyword().

◆ operator+=() [2/2]

void Isis::PvlContainer::operator+=
inlineinherited

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

Parameters
keywordThe PvlKeyword to be added.

Definition at line 124 of file PvlContainer.h.

◆ operator-=() [1/2]

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

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

Parameters
nameThe name of the keyword to remove.

Definition at line 230 of file PvlContainer.h.

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

◆ operator-=() [2/2]

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

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

Parameters
keyThe PvlKeyword object to remove.

Definition at line 238 of file PvlContainer.h.

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

◆ operator==()

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

Compares two PvlObjects.

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

Parameters
objectThe PvlObject to compare.
Returns
True if they are equal, false if not.

Definition at line 347 of file PvlObject.h.

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

◆ operator[]() [1/6]

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

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

Parameters
nameThe name of the keyword to find.

Definition at line 134 of file PvlContainer.h.

References Isis::PvlContainer::findKeyword(), and Isis::PvlContainer::name().

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

◆ operator[]() [2/6]

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

Return the PvlKeyword object at the specified index.

Parameters
indexThe index to use.
Returns
The PvlKeyword at the specified index.
Exceptions
iException::MessageThe index is out of bounds.

Definition at line 188 of file PvlContainer.cpp.

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

◆ operator[]() [3/6]

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

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

Parameters
nameThe name of the keyword to find.

Definition at line 144 of file PvlContainer.h.

References Isis::PvlContainer::name(), and Isis::PvlContainer::operator[]().

◆ operator[]() [4/6]

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
nameThe name of the keyword to find.

Definition at line 155 of file PvlContainer.h.

References Isis::PvlContainer::findKeyword(), and Isis::PvlContainer::name().

◆ operator[]() [5/6]

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

Return the PvlKeyword object at the specified index.

Parameters
indexThe index to use.
Returns
The PvlKeyword at the specified index.
Exceptions
iException::MessageThe index is out of bounds.

Definition at line 203 of file PvlContainer.cpp.

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

◆ operator[]() [6/6]

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
nameThe name of the keyword to find.

Definition at line 165 of file PvlContainer.h.

References Isis::PvlContainer::name(), and Isis::PvlContainer::operator[]().

◆ read()

◆ setFileName()

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

Sets the filename to the specified string.

Parameters
filenameThe new filename to use.

Definition at line 315 of file PvlContainer.h.

References Isis::PvlContainer::m_filename.

◆ setName()

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

◆ setTerminator()

void Isis::Pvl::setTerminator ( const QString &  term)
inlineinherited

Sets the terminator used to signify the end of the PVL informationDefaults to "END".

Parameters
termThe user-defined terminator

Definition at line 159 of file Pvl.h.

References Isis::Pvl::m_terminator.

Referenced by Isis::UserInterface::evaluateOption(), Isis::History::History(), Isis::OriginalLabel::OriginalLabel(), and Isis::CameraStatistics::toPvl().

◆ terminator()

QString Isis::Pvl::terminator ( ) const
inlineinherited

Returns the terminator used to signify the end of the PVL informationDefaults to "END".

Returns
The terminator used by the Pvl object.

Definition at line 168 of file Pvl.h.

References Isis::Pvl::m_terminator.

Referenced by Isis::Pvl::append(), Isis::operator<<(), and Isis::Pvl::write().

◆ type()

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

Returns the container type.

Returns
The container type.

Definition at line 93 of file PvlContainer.h.

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

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

◆ validateAllKeywords()

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(), Isis::PvlObject::validateObject(), and Isis::Pvl::validatePvl().

◆ validateObject()

◆ validatePvl()

◆ validateRepeatOption()

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().

◆ write()

void Isis::Pvl::write ( const QString &  file)
inherited

Opens and writes PVL information to a file and handles the end of line sequence.

Parameters
fileName of the file to create. The method will overwrite any existing file.
Exceptions
Isis::iException::Io

Definition at line 116 of file Pvl.cpp.

References _FILEINFO_, Isis::FileName::expanded(), Isis::Message::FileCreate(), Isis::IException::Io, and Isis::Pvl::terminator().

Referenced by Isis::Stretch::Save(), Isis::UserInterface::SaveHistory(), Isis::FileTool::saveInfo(), Isis::PvlEditDialog::saveTextEdit(), Isis::Blob::Write(), and Isis::ControlNet::Write().

Member Data Documentation

◆ m_filename

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

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

◆ m_keywords

QList<PvlKeyword> Isis::PvlContainer::m_keywords
protectedinherited

This is the vector of PvlKeywords the container is holding.

Definition at line 304 of file PvlContainer.h.

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

◆ m_name

PvlKeyword Isis::PvlContainer::m_name
protectedinherited

◆ p_preference

Preference * Isis::Preference::p_preference = NULL
staticprivate

Pointer to a Preference object.

Definition at line 102 of file Preference.h.

◆ p_unitTest

bool Isis::Preference::p_unitTest = false
staticprivate

Flag indicating whether the file is a unitTest or not.

Definition at line 103 of file Preference.h.

Referenced by IsUnitTest().


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