|
Isis 3.0 Object Programmers' Reference |
Home |
Contains multiple PvlContainers. More...
#include <PvlGroup.h>


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 * | GetFormat () |
| void | SetFormat (PvlFormat *format) |
| int | Indent () |
| void | SetIndent (int indent) |
| int | Comments () const |
| QString | Comment (const int index) const |
| void | AddComment (const QString &comment) |
| PvlKeyword & | GetNameKeyword () |
| const PvlKeyword & | GetNameKeyword () const |
Protected Member Functions | |
| void | Init () |
| Sets the filename to blank. | |
| void | SetFileName (const QString &filename) |
| Sets the filename to the specified string. | |
| void | ValidateAllKeywords (PvlContainer &pPvlCont) |
| Validate All the Keywords in a Container comparing with the Template. | |
| void | ValidateRepeatOption (PvlKeyword &pPvlTmplKwrd, PvlContainer &pPvlCont) |
| Validate the Repeat Option for a Keyword. | |
Protected Attributes | |
| QString | p_filename |
| This contains the filename used to initialize the pvl object. | |
| PvlKeyword | p_name |
| This is the name keyword. | |
| QList< PvlKeyword > | p_keywords |
| This is the vector of PvlKeywords the container is holding. | |
| PvlContainer * | p_formatTemplate |
Friends | |
| std::istream & | operator>> (std::istream &is, PvlGroup &result) |
| std::ostream & | operator<< (std::ostream &os, PvlGroup &group) |
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.
For internal use only.
Definition at line 55 of file PvlGroup.h.
typedef QList<PvlKeyword>::const_iterator Isis::PvlContainer::ConstPvlKeywordIterator [inherited] |
The const keyword iterator.
Definition at line 174 of file PvlContainer.h.
typedef QList<PvlKeyword>::iterator Isis::PvlContainer::PvlKeywordIterator [inherited] |
The keyword iterator.
Definition at line 171 of file PvlContainer.h.
enum Isis::PvlContainer::InsertMode [inherited] |
Contains both modes: Append or Replace.
Definition at line 109 of file PvlContainer.h.
| Isis::PvlGroup::PvlGroup | ( | ) |
Creates a blank PvlGroup object.
Definition at line 29 of file PvlGroup.cpp.
| Isis::PvlGroup::PvlGroup | ( | const QString & | name | ) |
Creates a PvlGroup object with a name.
| name | The group name. |
Definition at line 35 of file PvlGroup.cpp.
| Isis::PvlGroup::PvlGroup | ( | const PvlGroup & | other | ) |
Copy constructor.
Definition at line 41 of file PvlGroup.cpp.
| 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.
| key | Keyword to insert | |
| pos | Iterator position where to insert the new keyword |
Definition at line 249 of file PvlContainer.cpp.
References Isis::PvlContainer::p_keywords.
| 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.
| keyword | The PvlKeyword object to append. | |
| mode | Using the InsertMode value of Append. | |
| key | The PvlKeyword object to add. | |
| mode | The enum InsertMode has two possible values, Append or Replace. Use Append if you just want to add it to the end, Replace if you want to replace it. |
Definition at line 218 of file PvlContainer.cpp.
References Isis::PvlContainer::FindKeyword(), Isis::PvlContainer::HasKeyword(), Isis::PvlKeyword::Name(), and Isis::PvlContainer::p_keywords.
Referenced by Isis::ControlNetDiff::addUniqueMeasure(), Isis::ControlNetDiff::addUniquePoint(), Isis::NaifStatus::CheckErrors(), Isis::ControlNetDiff::compare(), Isis::ControlNetDiff::compareGroups(), Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::CameraFactory::Create(), Isis::ProjectionFactory::CreateForCube(), Isis::ControlNetDiff::diff(), Isis::ExportPdsTable::fillMetaData(), Isis::Application::GetEnviromentInfo(), Isis::CameraPointInfo::GetPointInfo(), Isis::Application::GetUnameInfo(), Isis::PvlContainer::operator+=(), Isis::operator<<(), Isis::operator>>(), Isis::StripPolygonSeeder::PluginParameters(), Isis::PolygonSeeder::PluginParameters(), Isis::LimitPolygonSeeder::PluginParameters(), Isis::GridPolygonSeeder::PluginParameters(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::Projection::SetUpperLeftCorner(), Isis::SubArea::UpdateLabel(), Isis::CubeTileHandler::updateLabels(), Isis::CubeBsqHandler::updateLabels(), and Isis::ControlNetFileV0002::Write().
| ConstPvlKeywordIterator Isis::PvlContainer::Begin | ( | ) | const [inline, inherited] |
Return the const beginning iterator.
Definition at line 200 of file PvlContainer.h.
References Isis::PvlContainer::p_keywords.
| PvlKeywordIterator Isis::PvlContainer::Begin | ( | ) | [inline, inherited] |
Return the beginning iterator.
Definition at line 192 of file PvlContainer.h.
References Isis::PvlContainer::p_keywords.
Referenced by Isis::PvlContainer::CleanDuplicateKeywords(), Isis::PvlContainer::DeleteKeyword(), Isis::PvlObject::FindKeyword(), Isis::PvlContainer::FindKeyword(), Isis::PvlObject::HasKeyword(), Isis::PvlContainer::HasKeyword(), Isis::PvlTranslationTable::InputGroup(), Isis::DbProfile::loadkeys(), and Isis::PvlTranslationTable::Translate().
| bool Isis::PvlContainer::CleanDuplicateKeywords | ( | ) | [inherited] |
Removes keywords from the container that have BOTH the same name and value.
Definition at line 152 of file PvlContainer.cpp.
References Isis::PvlContainer::Begin(), Isis::PvlContainer::End(), and Isis::PvlContainer::p_keywords.
| void Isis::PvlContainer::Clear | ( | ) | [inline, inherited] |
Clears PvlKeywords.
Reimplemented in Isis::PvlObject.
Definition at line 105 of file PvlContainer.h.
References Isis::PvlContainer::p_keywords.
| void Isis::PvlContainer::DeleteKeyword | ( | const int | index | ) | [inherited] |
Remove the specified keyword.
| index | The index of the keyword to remove. |
| iException::Pvl | Keyword doesn't exist. |
Definition at line 131 of file PvlContainer.cpp.
References _FILEINFO_, Isis::PvlContainer::Begin(), Isis::PvlContainer::Name(), Isis::PvlContainer::p_filename, Isis::PvlContainer::p_keywords, Isis::PvlContainer::Type(), and Isis::IException::Unknown.
| void Isis::PvlContainer::DeleteKeyword | ( | const QString & | name | ) | [inherited] |
Remove a specified keyword.
| name | The name of the keyword to remove. |
| iException::Pvl | Keyword doesn't exist. |
Definition at line 113 of file PvlContainer.cpp.
References _FILEINFO_, Isis::PvlContainer::Begin(), Isis::PvlContainer::End(), Isis::PvlContainer::FindKeyword(), Isis::PvlContainer::Name(), Isis::PvlContainer::p_filename, Isis::PvlContainer::p_keywords, Isis::PvlContainer::Type(), and Isis::IException::Unknown.
Referenced by IsisAml::CommandLine(), Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::ControlNetVersioner::Copy(), Isis::Blob::Find(), Isis::ControlNetVersioner::LatestPvlToBinary(), Isis::ObliqueCylindrical::ObliqueCylindrical(), Isis::PvlContainer::operator-=(), Isis::StripPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::LimitPolygonSeeder::Parse(), Isis::GridPolygonSeeder::Parse(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::Projection::TargetRadii(), Isis::SubArea::UpdateLabel(), Isis::PvlContainer::ValidateAllKeywords(), Isis::PvlContainer::ValidateRepeatOption(), Isis::Blob::Write(), and Isis::Table::WriteInit().
| ConstPvlKeywordIterator Isis::PvlContainer::End | ( | ) | const [inline, inherited] |
Return the const ending iterator.
Definition at line 216 of file PvlContainer.h.
References Isis::PvlContainer::p_keywords.
| PvlKeywordIterator Isis::PvlContainer::End | ( | ) | [inline, inherited] |
Return the ending iterator.
Definition at line 208 of file PvlContainer.h.
References Isis::PvlContainer::p_keywords.
Referenced by Isis::PvlContainer::CleanDuplicateKeywords(), Isis::PvlContainer::DeleteKeyword(), Isis::PvlObject::FindKeyword(), Isis::PvlContainer::FindKeyword(), Isis::PvlObject::HasKeyword(), Isis::PvlContainer::HasKeyword(), Isis::PvlTranslationTable::InputGroup(), Isis::DbProfile::loadkeys(), and Isis::PvlTranslationTable::Translate().
| QString Isis::PvlContainer::FileName | ( | ) | const [inline, inherited] |
Returns the filename used to initialise the Pvl object.
If the object was not initialized using a file, this string is empty.
Definition at line 246 of file PvlContainer.h.
References Isis::PvlContainer::p_filename.
Referenced by Isis::PvlObject::AddObject(), Isis::SerialNumber::Compose(), Isis::ObservationNumber::Compose(), Isis::ProjectionFactory::Create(), Isis::ProjectionFactory::CreateForCube(), Isis::ProjectionFactory::CreateFromCube(), Isis::HrscCamera::HrscCamera(), Isis::UniversalGroundMap::Init(), Isis::Spice::init(), Isis::ApolloPanoramicDetectorMap::initializeInteriorOrientation(), Isis::PvlTranslationTable::InputDefault(), Isis::PvlTranslationTable::InputGroup(), Isis::PvlTranslationManager::InputKeyword(), Isis::PvlTranslationTable::InputKeywordName(), Isis::InterestOperator::Parse(), Isis::StripPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::LimitPolygonSeeder::Parse(), Isis::GridPolygonSeeder::Parse(), Isis::AutoReg::Parse(), Isis::PvlEditDialog::PvlEditDialog(), and Isis::PvlTranslationTable::Translate().
| PvlContainer::ConstPvlKeywordIterator Isis::PvlContainer::FindKeyword | ( | const QString & | name, | |
| PvlContainer::ConstPvlKeywordIterator | beg, | |||
| PvlContainer::ConstPvlKeywordIterator | end | |||
| ) | const [inherited] |
Find the index of a keyword, using iterators.
| name | The name of the keyword. | |
| beg | The beginning iterator. | |
| end | The ending iterator. |
Definition at line 382 of file PvlContainer.cpp.
| PvlContainer::PvlKeywordIterator Isis::PvlContainer::FindKeyword | ( | const QString & | name, | |
| PvlContainer::PvlKeywordIterator | beg, | |||
| PvlContainer::PvlKeywordIterator | end | |||
| ) | [inherited] |
Find the index of a keyword, using iterators.
| name | The name of the keyword. | |
| beg | The beginning iterator. | |
| end | The ending iterator. |
Definition at line 367 of file PvlContainer.cpp.
| const Isis::PvlKeyword & Isis::PvlContainer::FindKeyword | ( | const QString & | name | ) | const [inherited] |
Find a keyword with a specified name.
| name | The name of the keyword to look for. |
| IException | The keyword doesn't exist. |
Definition at line 96 of file PvlContainer.cpp.
References _FILEINFO_, Isis::PvlContainer::Begin(), Isis::PvlContainer::End(), Isis::PvlContainer::FindKeyword(), Isis::PvlContainer::Name(), Isis::PvlContainer::p_filename, Isis::PvlContainer::Type(), and Isis::IException::Unknown.
| Isis::PvlKeyword & Isis::PvlContainer::FindKeyword | ( | const QString & | name | ) | [inherited] |
Find a keyword with a specified name.
| name | The name of the keyword to look for. |
| iException::Pvl | The keyword doesn't exist. |
Definition at line 78 of file PvlContainer.cpp.
References _FILEINFO_, Isis::PvlContainer::Begin(), Isis::PvlContainer::End(), Isis::PvlContainer::Name(), Isis::PvlContainer::p_filename, Isis::PvlContainer::Type(), and Isis::IException::Unknown.
Referenced by Isis::PvlContainer::AddKeyword(), Isis::ApolloMetricCamera::ApolloMetricCamera(), IsisAml::CheckFileNamePreference(), Isis::ControlNetDiff::compare(), Isis::ControlNetDiff::compareGroups(), Isis::CubeIoHandler::CubeIoHandler(), Isis::PvlContainer::DeleteKeyword(), Isis::SpectralPlotWindow::drawBandMarkers(), Isis::PvlContainer::FindKeyword(), Isis::CubeViewport::getBandFilterName(), Isis::CameraPointInfo::GetPointInfo(), Isis::SpectralPlotTool::getSpectralStatistics(), Isis::PvlContainer::HasKeyword(), Isis::PvlTranslationTable::InputGroup(), Isis::PvlTranslationManager::InputKeyword(), Isis::Stretch::Load(), Isis::ProcessMosaic::MatchDEMShapeModel(), Isis::PvlContainer::operator[](), Isis::ReseauDistortionMap::ReseauDistortionMap(), Isis::Projection::TargetRadii(), Isis::PvlTranslationTable::Translate(), Isis::PvlContainer::ValidateAllKeywords(), Isis::PvlObject::ValidateObject(), Isis::Pvl::ValidatePvl(), and Isis::PvlContainer::ValidateRepeatOption().
| bool Isis::PvlContainer::HasKeyword | ( | const QString & | name | ) | const [inherited] |
Check to see if a keyword exists.
| name | The name of the keyword to check for. |
Definition at line 175 of file PvlContainer.cpp.
References Isis::PvlContainer::Begin(), Isis::PvlContainer::End(), and Isis::PvlContainer::FindKeyword().
Referenced by Isis::Latitude::add(), Isis::PvlContainer::AddKeyword(), Isis::ProjectionConfigDialog::addMissingKeywords(), Isis::PvlTranslationTable::AddTable(), Isis::AlbedoAtm::AlbedoAtm(), Isis::AtmosModel::AtmosModel(), Isis::Camera::Camera(), Isis::CameraFactory::CameraVersion(), IsisAml::CommandLine(), Isis::ControlNetDiff::compareGroups(), Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::ControlNetVersioner::Copy(), Isis::PhotoModelFactory::Create(), Isis::NormModelFactory::Create(), Isis::CameraFactory::Create(), Isis::AtmosModelFactory::Create(), Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Isis::DemShape::DemShape(), Isis::PvlTranslationManager::DoTranslation(), Isis::SpectralPlotWindow::drawBandMarkers(), Isis::Equirectangular::Equirectangular(), Isis::KernelDb::findAll(), Isis::Kernels::findKernels(), Isis::FeatureNomenclatureTool::findMissingNomenclature(), Isis::CubeViewport::getBandFilterName(), Isis::Kernels::getCameraVersion(), Isis::SpectralPlotTool::getSpectralStatistics(), Isis::GroundGrid::GroundGrid(), Isis::UniversalGroundMap::GroundRange(), Isis::Camera::GroundRange(), Isis::Spice::hasKernels(), Isis::HiLab::HiLab(), Isis::IdealCamera::IdealCamera(), Isis::Spice::init(), Isis::DatabaseFactory::initPreferences(), Isis::PvlTranslationTable::InputDefault(), Isis::PvlTranslationManager::InputHasKeyword(), Isis::PvlTranslationManager::InputKeyword(), Isis::PvlTranslationTable::InputKeywordName(), Isis::LambertConformal::LambertConformal(), Isis::ControlNetVersioner::LatestPvlToBinary(), Isis::Latitude::Latitude(), Isis::LoMediumCamera::LoMediumCamera(), Isis::Projection::Mapping(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::ProcessMosaic::MatchDEMShapeModel(), Isis::KernelDb::matches(), Isis::Mercator::Mercator(), Isis::ObliqueCylindrical::ObliqueCylindrical(), Isis::Orthographic::Orthographic(), Isis::StripPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::LimitPolygonSeeder::Parse(), Isis::GridPolygonSeeder::Parse(), Isis::AutoReg::Parse(), Isis::PhotoModel::PhotoModel(), Isis::ControlNetFilter::PointDistanceFilter(), Isis::ControlNetFilter::PointEditLockFilter(), Isis::ControlNetFilter::PointGoodnessOfFitFilter(), Isis::ControlNetFilter::PointLatLonFilter(), Isis::ControlNetFilter::PointMeasurePropertiesFilter(), Isis::ControlNetFilter::PointMeasuresFilter(), Isis::ControlNetFilter::PointNumMeasuresEditLockFilter(), Isis::PointPerspective::PointPerspective(), Isis::ControlNetFilter::PointPixelShiftFilter(), Isis::ControlNetFilter::PointPropertiesFilter(), Isis::ControlNetFilter::PointResMagnitudeFilter(), Isis::PolarStereographic::PolarStereographic(), Isis::Projection::Projection(), Isis::ControlNetVersioner::ReadBinaryNetwork(), Isis::MocLabels::ReadLabels(), Isis::AutoReg::RegTemplate(), Isis::Robinson::Robinson(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::SimpleCylindrical::SimpleCylindrical(), Isis::Sinusoidal::Sinusoidal(), Isis::Target::Target(), Isis::Projection::TargetRadii(), Isis::ThemisIrCamera::ThemisIrCamera(), Isis::ControlNetFileV0002::ToPvl(), Isis::IException::toString(), Isis::PvlTranslationTable::Translate(), Isis::PvlTranslationManager::Translate(), Isis::ProcessImportPds::TranslateIsis2Instrument(), Isis::TransverseMercator::TransverseMercator(), Isis::SubArea::UpdateLabel(), Isis::SpectralPlotTool::updateTool(), 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(), Isis::ControlNetValidMeasure::ValidatePvlShiftTolerances(), and Isis::PvlContainer::ValidateRepeatOption().
| void Isis::PvlContainer::Init | ( | ) | [protected, inherited] |
Sets the filename to blank.
Reimplemented in Isis::Pvl.
Definition at line 67 of file PvlContainer.cpp.
References Isis::PvlContainer::p_filename.
Referenced by Isis::PvlContainer::PvlContainer().
| bool Isis::PvlContainer::IsNamed | ( | const QString & | match | ) | const [inline, inherited] |
Returns whether the given string is equal to the container name or not.
| match | The string to compare to the name. |
Definition at line 86 of file PvlContainer.h.
References Isis::PvlContainer::p_name, and Isis::PvlKeyword::StringEqual().
Referenced by Isis::FileTool::copyCubeDetails(), Isis::Blob::Find(), Isis::KernelDb::findAll(), Isis::Cube::hasTable(), Isis::UserInterface::LoadHistory(), Isis::KernelDb::loadKernelDbFiles(), Isis::Table::ReadInit(), Isis::Process::SetOutputCube(), Isis::Gui::UpdateHistory(), and Isis::Process::WriteHistory().
| int Isis::PvlContainer::Keywords | ( | ) | const [inline, inherited] |
Returns the number of keywords contained in the PvlContainer.
Definition at line 100 of file PvlContainer.h.
References Isis::PvlContainer::p_keywords.
Referenced by Isis::ProcessMosaic::AddBandBinGroup(), Isis::PvlTranslationTable::AddTable(), Isis::ControlNetDiff::addTolerances(), Isis::ControlNetDiff::compare(), Isis::ControlNetDiff::compareGroups(), Isis::ControlNetVersioner::ConvertVersion1ToVersion2(), Isis::KernelDb::files(), Isis::KernelDb::findAll(), Isis::ObservationNumber::FindObservationTranslation(), Isis::SerialNumber::FindSerialTranslation(), Isis::MosaicSceneWidget::fromPvl(), Isis::CameraPointInfo::GetPointInfo(), Isis::ControlNetVersioner::LatestPvlToBinary(), Isis::UserInterface::LoadHistory(), Isis::KernelDb::loadKernelDbFiles(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::KernelDb::matches(), Isis::operator<<(), Isis::ControlNetFilter::PointCubeNamesFilter(), Isis::BandTool::setBandBin(), Isis::BandSpinBox::setBandBin(), Isis::BandTool::setList(), Isis::AdvancedTrackTool::TrackMosaicOrigin(), Isis::Gui::UpdateHistory(), Isis::PvlContainer::ValidateAllKeywords(), ValidateGroup(), Isis::PvlObject::ValidateObject(), Isis::Pvl::ValidatePvl(), and Isis::PvlContainer::ValidateRepeatOption().
| QString Isis::PvlContainer::Name | ( | ) | const [inline, inherited] |
Returns the container name.
Definition at line 77 of file PvlContainer.h.
References Isis::PvlContainer::p_name.
Referenced by Isis::PvlTranslationTable::AddTable(), Isis::ControlNetDiff::addTolerances(), Isis::FileTool::copyCubeDetails(), Isis::Cube::deleteBlob(), Isis::PvlObject::DeleteGroup(), Isis::PvlContainer::DeleteKeyword(), Isis::PvlObject::DeleteObject(), Isis::KernelDb::files(), Isis::PvlContainer::FindKeyword(), Isis::ControlNetVersioner::LatestPvlToBinary(), Isis::UserInterface::LoadHistory(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::operator<<(), Isis::PvlObject::operator==(), operator==(), Isis::operator>>(), Isis::Cube::putGroup(), Isis::BandTool::setBandBin(), Isis::BandSpinBox::setBandBin(), Isis::Process::SetOutputCube(), Isis::Gui::UpdateHistory(), ValidateGroup(), Isis::PvlObject::ValidateObject(), Isis::Pvl::ValidatePvl(), and Isis::Blob::Write().
| void Isis::PvlContainer::operator+= | ( | const PvlKeyword & | keyword | ) | [inline, inherited] |
When you use the += operator with a PvlKeyword, it will call the AddKeyword() method.
| keyword | The PvlKeyword to be added. |
Definition at line 124 of file PvlContainer.h.
References Isis::PvlContainer::AddKeyword().
| void Isis::PvlContainer::operator-= | ( | const PvlKeyword & | key | ) | [inline, inherited] |
When you use the -= operator with a PvlKeyword object, it will call the DeleteKeyword() method.
| key | The PvlKeyword object to remove. |
Definition at line 238 of file PvlContainer.h.
References Isis::PvlContainer::DeleteKeyword(), and Isis::PvlKeyword::Name().
| void Isis::PvlContainer::operator-= | ( | const QString & | name | ) | [inline, inherited] |
When you use the -= operator with a (string) name, it will call the DeleteKeyword() method.
| name | The name of the keyword to remove. |
Definition at line 230 of file PvlContainer.h.
References Isis::PvlContainer::DeleteKeyword().
This is an assignment operator.
Reimplemented from Isis::PvlContainer.
Definition at line 203 of file PvlGroup.cpp.
| 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.
| group | The PvlGroup object to compare. |
Definition at line 73 of file PvlGroup.h.
References Isis::PvlContainer::Name(), and Isis::PvlKeyword::StringEqual().
| PvlKeyword Isis::PvlContainer::operator[] | ( | const char * | name | ) | const [inline, inherited] |
When you use the [] operator with a (char) name, it will call the FindKeyword() method.
| name | The name of the keyword to find. |
Definition at line 165 of file PvlContainer.h.
References Isis::PvlContainer::operator[]().
| const Isis::PvlKeyword & Isis::PvlContainer::operator[] | ( | const int | index | ) | const [inherited] |
Return the PvlKeyword object at the specified index.
| index | The index to use. |
| iException::Message | The index is out of bounds. |
Definition at line 203 of file PvlContainer.cpp.
References _FILEINFO_, Isis::Message::ArraySubscriptNotInRange(), Isis::PvlContainer::p_keywords, and Isis::IException::Programmer.
| const PvlKeyword& Isis::PvlContainer::operator[] | ( | const QString & | name | ) | const [inline, inherited] |
When you use the [] operator with a (string) name, it will call the FindKeyword() method.
| name | The name of the keyword to find. |
Definition at line 155 of file PvlContainer.h.
References Isis::PvlContainer::FindKeyword().
| PvlKeyword& Isis::PvlContainer::operator[] | ( | const char * | name | ) | [inline, inherited] |
When you use the [] operator with a (char) name, it will call the FindKeyword() method.
| name | The name of the keyword to find. |
Definition at line 144 of file PvlContainer.h.
References Isis::PvlContainer::operator[]().
| PvlKeyword & Isis::PvlContainer::operator[] | ( | const int | index | ) | [inherited] |
Return the PvlKeyword object at the specified index.
| index | The index to use. |
| iException::Message | The index is out of bounds. |
Definition at line 188 of file PvlContainer.cpp.
References _FILEINFO_, Isis::Message::ArraySubscriptNotInRange(), Isis::PvlContainer::p_keywords, and Isis::IException::Programmer.
| PvlKeyword& Isis::PvlContainer::operator[] | ( | const QString & | name | ) | [inline, inherited] |
When you use the [] operator with a (string) name, it will call the FindKeyword() method.
| name | The name of the keyword to find. |
Definition at line 134 of file PvlContainer.h.
References Isis::PvlContainer::FindKeyword().
Referenced by Isis::PvlContainer::operator[]().
| void Isis::PvlContainer::SetFileName | ( | const QString & | filename | ) | [inline, protected, inherited] |
Sets the filename to the specified string.
| filename | The new filename to use. |
Definition at line 315 of file PvlContainer.h.
References Isis::PvlContainer::p_filename.
| void Isis::PvlContainer::SetName | ( | const QString & | name | ) | [inline, inherited] |
Set the name of the container.
Definition at line 70 of file PvlContainer.h.
References Isis::PvlContainer::p_name, and Isis::PvlKeyword::SetValue().
Referenced by Isis::Blob::Blob(), Isis::operator>>(), and Isis::PvlContainer::PvlContainer().
| QString Isis::PvlContainer::Type | ( | ) | const [inline, inherited] |
Returns the container type.
Definition at line 93 of file PvlContainer.h.
References Isis::PvlKeyword::Name(), and Isis::PvlContainer::p_name.
Referenced by Isis::PvlObject::DeleteGroup(), Isis::PvlContainer::DeleteKeyword(), Isis::PvlObject::DeleteObject(), and Isis::PvlContainer::FindKeyword().
| void Isis::PvlContainer::ValidateAllKeywords | ( | PvlContainer & | pPvlCont | ) | [protected, inherited] |
Validate All the Keywords in a Container comparing with the Template.
Validate all the PvlKeywords in this container.
| pPvlCont | - Container to be Validated |
Definition at line 410 of file PvlContainer.cpp.
References _FILEINFO_, Isis::PvlContainer::DeleteKeyword(), Isis::PvlContainer::FindKeyword(), Isis::PvlContainer::HasKeyword(), Isis::PvlContainer::Keywords(), Isis::PvlKeyword::Name(), Isis::IException::User, Isis::PvlKeyword::ValidateKeyword(), and Isis::PvlContainer::ValidateRepeatOption().
Referenced by ValidateGroup(), Isis::PvlObject::ValidateObject(), and Isis::Pvl::ValidatePvl().
| 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)
| pPvlGrp | - PvlGroup to be validated |
Definition at line 220 of file PvlGroup.cpp.
References _FILEINFO_, Isis::PvlContainer::Keywords(), Isis::PvlContainer::Name(), Isis::IException::User, and Isis::PvlContainer::ValidateAllKeywords().
Referenced by Isis::PvlObject::ValidateObject(), and Isis::Pvl::ValidatePvl().
| void Isis::PvlContainer::ValidateRepeatOption | ( | PvlKeyword & | pPvlTmplKwrd, | |
| PvlContainer & | pPvlCont | |||
| ) | [protected, inherited] |
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
| pPvlTmplKwrd | - Template Keyword wit | |
| pPvlCont | - Container with all the Keywords |
Definition at line 486 of file PvlContainer.cpp.
References Isis::PvlContainer::DeleteKeyword(), Isis::PvlContainer::FindKeyword(), Isis::PvlContainer::HasKeyword(), Isis::PvlContainer::Keywords(), Isis::PvlKeyword::Name(), and Isis::PvlKeyword::ValidateKeyword().
Referenced by Isis::PvlContainer::ValidateAllKeywords().
QString Isis::PvlContainer::p_filename [protected, inherited] |
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::PvlContainer::DeleteKeyword(), Isis::PvlObject::DeleteObject(), Isis::PvlContainer::FileName(), Isis::PvlObject::FindGroup(), Isis::PvlObject::FindKeyword(), Isis::PvlContainer::FindKeyword(), Isis::PvlObject::FindObject(), Isis::PvlContainer::Init(), Isis::Pvl::Init(), Isis::PvlContainer::operator=(), Isis::Pvl::Read(), and Isis::PvlContainer::SetFileName().
QList<PvlKeyword> Isis::PvlContainer::p_keywords [protected, inherited] |
This is the vector of PvlKeywords the container is holding.
Definition at line 304 of file PvlContainer.h.
Referenced by Isis::PvlContainer::AddKeyword(), Isis::PvlContainer::Begin(), Isis::PvlContainer::CleanDuplicateKeywords(), Isis::PvlContainer::Clear(), Isis::PvlContainer::DeleteKeyword(), Isis::PvlContainer::End(), Isis::PvlContainer::Keywords(), Isis::PvlContainer::operator=(), and Isis::PvlContainer::operator[]().
PvlKeyword Isis::PvlContainer::p_name [protected, inherited] |
This is the name keyword.
Definition at line 303 of file PvlContainer.h.
Referenced by Isis::PvlContainer::IsNamed(), Isis::PvlContainer::Name(), Isis::PvlContainer::operator=(), Isis::PvlContainer::PvlContainer(), Isis::PvlContainer::SetName(), and Isis::PvlContainer::Type().