Isis 3.0 Developer's Reference (API) |
Home |
Contains multiple PvlContainers. More...
#include <PvlGroup.h>
Inherits Isis::PvlContainer.
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 std::string &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 std::string &name) |
Set the name of the container. | |
std::string | Name () const |
Returns the container name. | |
bool | IsNamed (const std::string &match) const |
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 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 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. | |
bool | CleanDuplicateKeywords () |
Removes keywords from the container that have BOTH the same name and value. | |
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. | |
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 | |
std::string | 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) |
Read in a group. | |
std::ostream & | operator<< (std::ostream &os, PvlGroup &group) |
Outputs the PvlGroup data to a specified output stream. |
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.
typedef QList<PvlKeyword>::const_iterator Isis::PvlContainer::ConstPvlKeywordIterator [inherited] |
The const keyword iterator.
typedef QList<PvlKeyword>::iterator Isis::PvlContainer::PvlKeywordIterator [inherited] |
The keyword iterator.
enum Isis::PvlContainer::InsertMode [inherited] |
Isis::PvlGroup::PvlGroup | ( | ) |
Creates a blank PvlGroup object.
Isis::PvlGroup::PvlGroup | ( | const std::string & | name | ) |
Creates a PvlGroup object with a name.
name | The group name. |
Isis::PvlGroup::PvlGroup | ( | const PvlGroup & | other | ) |
Copy constructor.
void Isis::PvlContainer::AddComment | ( | const std::string & | comment | ) | [inline, inherited] |
References Isis::PvlKeyword::AddComment(), and Isis::PvlContainer::p_name.
Referenced by Isis::operator<<(), Isis::operator>>(), Isis::Equalization::setResults(), and Isis::ControlNetFileV0002::Write().
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 |
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. |
References Isis::PvlContainer::Append, Isis::PvlContainer::FindKeyword(), Isis::PvlContainer::HasKeyword(), Isis::PvlKeyword::Name(), and Isis::PvlContainer::p_keywords.
Referenced by Isis::PvlFormat::Add(), Isis::ProjectionFactory::CreateForCube(), Isis::PvlContainer::operator+=(), Isis::operator<<(), Isis::operator>>(), Isis::StripPolygonSeeder::PluginParameters(), Isis::LimitPolygonSeeder::PluginParameters(), Isis::GridPolygonSeeder::PluginParameters(), Isis::Stretch::Save(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::Projection::SetUpperLeftCorner(), Isis::Spice::storeValue(), 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.
References Isis::PvlContainer::p_keywords.
PvlKeywordIterator Isis::PvlContainer::Begin | ( | ) | [inline, inherited] |
Return the beginning iterator.
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(), and Isis::PvlTranslationTable::Translate().
bool Isis::PvlContainer::CleanDuplicateKeywords | ( | ) | [inherited] |
Removes keywords from the container that have BOTH the same name and value.
References Isis::PvlContainer::Begin(), Isis::PvlContainer::End(), and Isis::PvlContainer::p_keywords.
void Isis::PvlContainer::Clear | ( | ) | [inline, inherited] |
Clears PvlKeywords.
Reimplemented in Isis::PvlObject.
References Isis::PvlContainer::p_keywords.
Referenced by Isis::Cube::open().
std::string Isis::PvlContainer::Comment | ( | const int | index | ) | const [inline, inherited] |
References Isis::PvlKeyword::Comment(), and Isis::PvlContainer::p_name.
Referenced by Isis::operator<<().
int Isis::PvlContainer::Comments | ( | ) | const [inline, inherited] |
References Isis::PvlKeyword::Comments(), and Isis::PvlContainer::p_name.
Referenced by Isis::operator<<().
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. |
References _FILEINFO_, Isis::PvlContainer::Begin(), Isis::iException::Message(), Isis::PvlContainer::Name(), Isis::PvlContainer::p_filename, Isis::PvlContainer::p_keywords, Isis::iException::Pvl, 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. |
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, Isis::iException::Pvl, and Isis::PvlContainer::Type().
Referenced by Isis::PvlFormat::Add(), IsisAml::CommandLine(), Isis::Preference::Load(), Isis::ObliqueCylindrical::ObliqueCylindrical(), Isis::PvlContainer::operator-=(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::Projection::TargetRadii(), Isis::SubArea::UpdateLabel(), Isis::PvlContainer::ValidateAllKeywords(), and Isis::PvlContainer::ValidateRepeatOption().
ConstPvlKeywordIterator Isis::PvlContainer::End | ( | ) | const [inline, inherited] |
Return the const ending iterator.
References Isis::PvlContainer::p_keywords.
PvlKeywordIterator Isis::PvlContainer::End | ( | ) | [inline, inherited] |
Return the ending iterator.
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(), 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.
References Isis::PvlContainer::p_filename.
Referenced by Isis::PvlObject::AddObject(), Isis::SerialNumber::Compose(), Isis::ProjectionFactory::Create(), Isis::ProjectionFactory::CreateForCube(), Isis::ProjectionFactory::CreateFromCube(), Isis::DawnVirCamera::DawnVirCamera(), Isis::HrscCamera::HrscCamera(), Isis::PvlTranslationTable::InputDefault(), Isis::PvlTranslationTable::InputGroup(), Isis::PvlTranslationManager::InputKeyword(), Isis::PvlTranslationTable::InputKeywordName(), Isis::PvlTranslationTable::IsAuto(), Isis::PvlTranslationTable::IsOptional(), Isis::PvlTranslationTable::OutputName(), Isis::PvlTranslationTable::OutputPosition(), Isis::AutoReg::Parse(), Isis::PvlEditDialog::PvlEditDialog(), Isis::PvlTranslationTable::Translate(), and Isis::UniversalGroundMap::UniversalGroundMap().
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. |
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. |
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. |
References _FILEINFO_, Isis::PvlContainer::Begin(), Isis::PvlContainer::End(), Isis::PvlContainer::FindKeyword(), Isis::iException::Message(), Isis::PvlContainer::Name(), Isis::PvlContainer::p_filename, Isis::iException::Pvl, 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. |
References _FILEINFO_, Isis::PvlContainer::Begin(), Isis::PvlContainer::End(), Isis::iException::Message(), Isis::PvlContainer::Name(), Isis::PvlContainer::p_filename, Isis::iException::Pvl, and Isis::PvlContainer::Type().
Referenced by Isis::PvlContainer::AddKeyword(), Isis::MosaicSceneWidget::addToPermanent(), Isis::ApolloMetricCamera::ApolloMetricCamera(), Isis::CubeIoHandler::CubeIoHandler(), Isis::PvlContainer::DeleteKeyword(), Isis::PvlContainer::FindKeyword(), Isis::CubeViewport::getBandFilterName(), Isis::PvlContainer::HasKeyword(), Isis::PvlTranslationTable::InputGroup(), Isis::PvlTranslationManager::InputKeyword(), Isis::Stretch::Load(), Isis::ProcessMosaic::MatchDEMShapeModel(), Isis::PvlContainer::operator[](), Isis::SpectralPlotTool::refreshPlot(), Isis::ReseauDistortionMap::ReseauDistortionMap(), Isis::MosaicSceneWidget::setProjection(), Isis::Projection::TargetRadii(), Isis::PvlTranslationTable::Translate(), Isis::PvlContainer::ValidateAllKeywords(), Isis::PvlObject::ValidateObject(), Isis::Pvl::ValidatePvl(), and Isis::PvlContainer::ValidateRepeatOption().
PvlContainer* Isis::PvlContainer::FormatTemplate | ( | ) | [inline, inherited] |
References Isis::PvlContainer::p_formatTemplate.
Referenced by Isis::operator<<().
PvlFormat* Isis::PvlContainer::GetFormat | ( | ) | [inline, inherited] |
References Isis::PvlKeyword::GetFormat(), and Isis::PvlContainer::p_name.
Referenced by Isis::Pvl::Append(), Isis::operator<<(), and Isis::Pvl::Write().
const PvlKeyword& Isis::PvlContainer::GetNameKeyword | ( | ) | const [inline, inherited] |
References Isis::PvlContainer::p_name.
PvlKeyword& Isis::PvlContainer::GetNameKeyword | ( | ) | [inline, inherited] |
References Isis::PvlContainer::p_name.
Referenced by Isis::operator<<().
bool Isis::PvlContainer::HasFormatTemplate | ( | ) | [inline, inherited] |
References Isis::PvlContainer::p_formatTemplate.
Referenced by Isis::operator<<().
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. |
References Isis::PvlContainer::Begin(), Isis::PvlContainer::End(), and Isis::PvlContainer::FindKeyword().
Referenced by Isis::PvlContainer::AddKeyword(), Isis::PvlTranslationTable::AddTable(), Isis::AlbedoAtm::AlbedoAtm(), Isis::AtmosModel::AtmosModel(), Isis::Camera::Camera(), IsisAml::CommandLine(), Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Isis::Equirectangular::Equirectangular(), KernelDb::FindAll(), Isis::CubeViewport::getBandFilterName(), Isis::GroundGrid::GroundGrid(), Isis::Camera::GroundRange(), Isis::Hapke::Hapke(), Isis::Spice::HasKernels(), HiLab::HiLab(), Isis::IdealCamera::IdealCamera(), Isis::PvlTranslationTable::InputDefault(), Isis::PvlTranslationManager::InputHasKeyword(), Isis::PvlTranslationManager::InputKeyword(), Isis::PvlTranslationTable::InputKeywordName(), Isis::PvlTranslationTable::IsAuto(), Isis::PvlTranslationTable::IsOptional(), Isis::LambertConformal::LambertConformal(), Isis::Preference::Load(), Isis::LoMediumCamera::LoMediumCamera(), Isis::Projection::Mapping(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::ProcessMosaic::MatchDEMShapeModel(), KernelDb::Matches(), Isis::Mercator::Mercator(), Isis::iException::Message(), Isis::ObliqueCylindrical::ObliqueCylindrical(), Isis::Orthographic::Orthographic(), Isis::PvlTranslationTable::OutputName(), Isis::PvlTranslationTable::OutputPosition(), 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::SpectralPlotTool::refreshPlot(), Isis::AutoReg::RegTemplate(), Isis::Sensor::Sensor(), Isis::ProcessMapMosaic::SetOutputCube(), Isis::Shade::Shade(), Isis::ShadeAtm::ShadeAtm(), Isis::SimpleCylindrical::SimpleCylindrical(), Isis::Sinusoidal::Sinusoidal(), Isis::Projection::TargetRadii(), Isis::Filename::Temporary(), Isis::ThemisIrCamera::ThemisIrCamera(), Isis::Topo::Topo(), Isis::TopoAtm::TopoAtm(), Isis::ControlNetFileV0002::ToPvl(), Isis::PvlTranslationTable::Translate(), Isis::PvlTranslationManager::Translate(), 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().
int Isis::PvlContainer::Indent | ( | ) | [inline, inherited] |
References Isis::PvlKeyword::Indent(), and Isis::PvlContainer::p_name.
Referenced by Isis::operator<<().
void Isis::PvlContainer::Init | ( | ) | [protected, inherited] |
Sets the filename to blank.
References Isis::PvlContainer::p_filename, and Isis::PvlContainer::p_formatTemplate.
Referenced by Isis::PvlContainer::PvlContainer().
bool Isis::PvlContainer::IsNamed | ( | const std::string & | 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. |
References Isis::PvlContainer::p_name, and Isis::PvlKeyword::StringEqual().
Referenced by KernelDb::FindAll(), Isis::Cube::hasTable(), Isis::IsBlob(), Isis::Process::SetOutputCube(), and Isis::Process::WriteHistory().
int Isis::PvlContainer::Keywords | ( | ) | const [inline, inherited] |
Returns the number of keywords contained in the PvlContainer.
References Isis::PvlContainer::p_keywords.
Referenced by Isis::PvlFormat::Add(), Isis::ProcessMosaic::AddBandBinGroup(), Isis::PvlTranslationTable::AddTable(), KernelDb::FindAll(), Isis::MosaicSceneWidget::fromPvl(), Isis::Preference::Load(), Isis::ProcessMosaic::MatchBandBinGroup(), KernelDb::Matches(), Isis::Cube::open(), Isis::operator<<(), Isis::ControlNetFilter::PointCubeNamesFilter(), Isis::PvlContainer::ValidateAllKeywords(), ValidateGroup(), Isis::PvlObject::ValidateObject(), Isis::Pvl::ValidatePvl(), and Isis::PvlContainer::ValidateRepeatOption().
std::string Isis::PvlContainer::Name | ( | ) | const [inline, inherited] |
Returns the container name.
References Isis::PvlContainer::p_name.
Referenced by Isis::PvlTranslationTable::AddTable(), Isis::PvlTranslationManager::Auto(), Isis::Cube::deleteBlob(), Isis::PvlObject::DeleteGroup(), Isis::PvlContainer::DeleteKeyword(), Isis::PvlObject::DeleteObject(), Isis::PvlContainer::FindKeyword(), Isis::Preference::Load(), Isis::ProcessMosaic::MatchBandBinGroup(), Isis::operator<<(), Isis::PvlObject::operator==(), operator==(), Isis::operator>>(), Isis::Cube::putGroup(), Isis::Process::SetOutputCube(), ValidateGroup(), Isis::PvlObject::ValidateObject(), and Isis::Pvl::ValidatePvl().
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. |
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. |
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. |
References Isis::PvlContainer::DeleteKeyword().
This is an assignment 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.
group | The PvlGroup object to compare. |
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. |
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. |
References _FILEINFO_, Isis::Message::ArraySubscriptNotInRange(), Isis::iException::Message(), Isis::PvlContainer::p_keywords, and Isis::iException::Programmer.
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. |
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. |
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. |
References _FILEINFO_, Isis::Message::ArraySubscriptNotInRange(), Isis::iException::Message(), Isis::PvlContainer::p_keywords, and Isis::iException::Programmer.
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. |
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. |
References Isis::PvlContainer::p_filename.
void Isis::PvlContainer::SetFormat | ( | PvlFormat * | format | ) | [inline, inherited] |
References Isis::PvlContainer::p_name, and Isis::PvlKeyword::SetFormat().
Referenced by Isis::Pvl::Append(), Isis::operator<<(), and Isis::Pvl::Write().
void Isis::PvlContainer::SetFormatTemplate | ( | PvlContainer & | ref | ) | [inline, inherited] |
References Isis::PvlContainer::p_formatTemplate.
Referenced by Isis::operator<<().
void Isis::PvlContainer::SetIndent | ( | int | indent | ) | [inline, inherited] |
References Isis::PvlContainer::p_name, and Isis::PvlKeyword::SetIndent().
Referenced by Isis::operator<<().
void Isis::PvlContainer::SetName | ( | const std::string & | name | ) | [inline, inherited] |
Set the name of the container.
References Isis::PvlContainer::p_name, and Isis::PvlKeyword::SetValue().
Referenced by Isis::operator>>(), Isis::PvlContainer::PvlContainer(), and Isis::MosaicSceneWidget::toPvl().
std::string Isis::PvlContainer::Type | ( | ) | const [inline, inherited] |
Returns the container type.
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 |
References _FILEINFO_, Isis::PvlContainer::DeleteKeyword(), Isis::PvlContainer::FindKeyword(), Isis::PvlContainer::HasKeyword(), Isis::PvlContainer::Keywords(), Isis::iException::Message(), 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 |
References _FILEINFO_, Isis::PvlContainer::Keywords(), Isis::iException::Message(), 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 |
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().
std::ostream& operator<< | ( | std::ostream & | os, | |
PvlGroup & | group | |||
) | [friend] |
std::istream& operator>> | ( | std::istream & | is, | |
PvlGroup & | result | |||
) | [friend] |
Read in a group.
is | The input stream | |
result | The PvlGroup to read into (OUTPUT) |
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.
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::PvlContainer::operator=(), Isis::Pvl::Read(), and Isis::PvlContainer::SetFilename().
PvlContainer* Isis::PvlContainer::p_formatTemplate [protected, inherited] |
QList<PvlKeyword> Isis::PvlContainer::p_keywords [protected, inherited] |
This is the vector of PvlKeywords the container is holding.
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.
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::operator=(), Isis::PvlContainer::PvlContainer(), Isis::PvlContainer::SetFormat(), Isis::PvlContainer::SetIndent(), Isis::PvlContainer::SetName(), and Isis::PvlContainer::Type().