Isis Developer Reference
PvlGroup.h
Go to the documentation of this file.
1 #ifndef PvlGroup_h
2 #define PvlGroup_h
3 
8 /* SPDX-License-Identifier: CC0-1.0 */
9 #include "PvlContainer.h"
10 
11 namespace Isis {
41  class PvlGroup : public Isis::PvlContainer {
42  public:
43  PvlGroup();
44  PvlGroup(const QString &name);
45  PvlGroup(const PvlGroup &other);
46 
48  void validateGroup(PvlGroup & pPvlGrp);
49 
50  friend std::istream &operator>>(std::istream &is, PvlGroup &result);
51  friend std::ostream &operator<<(std::ostream &os, PvlGroup &group);
59  bool operator==(const PvlGroup &group) const {
60  return PvlKeyword::stringEqual(group.name(), this->name());
61  };
62 
63  const PvlGroup &operator=(const PvlGroup &other);
64  };
65 }
66 #endif
Isis::PvlGroup::operator=
const PvlGroup & operator=(const PvlGroup &other)
This is an assignment operator.
Definition: PvlGroup.cpp:190
Isis::operator<<
QDebug operator<<(QDebug debug, const Hillshade &hillshade)
Print this class out to a QDebug object.
Definition: Hillshade.cpp:314
Isis::PvlContainer::operator=
const PvlContainer & operator=(const PvlContainer &other)
This is an assignment operator.
Definition: PvlContainer.cpp:375
Isis::PvlKeyword
A single keyword-value pair.
Definition: PvlKeyword.h:82
Isis::PvlFormat
Formats a Pvl name value pair to Isis standards.
Definition: PvlFormat.h:108
Isis::PvlFormat::formatEnd
virtual QString formatEnd(const QString name, const PvlKeyword &keyword)
Definition: PvlFormat.cpp:215
Isis::PvlContainer::comment
QString comment(const int index) const
Definition: PvlContainer.h:265
Isis::PvlContainer::setName
void setName(const QString &name)
Set the name of the container.
Definition: PvlContainer.h:56
Isis::PvlContainer::addKeyword
void addKeyword(const PvlKeyword &keyword, const InsertMode mode=Append)
Add a keyword to the container.
Definition: PvlContainer.cpp:202
Isis::IException::Unknown
@ Unknown
A type of error that cannot be classified as any of the other error types.
Definition: IException.h:118
PvlGroup.h
Isis::PvlGroup::operator==
bool operator==(const PvlGroup &group) const
Whenever the '==' operator is used on a PvlGroup object, it will call the stringEqual() method.
Definition: PvlGroup.h:59
Isis::PvlKeyword::clear
void clear()
Clears all values and units for this PvlKeyword object.
Definition: PvlKeyword.cpp:291
Isis::PvlContainer::nameKeyword
PvlKeyword & nameKeyword()
Definition: PvlContainer.h:273
PvlFormat.h
Isis::PvlContainer::validateAllKeywords
void validateAllKeywords(PvlContainer &pPvlCont)
Validate All the Keywords in a Container comparing with the Template.
Definition: PvlContainer.cpp:394
Isis::PvlContainer::setFormat
void setFormat(PvlFormat *format)
Definition: PvlContainer.h:251
Isis::PvlGroup
Contains multiple PvlContainers.
Definition: PvlGroup.h:41
_FILEINFO_
#define _FILEINFO_
Macro for the filename and line number.
Definition: IException.h:24
Isis::PvlGroup::operator<<
friend std::ostream & operator<<(std::ostream &os, PvlGroup &group)
Outputs the PvlGroup data to a specified output stream.
Definition: PvlGroup.cpp:145
Isis::PvlContainer::hasFormatTemplate
bool hasFormatTemplate()
Definition: PvlContainer.h:240
Isis::PvlContainer::indent
int indent()
Definition: PvlContainer.h:255
Isis::PvlGroup::validateGroup
void validateGroup(PvlGroup &pPvlGrp)
Validate a Group comparing with the Template Group.
Definition: PvlGroup.cpp:207
Isis::PvlFormat::formatEOL
virtual QString formatEOL()
Definition: PvlFormat.h:147
Isis::PvlContainer::name
QString name() const
Returns the container name.
Definition: PvlContainer.h:63
Isis::IException
Isis exception class.
Definition: IException.h:91
Isis::PvlContainer::addComment
void addComment(const QString &comment)
Definition: PvlContainer.h:269
Isis::PvlContainer::format
PvlFormat * format()
Definition: PvlContainer.h:248
Isis::PvlContainer::comments
int comments() const
Definition: PvlContainer.h:262
PvlContainer.h
IException.h
std
Namespace for the standard library.
Isis::PvlContainer::formatTemplate
PvlContainer * formatTemplate()
Definition: PvlContainer.h:244
Isis::PvlGroup::PvlGroup
PvlGroup()
Creates a blank PvlGroup object.
Definition: PvlGroup.cpp:16
PvlKeyword.h
Isis::PvlContainer::keywords
int keywords() const
Returns the number of keywords contained in the PvlContainer.
Definition: PvlContainer.h:86
Isis::PvlContainer::setIndent
void setIndent(int indent)
Definition: PvlContainer.h:258
Isis::PvlGroup::operator>>
friend std::istream & operator>>(std::istream &is, PvlGroup &result)
Read in a group.
Definition: PvlGroup.cpp:38
Isis::PvlContainer
Contains more than one keyword-value pair.
Definition: PvlContainer.h:49
Isis::operator>>
std::istream & operator>>(std::istream &is, CSVReader &csv)
Input read operator for input stream sources.
Definition: CSVReader.cpp:447
Isis::PvlKeyword::stringEqual
static bool stringEqual(const QString &string1, const QString &string2)
Checks to see if two QStrings are equal.
Definition: PvlKeyword.cpp:535
Isis
This is free and unencumbered software released into the public domain.
Definition: Apollo.h:16
Isis::IException::User
@ User
A type of error that could only have occurred due to a mistake on the user's part (e....
Definition: IException.h:126