Isis 3 Programmer Reference
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Isis::PvlGroup Class Reference
Parsing

Contains multiple PvlContainers. More...

#include <PvlGroup.h>

Inheritance diagram for Isis::PvlGroup:
Inheritance graph
Collaboration diagram for Isis::PvlGroup:
Collaboration graph

Public Types

enum  InsertMode { Append , Replace }
 Contains both modes: Append or Replace. More...
 
typedef QList< PvlKeyword >::iterator PvlKeywordIterator
 The keyword iterator.
 
typedef QList< PvlKeyword >::const_iterator ConstPvlKeywordIterator
 The const keyword iterator.
 

Public Member Functions

 PvlGroup ()
 Creates a blank PvlGroup object.
 
 PvlGroup (const QString &name)
 Creates a PvlGroup object with a name.
 
 PvlGroup (const PvlGroup &other)
 Copy constructor.
 
void validateGroup (PvlGroup &pPvlGrp)
 Validate a Group comparing with the Template Group.
 
bool operator== (const PvlGroup &group) const
 Whenever the '==' operator is used on a PvlGroup object, it will call the stringEqual() method.
 
const PvlGroup & operator= (const PvlGroup &other)
 This is an assignment operator.
 
void setName (const QString &name)
 Set the name of the container.
 
QString name () const
 Returns the container name.
 
bool isNamed (const QString &match) const
 Returns whether the given string is equal to the container name or not.
 
QString type () const
 Returns the container type.
 
int keywords () const
 Returns the number of keywords contained in the PvlContainer.
 
void clear ()
 Clears PvlKeywords.
 
void addKeyword (const PvlKeyword &keyword, const InsertMode mode=Append)
 Add a keyword to the container.
 
PvlKeywordIterator addKeyword (const PvlKeyword &keyword, PvlKeywordIterator pos)
 Insert a keyword at the specified iterator position.
 
void operator+= (const PvlKeyword &keyword)
 When you use the += operator with a PvlKeyword, it will call the addKeyword() method.
 
PvlKeyword & findKeyword (const QString &name)
 Find a keyword with a specified name.
 
const PvlKeyword & findKeyword (const QString &name) const
 Find a keyword with a specified name.
 
PvlKeywordIterator findKeyword (const QString &name, PvlKeywordIterator beg, PvlKeywordIterator end)
 Find the index of a keyword, using iterators.
 
ConstPvlKeywordIterator findKeyword (const QString &name, ConstPvlKeywordIterator beg, ConstPvlKeywordIterator end) const
 Find the index of a keyword, using iterators.
 
PvlKeyword & operator[] (const QString &name)
 When you use the [] operator with a (string) name, it will call the findKeyword() method.
 
PvlKeyword & operator[] (const int index)
 Return the PvlKeyword object at the specified index.
 
PvlKeyword & operator[] (const char *name)
 When you use the [] operator with a (char) name, it will call the findKeyword() method.
 
const PvlKeyword & operator[] (const QString &name) const
 When you use the [] operator with a (string) name, it will call the findKeyword() method.
 
const PvlKeyword & operator[] (const int index) const
 Return the PvlKeyword object at the specified index.
 
PvlKeyword operator[] (const char *name) const
 When you use the [] operator with a (char) name, it will call the findKeyword() method.
 
bool hasKeyword (const QString &name) const
 Check to see if a keyword exists.
 
PvlKeywordIterator begin ()
 Return the beginning iterator.
 
ConstPvlKeywordIterator begin () const
 Return the const beginning iterator.
 
PvlKeywordIterator end ()
 Return the ending iterator.
 
ConstPvlKeywordIterator end () const
 Return the const ending iterator.
 
void deleteKeyword (const QString &name)
 Remove a specified keyword.
 
void deleteKeyword (const int index)
 Remove the specified keyword.
 
bool cleanDuplicateKeywords ()
 Removes keywords from the container that have BOTH the same name and value.
 
void operator-= (const QString &name)
 When you use the -= operator with a (string) name, it will call the deleteKeyword() method.
 
void operator-= (const PvlKeyword &key)
 When you use the -= operator with a PvlKeyword object, it will call the deleteKeyword() method.
 
QString fileName () const
 Returns the filename used to initialise the Pvl object.
 
void setFormatTemplate (PvlContainer &ref)
 
bool hasFormatTemplate ()
 
PvlContainer * formatTemplate ()
 
PvlFormat * format ()
 
void setFormat (PvlFormat *format)
 
int indent ()
 
void setIndent (int indent)
 
int comments () const
 
QString comment (const int index) const
 
void addComment (const QString &comment)
 
PvlKeyword & nameKeyword ()
 
const PvlKeyword & nameKeyword () const
 

Protected Member Functions

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

Protected Attributes

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

Friends

std::istream & operator>> (std::istream &is, PvlGroup &result)
 Read in a group.
 
std::ostream & operator<< (std::ostream &os, PvlGroup &group)
 Outputs the PvlGroup data to a specified output stream.
 

Detailed Description

Contains multiple PvlContainers.

Contains multiple PvlContainers so that keyword-value pairs can be organized in specific groups. For example, a PvlGroup would be used to group all data from a particular mission together. A PvlGroup object will also organize (indent) objects on output.

Author
2002-10-11 Jeff Anderson
History

2005-04-04 Leah Dahmer wrote class documentation.

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

2006-09-11 Stuart Sides Added formatting ability

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

2008-07-02 Steven Lambright Updated to compensate for PvlKeyword no longer being a parent

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

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

2010-09-27 Sharmila Prasad - Added API to Validate a PVLGroup

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.

Todo
2005-04-04 Needs coded example.

Definition at line 41 of file PvlGroup.h.

Member Typedef Documentation

◆ ConstPvlKeywordIterator

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

The const keyword iterator.

Definition at line 160 of file PvlContainer.h.

◆ PvlKeywordIterator

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

The keyword iterator.

Definition at line 157 of file PvlContainer.h.

Member Enumeration Documentation

◆ InsertMode

enum Isis::PvlContainer::InsertMode
inherited

Contains both modes: Append or Replace.

Definition at line 95 of file PvlContainer.h.

Constructor & Destructor Documentation

◆ PvlGroup() [1/3]

Isis::PvlGroup::PvlGroup ( )

Creates a blank PvlGroup object.

Definition at line 16 of file PvlGroup.cpp.

◆ PvlGroup() [2/3]

Isis::PvlGroup::PvlGroup ( const QString & name)

Creates a PvlGroup object with a name.

Parameters
nameThe group name.

Definition at line 22 of file PvlGroup.cpp.

◆ PvlGroup() [3/3]

Isis::PvlGroup::PvlGroup ( const PvlGroup & other)

Copy constructor.

Definition at line 28 of file PvlGroup.cpp.

Member Function Documentation

◆ addComment()

void Isis::PvlContainer::addComment ( const QString & comment)
inlineinherited

Definition at line 269 of file PvlContainer.h.

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

References Isis::PvlContainer::findKeyword(), Isis::PvlContainer::hasKeyword(), Isis::PvlContainer::m_keywords, and Isis::PvlKeyword::name().

Referenced by Isis::ControlNetDiff::addUniquePoint(), Isis::CameraFactory::Create(), Isis::ControlNetDiff::diff(), Isis::ControlNetDiff::diff(), Isis::ProcessImportPds::ExtractPdsProjection(), Isis::PvlContainer::operator+=(), Isis::PvlObject::PvlObject(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::Projection::SetUpperLeftCorner(), and Isis::SubArea::UpdateLabel().

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

References Isis::PvlContainer::m_keywords.

◆ begin() [1/2]

PvlKeywordIterator Isis::PvlContainer::begin ( )
inlineinherited

Return the beginning iterator.

Returns
The beginning iterator.

Definition at line 178 of file PvlContainer.h.

References Isis::PvlContainer::m_keywords.

Referenced by Isis::PvlContainer::cleanDuplicateKeywords(), Isis::PvlContainer::deleteKeyword(), Isis::PvlContainer::deleteKeyword(), Isis::PvlObject::findKeyword(), Isis::PvlContainer::findKeyword(), Isis::PvlContainer::findKeyword(), Isis::PvlObject::hasKeyword(), and Isis::PvlContainer::hasKeyword().

◆ begin() [2/2]

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

Return the const beginning iterator.

Returns
The const beginning iterator.

Definition at line 186 of file PvlContainer.h.

References Isis::PvlContainer::m_keywords.

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

References Isis::PvlContainer::begin(), Isis::PvlContainer::end(), and Isis::PvlContainer::m_keywords.

◆ clear()

void Isis::PvlContainer::clear ( )
inlineinherited

Clears PvlKeywords.

Definition at line 91 of file PvlContainer.h.

References Isis::PvlContainer::m_keywords.

Referenced by Isis::PvlObject::clear().

◆ comment()

QString Isis::PvlContainer::comment ( const int index) const
inlineinherited

Definition at line 265 of file PvlContainer.h.

◆ comments()

int Isis::PvlContainer::comments ( ) const
inlineinherited

Definition at line 262 of file PvlContainer.h.

◆ deleteKeyword() [1/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 115 of file PvlContainer.cpp.

References Isis::PvlContainer::begin(), Isis::PvlContainer::m_filename, Isis::PvlContainer::m_keywords, Isis::PvlContainer::name(), Isis::PvlContainer::type(), and Isis::IException::Unknown.

◆ deleteKeyword() [2/2]

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

Remove a specified keyword.

Parameters
nameThe name of the keyword to remove.
Exceptions
iException::PvlKeyword doesn't exist.

Definition at line 97 of file PvlContainer.cpp.

References Isis::PvlContainer::begin(), Isis::PvlContainer::end(), Isis::PvlContainer::findKeyword(), Isis::PvlContainer::m_filename, Isis::PvlContainer::m_keywords, Isis::PvlContainer::name(), Isis::PvlContainer::type(), and Isis::IException::Unknown.

Referenced by IsisAml::CommandLine(), Isis::ControlPointV0001::ControlPointV0001(), Isis::ControlPointV0002::ControlPointV0002(), Isis::ControlPointV0003::ControlPointV0003(), Isis::MosaicController::convertV1ToV2(), Isis::Blob::Find(), Isis::PvlContainer::operator-=(), Isis::PvlContainer::operator-=(), and Isis::Blob::Write().

◆ end() [1/2]

PvlKeywordIterator Isis::PvlContainer::end ( )
inlineinherited

Return the ending iterator.

Returns
The ending iterator.

Definition at line 194 of file PvlContainer.h.

References Isis::PvlContainer::m_keywords.

Referenced by Isis::PvlContainer::cleanDuplicateKeywords(), Isis::PvlContainer::deleteKeyword(), Isis::PvlObject::findGroup(), Isis::PvlObject::findGroup(), Isis::PvlObject::findKeyword(), Isis::PvlContainer::findKeyword(), Isis::PvlContainer::findKeyword(), Isis::PvlContainer::findKeyword(), Isis::PvlContainer::findKeyword(), Isis::PvlObject::findObject(), Isis::PvlObject::findObject(), Isis::PvlObject::hasKeyword(), and Isis::PvlContainer::hasKeyword().

◆ end() [2/2]

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

Return the const ending iterator.

Returns
The const ending iterator.

Definition at line 202 of file PvlContainer.h.

References Isis::PvlContainer::m_keywords.

◆ fileName()

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

Returns the filename used to initialise the Pvl object.

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

Returns
The filename.

Definition at line 232 of file PvlContainer.h.

References Isis::PvlContainer::m_filename.

Referenced by Isis::PvlObject::addObject(), Isis::ObservationNumber::Compose(), Isis::SerialNumber::Compose(), Isis::ProjectionFactory::CreateForCube(), Isis::ProjectionFactory::CreateForCube(), Isis::ProjectionFactory::CreateFromCube(), Isis::PvlTranslationTable::findTranslationGroup(), Isis::ApolloPanoramicDetectorMap::initializeInteriorOrientation(), Isis::PvlToPvlTranslationManager::InputKeyword(), Isis::PvlToXmlTranslationManager::InputKeyword(), Isis::PvlTranslationTable::OutputPosition(), Isis::ProjectionFactory::RingsCreateForCube(), Isis::ProjectionFactory::RingsCreateForCube(), Isis::ProjectionFactory::RingsCreateFromCube(), and Isis::PvlTranslationTable::Translate().

◆ findKeyword() [1/4]

Isis::PvlKeyword & Isis::PvlContainer::findKeyword ( const QString & name)
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 62 of file PvlContainer.cpp.

References Isis::PvlContainer::begin(), Isis::PvlContainer::end(), Isis::PvlContainer::findKeyword(), Isis::PvlContainer::m_filename, Isis::PvlContainer::name(), Isis::PvlContainer::type(), and Isis::IException::Unknown.

Referenced by Isis::PvlContainer::addKeyword(), Isis::CubeIoHandler::CubeIoHandler(), Isis::PvlContainer::deleteKeyword(), Isis::SpectralPlotWindow::drawBandMarkers(), Isis::PvlContainer::findKeyword(), Isis::PvlContainer::findKeyword(), Isis::CubeViewport::getBandFilterName(), Isis::PvlContainer::hasKeyword(), Isis::JunoCamera::JunoCamera(), Isis::KernelDb::matches(), Isis::PvlContainer::operator[](), Isis::PvlContainer::operator[](), Isis::PvlContainer::validateAllKeywords(), and Isis::PvlContainer::validateRepeatOption().

◆ findKeyword() [2/4]

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

References Isis::PvlContainer::begin(), Isis::PvlContainer::end(), Isis::PvlContainer::findKeyword(), Isis::PvlContainer::m_filename, Isis::PvlContainer::name(), Isis::PvlContainer::type(), and Isis::IException::Unknown.

◆ findKeyword() [3/4]

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

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

◆ findKeyword() [4/4]

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

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

◆ format()

PvlFormat * Isis::PvlContainer::format ( )
inlineinherited

Definition at line 248 of file PvlContainer.h.

◆ formatTemplate()

PvlContainer * Isis::PvlContainer::formatTemplate ( )
inlineinherited

Definition at line 244 of file PvlContainer.h.

◆ hasFormatTemplate()

bool Isis::PvlContainer::hasFormatTemplate ( )
inlineinherited

Definition at line 240 of file PvlContainer.h.

◆ hasKeyword()

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

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

Referenced by Isis::PvlContainer::addKeyword(), Isis::Albedo::Albedo(), Isis::AtmosModel::AtmosModel(), Isis::BulletShapeModel::BulletShapeModel(), IsisAml::CommandLine(), Isis::ControlNetDiff::compareGroups(), Isis::ControlPointV0001::ControlPointV0001(), Isis::ControlPointV0002::ControlPointV0002(), Isis::ControlPointV0003::ControlPointV0003(), Isis::DemShape::DemShape(), Isis::EmbreeShapeModel::EmbreeShapeModel(), Isis::Kernels::findKernels(), Isis::Kernels::getCameraVersion(), Isis::GroundGrid::GroundGrid(), Isis::Spice::hasKernels(), Isis::HiLab::HiLab(), Isis::Spice::init(), Isis::RingPlaneProjection::Mapping(), Isis::TProjection::Mapping(), Isis::NaifDskShape::NaifDskShape(), Isis::PhotoModel::PhotoModel(), Isis::Projection::Projection(), Isis::RingPlaneProjection::RingPlaneProjection(), Isis::ProcessImportFits::setFitsFile(), Isis::ProcessImportFits::setProcessFileStructure(), Isis::Target::Target(), Isis::Target::Target(), Isis::TProjection::TProjection(), Isis::SpectralPlotTool::updateTool(), Isis::PvlContainer::validateAllKeywords(), Isis::ControlNetValidMeasure::ValidatePvlDN(), Isis::ControlNetValidMeasure::ValidatePvlEmissionAngle(), Isis::ControlNetValidMeasure::ValidatePvlFromEdge(), Isis::ControlNetValidMeasure::ValidatePvlIncidenceAngle(), Isis::ControlNetValidMeasure::ValidatePvlResidualTolerances(), Isis::ControlNetValidMeasure::ValidatePvlResolution(), Isis::ControlNetValidMeasure::ValidatePvlShiftTolerances(), and Isis::PvlContainer::validateRepeatOption().

◆ indent()

int Isis::PvlContainer::indent ( )
inlineinherited

Definition at line 255 of file PvlContainer.h.

◆ init()

void Isis::PvlContainer::init ( )
protectedinherited

Sets the filename to blank.

Definition at line 51 of file PvlContainer.cpp.

References Isis::PvlContainer::m_filename.

Referenced by Isis::PvlContainer::PvlContainer(), and Isis::PvlContainer::PvlContainer().

◆ isNamed()

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

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

Parameters
matchThe 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 Isis::PvlContainer::m_name, and Isis::PvlKeyword::stringEqual().

Referenced by Isis::KernelDb::findAll(), Isis::Table::initFromBlob(), and Isis::RemoveHiBlobs().

◆ keywords()

int Isis::PvlContainer::keywords ( ) const
inlineinherited

Returns the number of keywords contained in the PvlContainer.

Returns
The number of keywords.

Definition at line 86 of file PvlContainer.h.

References Isis::PvlContainer::m_keywords.

Referenced by Isis::ControlPointV0001::ControlPointV0001(), Isis::ControlPointV0002::ControlPointV0002(), Isis::ControlPointV0003::ControlPointV0003(), Isis::operator<<(), Isis::Table::toBlob(), and Isis::PvlContainer::validateAllKeywords().

◆ name()

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

Returns the container name.

Returns
The container name.

Definition at line 63 of file PvlContainer.h.

References Isis::PvlContainer::m_name.

Referenced by Isis::ControlNetDiff::compare(), Isis::ControlPointV0001::ControlPointV0001(), Isis::ControlPointV0002::ControlPointV0002(), Isis::ControlPointV0003::ControlPointV0003(), Isis::ProcessExportPds4::createUnitMap(), Isis::PvlObject::deleteGroup(), Isis::PvlObject::deleteGroup(), Isis::PvlContainer::deleteKeyword(), Isis::PvlContainer::deleteKeyword(), Isis::PvlObject::deleteObject(), Isis::PvlObject::deleteObject(), Isis::PvlObject::findGroup(), Isis::PvlObject::findGroup(), Isis::PvlObject::findGroup(), Isis::PvlObject::findGroup(), Isis::PvlContainer::findKeyword(), Isis::PvlContainer::findKeyword(), Isis::PvlContainer::findKeyword(), Isis::PvlContainer::findKeyword(), Isis::PvlObject::findObject(), Isis::PvlObject::findObject(), Isis::PvlObject::findObject(), Isis::PvlObject::findObject(), Isis::PvlObject::hasGroup(), Isis::PvlContainer::hasKeyword(), Isis::PvlObject::hasObject(), Isis::PvlFlatMap::loadGroup(), Isis::UserInterface::loadHistory(), Isis::ImportPdsTable::loadLabel(), Isis::PvlContainer::operator-=(), Isis::operator<<(), operator==(), Isis::PvlObject::operator==(), Isis::PvlContainer::operator[](), Isis::PvlContainer::operator[](), Isis::PvlContainer::operator[](), Isis::PvlContainer::operator[](), Isis::Cube::putGroup(), Isis::PvlContainer::PvlContainer(), Isis::PvlObject::PvlObject(), Isis::PvlContainer::setName(), Isis::Table::toBlob(), Isis::Gui::UpdateHistory(), Isis::Cube::write(), and Isis::Blob::Write().

◆ nameKeyword() [1/2]

PvlKeyword & Isis::PvlContainer::nameKeyword ( )
inlineinherited

Definition at line 273 of file PvlContainer.h.

◆ nameKeyword() [2/2]

const PvlKeyword & Isis::PvlContainer::nameKeyword ( ) const
inlineinherited

Definition at line 276 of file PvlContainer.h.

◆ operator+=()

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

References Isis::PvlContainer::addKeyword().

◆ operator-=() [1/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 224 of file PvlContainer.h.

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

◆ operator-=() [2/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 216 of file PvlContainer.h.

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

◆ operator=()

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

This is an assignment operator.

Definition at line 190 of file PvlGroup.cpp.

References Isis::PvlContainer::operator=().

◆ operator==()

bool Isis::PvlGroup::operator== ( const PvlGroup & group) const
inline

Whenever the '==' operator is used on a PvlGroup object, it will call the stringEqual() method.

This returns a boolean value.

Parameters
groupThe PvlGroup object to compare.
Returns
True if the other PvlGroup has the same name as this one, false if not.

Definition at line 59 of file PvlGroup.h.

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

◆ operator[]() [1/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 130 of file PvlContainer.h.

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

◆ operator[]() [2/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 151 of file PvlContainer.h.

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

◆ operator[]() [3/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 172 of file PvlContainer.cpp.

References Isis::Message::ArraySubscriptNotInRange(), Isis::PvlContainer::m_keywords, and Isis::IException::Programmer.

◆ operator[]() [4/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 187 of file PvlContainer.cpp.

References Isis::Message::ArraySubscriptNotInRange(), Isis::PvlContainer::m_keywords, and Isis::IException::Programmer.

◆ operator[]() [5/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 120 of file PvlContainer.h.

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

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

◆ operator[]() [6/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 141 of file PvlContainer.h.

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

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

References Isis::PvlContainer::m_filename.

◆ setFormat()

void Isis::PvlContainer::setFormat ( PvlFormat * format)
inlineinherited

Definition at line 251 of file PvlContainer.h.

◆ setFormatTemplate()

void Isis::PvlContainer::setFormatTemplate ( PvlContainer & ref)
inlineinherited

Definition at line 236 of file PvlContainer.h.

◆ setIndent()

void Isis::PvlContainer::setIndent ( int indent)
inlineinherited

Definition at line 258 of file PvlContainer.h.

◆ setName()

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

Set the name of the container.

Definition at line 56 of file PvlContainer.h.

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

Referenced by Isis::Blob::Blob(), Isis::MosaicController::convertV1ToV2(), Isis::fitsToJson(), Isis::ProcessImportPds::ProcessImportPds(), and Isis::PvlContainer::PvlContainer().

◆ type()

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

Returns the container type.

Returns
The container type.

Definition at line 79 of file PvlContainer.h.

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

Referenced by Isis::PvlObject::deleteGroup(), Isis::PvlObject::deleteGroup(), Isis::PvlContainer::deleteKeyword(), Isis::PvlContainer::deleteKeyword(), Isis::PvlObject::deleteObject(), Isis::PvlObject::deleteObject(), Isis::PvlContainer::findKeyword(), Isis::PvlContainer::findKeyword(), Isis::PvlContainer::PvlContainer(), and Isis::PvlContainer::PvlContainer().

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

References Isis::PvlContainer::findKeyword(), Isis::PvlContainer::hasKeyword(), Isis::PvlContainer::keywords(), Isis::PvlKeyword::name(), Isis::IException::User, and Isis::PvlContainer::validateRepeatOption().

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

◆ validateGroup()

void Isis::PvlGroup::validateGroup ( PvlGroup & pPvlGrp)

Validate a Group comparing with the Template Group.

Validate a PvlGroup, comparing against the corresponding PvlGroup in the Template file.

Template PvlGroup has the format: Group = (groupName, optional/required)

Author
Sharmila Prasad (9/22/2010)
Parameters
pPvlGrp- PvlGroup to be validated

Definition at line 207 of file PvlGroup.cpp.

References Isis::IException::User, and Isis::PvlContainer::validateAllKeywords().

Referenced by Isis::PvlObject::validateObject(), and Isis::Pvl::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 470 of file PvlContainer.cpp.

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

Referenced by Isis::PvlContainer::validateAllKeywords().

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream & os,
PvlGroup & group )
friend

Outputs the PvlGroup data to a specified output stream.

Parameters
osThe output stream to output to.
groupThe PvlGroup object to output.

Definition at line 145 of file PvlGroup.cpp.

◆ operator>>

std::istream & operator>> ( std::istream & is,
PvlGroup & result )
friend

Read in a group.

Parameters
isThe input stream
resultThe PvlGroup to read into (OUTPUT)

Definition at line 38 of file PvlGroup.cpp.

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

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

◆ m_formatTemplate

PvlContainer* Isis::PvlContainer::m_formatTemplate
protectedinherited

Definition at line 305 of file PvlContainer.h.

◆ m_keywords

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

This is the vector of PvlKeywords the container is holding.

Definition at line 290 of file PvlContainer.h.

Referenced by Isis::PvlContainer::addKeyword(), Isis::PvlContainer::addKeyword(), Isis::PvlContainer::begin(), Isis::PvlContainer::begin(), Isis::PvlContainer::cleanDuplicateKeywords(), Isis::PvlContainer::clear(), Isis::PvlContainer::deleteKeyword(), Isis::PvlContainer::deleteKeyword(), Isis::PvlContainer::end(), Isis::PvlContainer::end(), Isis::PvlContainer::keywords(), Isis::PvlContainer::operator=(), Isis::PvlContainer::operator[](), and Isis::PvlContainer::operator[]().

◆ m_name

PvlKeyword Isis::PvlContainer::m_name
protectedinherited

This is the name keyword.

Definition at line 289 of file PvlContainer.h.

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

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