|
Isis 3.0 Object Programmers' Reference |
Home |
#include <PvlGroup.h>
Inheritance diagram for Isis::PvlGroup:
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 52 of file PvlGroup.h.
Public Types | |
| typedef std::vector< PvlKeyword >::iterator | PvlKeywordIterator |
| The keyword iterator. | |
| typedef std::vector< PvlKeyword >::const_iterator | ConstPvlKeywordIterator |
| The const keyword iterator. | |
| Append | |
| Replace | |
| enum | InsertMode { Append, Replace } |
| Contains both modes: Append or Replace. More... | |
Public Member Functions | |
| PvlGroup () | |
| Creates a blank PvlGroup object. | |
| PvlGroup (const std::string &name) | |
| Creates a PvlGroup object with a name. | |
| PvlGroup (std::vector< Isis::PvlToken > &token, std::vector< Isis::PvlToken >::iterator &pos) | |
| Creates a PvlGroup object using a vector of tokens and an iterator. | |
| bool | operator== (const PvlGroup &group) const |
| Whenever the '==' operator is used on a PvlGroup object, it will call the StringEqual() method. | |
| void | SetName (const std::string &name) |
| Set the name of the container. | |
| std::string | Name () const |
| Returns the container name. | |
| bool | IsNamed (const std::string &match) |
| Returns whether the given string is equal to the container name or not. | |
| std::string | 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 PvlContainer object. | |
| 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 std::string &name) |
| Find a keyword with a specified name. | |
| const PvlKeyword & | FindKeyword (const std::string &name) const |
| Find a keyword with a specified name. | |
| PvlKeywordIterator | FindKeyword (const std::string &name, PvlKeywordIterator beg, PvlKeywordIterator end) |
| Find the index of a keyword, using iterators. | |
| ConstPvlKeywordIterator | FindKeyword (const std::string &name, ConstPvlKeywordIterator beg, ConstPvlKeywordIterator end) const |
| Find the index of a keyword, using iterators. | |
| PvlKeyword & | operator[] (const std::string &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 std::string &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 std::string &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 std::string &name) |
| Remove a specified keyword. | |
| void | DeleteKeyword (const int index) |
| Remove the specified keyword. | |
| void | operator-= (const std::string &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. | |
| std::string | 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 |
| std::string | Comment (const int index) const |
| void | AddComment (const std::string &comment) |
| PvlKeyword & | GetNameKeyword () |
| const PvlKeyword & | GetNameKeyword () const |
Protected Member Functions | |
| void | Init () |
| Sets the filename to blank. | |
| void | SetFilename (const std::string &filename) |
| Sets the filename to the specified string. | |
Protected Attributes | |
| std::string | p_filename |
| This contains the filename used to initialize the pvl object. | |
| PvlKeyword | p_name |
| This is the name keyword. | |
| std::vector< PvlKeyword > | p_keywords |
| This is the vector of PvlKeywords the container is holding. | |
| PvlContainer * | p_formatTemplate |
typedef std::vector<PvlKeyword>::const_iterator Isis::PvlContainer::ConstPvlKeywordIterator [inherited] |
typedef std::vector<PvlKeyword>::iterator Isis::PvlContainer::PvlKeywordIterator [inherited] |
enum Isis::PvlContainer::InsertMode [inherited] |
| Isis::PvlGroup::PvlGroup | ( | ) |
| Isis::PvlGroup::PvlGroup | ( | const std::string & | name | ) |
Creates a PvlGroup object with a name.
| name | The group name. |
Definition at line 34 of file PvlGroup.cpp.
| Isis::PvlGroup::PvlGroup | ( | std::vector< Isis::PvlToken > & | tokens, | |
| std::vector< Isis::PvlToken >::iterator & | pos | |||
| ) |
Creates a PvlGroup object using a vector of tokens and an iterator.
| tokens | The vector of PvlTokens to use. | |
| pos | The iterator to use. |
| iException::Message |
Definition at line 45 of file PvlGroup.cpp.
References _FILEINFO_, Isis::PvlKeyword::AddComments(), Isis::PvlContainer::AddKeyword(), Isis::iException::Message(), Isis::PvlContainer::Name(), Isis::PvlContainer::p_name, Isis::PvlContainer::SetName(), and Isis::PvlKeyword::StringEqual().
| 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 217 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 PvlContainer object.
| keyword | The PvlKeyword object to append. | |
| mode | Using the InsertMode value of Append. |
Definition at line 188 of file PvlContainer.cpp.
References Isis::PvlContainer::FindKeyword(), Isis::PvlContainer::HasKeyword(), Isis::PvlKeyword::Name(), and Isis::PvlContainer::p_keywords.
Referenced by Isis::PvlFormat::Add(), Isis::NaifStatus::CheckErrors(), Isis::CameraFactory::Create(), Isis::ProjectionFactory::CreateForCube(), Isis::GetEnviromentInfo(), Isis::CameraPointInfo::GetPointInfo(), Isis::GetUnameInfo(), Isis::PvlContainer::operator+=(), Isis::operator<<(), Isis::operator>>(), Isis::StripPolygonSeeder::PluginParameters(), Isis::PolygonSeeder::PluginParameters(), Isis::LimitPolygonSeeder::PluginParameters(), Isis::GridPolygonSeeder::PluginParameters(), PvlGroup(), Isis::PvlObject::PvlObject(), and Isis::Stretch::Save().
| ConstPvlKeywordIterator Isis::PvlContainer::Begin | ( | ) | const [inline, inherited] |
Return the const beginning iterator.
Definition at line 174 of file PvlContainer.h.
References Isis::PvlContainer::p_keywords.
| PvlKeywordIterator Isis::PvlContainer::Begin | ( | ) | [inline, inherited] |
Return the beginning iterator.
Definition at line 168 of file PvlContainer.h.
References Isis::PvlContainer::p_keywords.
Referenced by 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().
| void Isis::PvlContainer::Clear | ( | ) | [inline, inherited] |
Clears PvlKeywords.
Reimplemented in Isis::PvlObject.
Definition at line 89 of file PvlContainer.h.
References Isis::PvlContainer::p_keywords.
Referenced by Isis::PvlObject::Clear(), and Isis::Cube::Cube().
| 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 125 of file PvlContainer.cpp.
References _FILEINFO_, Isis::PvlContainer::Begin(), Isis::iException::Message(), Isis::PvlContainer::Name(), Isis::PvlContainer::p_filename, Isis::PvlContainer::p_keywords, and Isis::PvlContainer::Type().
| void Isis::PvlContainer::DeleteKeyword | ( | const std::string & | name | ) | [inherited] |
Remove a specified keyword.
| name | The name of the keyword to remove. |
| iException::Pvl | Keyword doesn't exist. |
Definition at line 107 of file PvlContainer.cpp.
References _FILEINFO_, Isis::PvlContainer::Begin(), Isis::PvlContainer::End(), Isis::PvlContainer::FindKeyword(), Isis::iException::Message(), Isis::PvlContainer::Name(), Isis::PvlContainer::p_filename, Isis::PvlContainer::p_keywords, and Isis::PvlContainer::Type().
Referenced by IsisAml::CommandLine(), Isis::Blob::Find(), Isis::Preference::Load(), Isis::ObliqueCylindrical::ObliqueCylindrical(), Isis::PvlContainer::operator-=(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::Projection::TargetRadii(), Isis::Blob::Write(), and Isis::Table::WriteInit().
| ConstPvlKeywordIterator Isis::PvlContainer::End | ( | ) | const [inline, inherited] |
Return the const ending iterator.
Definition at line 186 of file PvlContainer.h.
References Isis::PvlContainer::p_keywords.
| PvlKeywordIterator Isis::PvlContainer::End | ( | ) | [inline, inherited] |
Return the ending iterator.
Definition at line 180 of file PvlContainer.h.
References Isis::PvlContainer::p_keywords.
Referenced by 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().
| std::string 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 208 of file PvlContainer.h.
References Isis::PvlContainer::p_filename.
Referenced by Isis::PvlObject::AddObject(), Isis::SerialNumber::Compose(), Isis::ObservationNumber::Compose(), Isis::ProjectionFactory::CreateForCube(), Isis::ProjectionFactory::CreateFromCube(), Isis::Mex::HrscCamera::HrscCamera(), Isis::UniversalGroundMap::Init(), Isis::PvlTranslationTable::InputDefault(), Isis::PvlTranslationTable::InputGroup(), Isis::PvlTranslationTable::InputKeyword(), Isis::PvlTranslationManager::InputSize(), Isis::PvlTranslationManager::InputUnits(), Isis::PvlTranslationManager::InputValue(), Isis::PvlTranslationTable::IsAuto(), Isis::PvlTranslationTable::IsOptional(), Isis::PvlTranslationTable::OutputName(), Isis::PvlTranslationTable::OutputPosition(), Isis::StripPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::LimitPolygonSeeder::Parse(), Isis::InterestOperator::Parse(), Isis::GridPolygonSeeder::Parse(), Isis::AutoReg::Parse(), Isis::PvlEditDialog::PvlEditDialog(), Isis::Spice::Spice(), and Isis::PvlTranslationTable::Translate().
| PvlContainer::ConstPvlKeywordIterator Isis::PvlContainer::FindKeyword | ( | const std::string & | 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 350 of file PvlContainer.cpp.
| PvlContainer::PvlKeywordIterator Isis::PvlContainer::FindKeyword | ( | const std::string & | 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 335 of file PvlContainer.cpp.
| const Isis::PvlKeyword & Isis::PvlContainer::FindKeyword | ( | const std::string & | name | ) | const [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 90 of file PvlContainer.cpp.
References _FILEINFO_, Isis::PvlContainer::Begin(), Isis::PvlContainer::End(), Isis::PvlContainer::FindKeyword(), Isis::iException::Message(), Isis::PvlContainer::Name(), Isis::PvlContainer::p_filename, and Isis::PvlContainer::Type().
| Isis::PvlKeyword & Isis::PvlContainer::FindKeyword | ( | const std::string & | 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 72 of file PvlContainer.cpp.
References _FILEINFO_, Isis::PvlContainer::Begin(), Isis::PvlContainer::End(), Isis::iException::Message(), Isis::PvlContainer::Name(), Isis::PvlContainer::p_filename, and Isis::PvlContainer::Type().
Referenced by Isis::PvlContainer::AddKeyword(), Isis::PvlContainer::DeleteKeyword(), Isis::PvlObject::FindKeyword(), Isis::PvlContainer::FindKeyword(), Isis::PvlObject::HasKeyword(), Isis::PvlContainer::HasKeyword(), Isis::PvlTranslationTable::InputGroup(), Isis::Stretch::Load(), Isis::PvlContainer::operator[](), Qisis::MosaicWidget::readProject(), Isis::ReseauDistortionMap::ReseauDistortionMap(), Qisis::MosaicItem::setUpItem(), Isis::ProcessExportPds::StandardAllMapping(), Isis::Projection::TargetRadii(), and Isis::PvlTranslationTable::Translate().
| bool Isis::PvlContainer::HasKeyword | ( | const std::string & | name | ) | const [inherited] |
Check to see if a keyword exists.
| name | The name of the keyword to check for. |
Definition at line 145 of file PvlContainer.cpp.
References Isis::PvlContainer::Begin(), Isis::PvlContainer::End(), and Isis::PvlContainer::FindKeyword().
Referenced by Isis::PvlContainer::AddKeyword(), Isis::Albedo::Albedo(), Isis::AlbedoAtm::AlbedoAtm(), Isis::Anisotropic2::Anisotropic2(), Isis::AtmosModel::AtmosModel(), Isis::Camera::Camera(), Isis::CameraFactory::CameraVersion(), IsisAml::CommandLine(), Isis::CameraFactory::Create(), Isis::Equirectangular::Equirectangular(), Isis::Filename::Expand(), KernelDb::FindAll(), Isis::Camera::GroundRange(), Isis::HapkeAtm1::HapkeAtm1(), Isis::HapkeAtm2::HapkeAtm2(), Isis::HapkeHen::HapkeHen(), Isis::HapkePhotoModel::HapkePhotoModel(), Isis::Spice::HasKernels(), HiLab::HiLab(), Isis::IdealCamera::IdealCamera(), Isis::PvlTranslationTable::InputDefault(), Isis::PvlTranslationTable::InputGroup(), Isis::PvlTranslationManager::InputHasKeyword(), Isis::PvlTranslationTable::InputKeyword(), Isis::PvlTranslationManager::InputSize(), Isis::PvlTranslationManager::InputUnits(), Isis::PvlTranslationManager::InputValue(), Isis::PvlTranslationTable::IsAuto(), Isis::PvlTranslationTable::IsOptional(), Isis::Isotropic1::Isotropic1(), Isis::Isotropic2::Isotropic2(), Isis::LambertConformal::LambertConformal(), Isis::Preference::Load(), Isis::Lo::LoMediumCamera::LoMediumCamera(), Isis::LunarLambert::LunarLambert(), Isis::Projection::Mapping(), Isis::Mercator::Mercator(), Isis::iException::Message(), Isis::Minnaert::Minnaert(), Isis::Mixed::Mixed(), Isis::MoonAlbedo::MoonAlbedo(), Isis::ObliqueCylindrical::ObliqueCylindrical(), Isis::operator<<(), Isis::Orthographic::Orthographic(), Isis::PvlTranslationTable::OutputName(), Isis::PvlTranslationTable::OutputPosition(), Isis::StripPolygonSeeder::Parse(), Isis::PolygonSeeder::Parse(), Isis::LimitPolygonSeeder::Parse(), Isis::InterestOperator::Parse(), Isis::GridPolygonSeeder::Parse(), Isis::AutoReg::Parse(), Isis::PhotoModel::PhotoModel(), Isis::PointPerspective::PointPerspective(), Isis::PolarStereographic::PolarStereographic(), Isis::Projection::Projection(), Isis::Mgs::MocLabels::ReadLabels(), Isis::AutoReg::RegTemplate(), Isis::Sensor::Sensor(), Isis::ProcessMapMosaic::SetOutputCube(), Qisis::MosaicItem::setUpItem(), Isis::Shade::Shade(), Isis::ShadeAtm::ShadeAtm(), Isis::SimpleCylindrical::SimpleCylindrical(), Isis::Sinusoidal::Sinusoidal(), Isis::Spice::Spice(), Isis::Projection::TargetRadii(), Isis::Odyssey::ThemisIrCamera::ThemisIrCamera(), Isis::Topo::Topo(), Isis::TopoAtm::TopoAtm(), Isis::PvlTranslationTable::Translate(), Isis::PvlTranslationManager::Translate(), Isis::ProcessImportPds::TranslateIsis2Instrument(), and Isis::TransverseMercator::TransverseMercator().
| void Isis::PvlContainer::Init | ( | ) | [protected, inherited] |
Sets the filename to blank.
Reimplemented in Isis::Pvl.
Definition at line 60 of file PvlContainer.cpp.
References Isis::PvlContainer::p_filename, and Isis::PvlContainer::p_formatTemplate.
Referenced by Isis::PvlContainer::PvlContainer().
| bool Isis::PvlContainer::IsNamed | ( | const std::string & | match | ) | [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 74 of file PvlContainer.h.
References Isis::PvlContainer::p_name, and Isis::PvlKeyword::StringEqual().
Referenced by Isis::IsBlob(), Isis::ControlPoint::Load(), Isis::ControlNet::ReadControl(), Isis::Table::ReadInit(), Isis::Process::SetOutputCube(), and Isis::Gui::UpdateHistory().
| int Isis::PvlContainer::Keywords | ( | ) | const [inline, inherited] |
Returns the number of keywords contained in the PvlContainer.
Definition at line 86 of file PvlContainer.h.
References Isis::PvlContainer::p_keywords.
Referenced by Isis::PvlFormat::Add(), Isis::ObservationNumber::FindObservationTranslation(), Isis::SerialNumber::FindSerialTranslation(), KernelDb::GetFile(), Isis::operator<<(), Isis::Gui::UpdateHistory(), and Qisis::PlotTool::updateTool().
| std::string Isis::PvlContainer::Name | ( | ) | const [inline, inherited] |
Returns the container name.
Definition at line 67 of file PvlContainer.h.
References Isis::PvlContainer::p_name.
Referenced by Isis::PvlFormat::Add(), Isis::PvlObject::DeleteGroup(), Isis::PvlContainer::DeleteKeyword(), Isis::PvlObject::DeleteObject(), Isis::UserInterface::EvaluateOption(), Isis::PvlContainer::FindKeyword(), KernelDb::GetFile(), Isis::PvlTranslationTable::InputGroup(), Isis::operator<<(), Isis::PvlObject::operator==(), operator==(), Isis::Cube::PutGroup(), PvlGroup(), Isis::PvlObject::PvlObject(), Isis::Process::SetOutputCube(), 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 106 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 202 of file PvlContainer.h.
References Isis::PvlContainer::DeleteKeyword(), and Isis::PvlKeyword::Name().
| void Isis::PvlContainer::operator-= | ( | const std::string & | 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 196 of file PvlContainer.h.
References Isis::PvlContainer::DeleteKeyword().
| 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 66 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 141 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 173 of file PvlContainer.cpp.
References _FILEINFO_, Isis::Message::ArraySubscriptNotInRange(), Isis::iException::Message(), and Isis::PvlContainer::p_keywords.
| const PvlKeyword& Isis::PvlContainer::operator[] | ( | const std::string & | 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 133 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 122 of file PvlContainer.h.
References Isis::PvlContainer::operator[]().
| Isis::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 158 of file PvlContainer.cpp.
References _FILEINFO_, Isis::Message::ArraySubscriptNotInRange(), Isis::iException::Message(), and Isis::PvlContainer::p_keywords.
| PvlKeyword& Isis::PvlContainer::operator[] | ( | const std::string & | 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 114 of file PvlContainer.h.
References Isis::PvlContainer::FindKeyword().
Referenced by Isis::PvlContainer::operator[]().
| void Isis::PvlContainer::SetFilename | ( | const std::string & | filename | ) | [inline, protected, inherited] |
Sets the filename to the specified string.
| filename | The new filename to use. |
Definition at line 249 of file PvlContainer.h.
References Isis::PvlContainer::p_filename.
| void Isis::PvlContainer::SetName | ( | const std::string & | name | ) | [inline, inherited] |
Set the name of the container.
Definition at line 62 of file PvlContainer.h.
References Isis::PvlContainer::p_name, and Isis::PvlKeyword::SetValue().
Referenced by Isis::Blob::Blob(), Isis::PvlContainer::PvlContainer(), PvlGroup(), and Isis::PvlObject::PvlObject().
| std::string Isis::PvlContainer::Type | ( | ) | const [inline, inherited] |
Returns the container type.
Definition at line 81 of file PvlContainer.h.
References Isis::PvlKeyword::Name(), and Isis::PvlContainer::p_name.
Referenced by Isis::PvlObject::DeleteGroup(), Isis::PvlContainer::DeleteKeyword(), Isis::PvlObject::DeleteObject(), Isis::PvlContainer::FindKeyword(), and Isis::operator<<().
std::string 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 231 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::Pvl::Read(), and Isis::PvlContainer::SetFilename().
std::vector<PvlKeyword> Isis::PvlContainer::p_keywords [protected, inherited] |
This is the vector of PvlKeywords the container is holding.
Definition at line 238 of file PvlContainer.h.
Referenced by Isis::PvlContainer::AddKeyword(), Isis::PvlContainer::Begin(), Isis::PvlContainer::Clear(), Isis::PvlContainer::DeleteKeyword(), Isis::PvlContainer::End(), Isis::PvlContainer::Keywords(), and Isis::PvlContainer::operator[]().
PvlKeyword Isis::PvlContainer::p_name [protected, inherited] |
This is the name keyword.
Definition at line 237 of file PvlContainer.h.
Referenced by Isis::PvlContainer::AddComment(), Isis::PvlContainer::Comment(), Isis::PvlContainer::Comments(), Isis::PvlContainer::GetFormat(), Isis::PvlContainer::GetNameKeyword(), Isis::PvlContainer::Indent(), Isis::PvlContainer::IsNamed(), Isis::PvlContainer::Name(), Isis::PvlContainer::PvlContainer(), PvlGroup(), Isis::PvlObject::PvlObject(), Isis::PvlContainer::SetFormat(), Isis::PvlContainer::SetIndent(), Isis::PvlContainer::SetName(), and Isis::PvlContainer::Type().