Isis Developer Reference
Isis::PvlKeyword Class Reference

A single keyword-value pair. More...

#include <PvlKeyword.h>

Collaboration diagram for Isis::PvlKeyword:
Collaboration graph

Public Member Functions

 PvlKeyword ()
 Constructs a blank PvlKeyword object. More...
 
 PvlKeyword (QString name)
 Constructs a PvlKeyword object with a name. More...
 
 PvlKeyword (QString name, QString value, QString unit="")
 Constructs a PvlKeyword object with a name, value and units. More...
 
 PvlKeyword (const PvlKeyword &other)
 Copy constructor. More...
 
 ~PvlKeyword ()
 Destructs a PvlKeyword object. More...
 
void setName (QString name)
 Sets the keyword name. More...
 
QString name () const
 Returns the keyword name. More...
 
bool isNamed (QString name) const
 Determines whether two PvlKeywords have the same name or not. More...
 
void setValue (QString value, QString unit="")
 Sets new values. More...
 
void setUnits (QString units)
 Sets the unit of measure for all current values if any exist. More...
 
void setUnits (QString value, QString units)
 Sets the unit of measure for a given value. More...
 
PvlKeywordoperator= (QString value)
 Sets new values. More...
 
void addValue (QString value, QString unit="")
 Adds a value with units. More...
 
PvlKeywordoperator+= (QString value)
 Adds a value. More...
 
int size () const
 Returns the number of values stored in this keyword. More...
 
bool isNull (const int index=0) const
 Decides whether a value is null or not at a given index. More...
 
void clear ()
 Clears all values and units for this PvlKeyword object. More...
 
 operator double () const
 Returns the first value in this keyword converted to a double. More...
 
 operator int () const
 Returns the first value in this keyword converted to an integer. More...
 
 operator Isis::BigInt () const
 Returns the first value in this keyword converted to a BigInt. More...
 
 operator QString () const
 
const QString & operator[] (int index) const
 Gets value for this object at specified index. More...
 
QString & operator[] (int index)
 Gets value for this object at specified index. More...
 
QString unit (const int index=0) const
 Returns the units of measurement of the element of the array of values for the object at the specified index. More...
 
void addComment (QString comment)
 Add a comment to the PvlKeyword. More...
 
void addCommentWrapped (QString comment)
 Automatically wraps and adds long comments to the PvlKeyword. More...
 
void addComments (const std::vector< QString > &comments)
 This method adds multiple comments at once by calling AddComments on each element in the vector. More...
 
int comments () const
 Returns the number of lines of comments associated with this keyword. More...
 
QString comment (const int index) const
 Return a comment at the specified index. More...
 
void clearComment ()
 Clears the current comments. More...
 
bool operator== (const PvlKeyword &key) const
 Returns true of the keyword names match. More...
 
bool operator!= (const PvlKeyword &key) const
 Returns true of the keyword names do not match. More...
 
bool isEquivalent (QString string1, int index=0) const
 Checks to see if a value with a specified index is equivalent to another QString. More...
 
void setWidth (int width)
 The width of the longest keyword name (for formatting) More...
 
void setIndent (int indent)
 Sets the indent level when outputted(for formatting) More...
 
int width () const
 Returns the current set longest keyword name. More...
 
int indent () const
 Returns the current indent level. More...
 
PvlKeywordoperator= (Isis::PvlSequence &seq)
 Add values and units from a PvlSequence. More...
 
void setFormat (PvlFormat *formatter)
 Set the PvlFormatter used to format the keyword name and value(s) More...
 
PvlFormatformat ()
 Get the current PvlFormat or create one. More...
 
const PvlKeywordoperator= (const PvlKeyword &other)
 This is an assignment operator. More...
 
void validateKeyword (PvlKeyword &pvlKwrd, QString psValueType="", PvlKeyword *pvlKwrdRange=NULL)
 Validate Keyword for type and required values. More...
 

Static Public Member Functions

static bool stringEqual (const QString &string1, const QString &string2)
 Checks to see if two QStrings are equal. More...
 
static QString readLine (std::istream &is, bool insideComment)
 This method reads one line of data from the input stream. More...
 
static bool readCleanKeyword (QString keyword, std::vector< QString > &keywordComments, QString &keywordName, std::vector< std::pair< QString, QString > > &keywordValues)
 This reads a keyword compressed back to 1 line of data (excluding comments, which are included on separate lines of data before the keyword). More...
 
static QString readValue (QString &keyword, bool &quoteProblem)
 
static QString readValue (QString &keyword, bool &quoteProblem, const std::vector< std::pair< char, char > > &otherDelimiters)
 This method looks for a data element in the QString. More...
 

Protected Member Functions

QString reform (const QString &value) const
 Checks if the value needs to be converted to PVL or iPVL and returns it in the correct format. More...
 
QString toPvl (const QString &value) const
 Converts a value to PVL format. More...
 
QString toIPvl (const QString &value) const
 Converts a value to iPVL format. More...
 
std::ostream & writeWithWrap (std::ostream &os, const QString &textToWrite, int startColumn, PvlFormat &format) const
 Wraps output so that length doesn't exceed the character limit. More...
 

Protected Attributes

PvlFormatm_formatter
 Formatter object. More...
 

Friends

std::istream & operator>> (std::istream &is, PvlKeyword &result)
 Read in a keyword. More...
 
std::ostream & operator<< (std::ostream &os, const PvlKeyword &keyword)
 Write out the keyword. More...
 

Detailed Description

A single keyword-value pair.

This class is used to create a single PVL keyword-value pair. PvlContainer can combine PvlKeyword objects and organize them so they look clean on output.

Author
2002-10-11 Jeff Anderson

Constructor & Destructor Documentation

◆ PvlKeyword() [1/4]

Isis::PvlKeyword::PvlKeyword ( )

Constructs a blank PvlKeyword object.

◆ PvlKeyword() [2/4]

Isis::PvlKeyword::PvlKeyword ( QString  name)

Constructs a PvlKeyword object with a name.

Parameters
nameThe keyword name

◆ PvlKeyword() [3/4]

Isis::PvlKeyword::PvlKeyword ( QString  name,
QString  value,
QString  unit = "" 
)

Constructs a PvlKeyword object with a name, value and units.

Defaults to unit="".

Parameters
nameThe keyword name.
valueThe keyword values.
unitThe units the values are given in.

◆ PvlKeyword() [4/4]

Isis::PvlKeyword::PvlKeyword ( const PvlKeyword other)

Copy constructor.

◆ ~PvlKeyword()

Isis::PvlKeyword::~PvlKeyword ( )

Destructs a PvlKeyword object.

Member Function Documentation

◆ addComment()

void Isis::PvlKeyword::addComment ( QString  comment)

Add a comment to the PvlKeyword.

Parameters
commentThe new comment.
See also
addCommentWrapped()
addComments()
clearComment()

Referenced by Isis::PvlContainer::addComment(), and Isis::ControlNetVersioner::toPvl().

◆ addComments()

void Isis::PvlKeyword::addComments ( const std::vector< QString > &  comments)

This method adds multiple comments at once by calling AddComments on each element in the vector.

Parameters
commentsComments to associate with this keyword

Referenced by Isis::operator>>().

◆ addCommentWrapped()

void Isis::PvlKeyword::addCommentWrapped ( QString  comment)

Automatically wraps and adds long comments to the PvlKeyword.

Parameters
commentThe new comment to add
See also
addComment()
addComments()
clearComment()

References Isis::IString::Token().

◆ addValue()

void Isis::PvlKeyword::addValue ( QString  value,
QString  unit = "" 
)

Adds a value with units.

If no current value exists, this method sets the given value. Otherwise, it retains any current values and adds the value given to the array of values for this PvlKeyword object. Defaults to unit = "" (empty QString).

Parameters
valueNew value to be assigned.
unitUnits of measurement corresponding to the value.
See also
setValue()
operator=
operator+=

Referenced by Isis::DbProfile::add(), Isis::PvlFormat::add(), Isis::ControlNetDiff::addUniqueMeasure(), Isis::ControlNetDiff::addUniquePoint(), IsisAml::CommandLine(), Isis::PvlToPvlTranslationManager::DoTranslation(), Isis::HiHistory::makekey(), Isis::ControlNetDiff::makeKeyword(), Isis::operator>>(), Isis::Stretch::Save(), and Isis::Spice::storeValue().

◆ clear()

void Isis::PvlKeyword::clear ( )

Clears all values and units for this PvlKeyword object.

Referenced by Isis::PvlFormatPds::formatBinary(), and Isis::operator>>().

◆ clearComment()

void Isis::PvlKeyword::clearComment ( )

Clears the current comments.

◆ comment()

QString Isis::PvlKeyword::comment ( const int  index) const

Return a comment at the specified index.

Parameters
indexThe index of the comment.
Returns
QString The comment at the index.
Exceptions
iExceptionArraySubscriptNotInRange (index) Index out of bounds.

References _FILEINFO_, and Isis::Message::ArraySubscriptNotInRange().

Referenced by Isis::PvlContainer::comment(), Isis::operator<<(), and Isis::pvlKeywordToJSON().

◆ comments()

int Isis::PvlKeyword::comments ( ) const
inline

Returns the number of lines of comments associated with this keyword.

Referenced by Isis::PvlContainer::comments(), Isis::operator<<(), and Isis::pvlKeywordToJSON().

◆ format()

PvlFormat * Isis::PvlKeyword::format ( )

Get the current PvlFormat or create one.

Returns
PvlFormat* Pointer to PvlFormat.

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

◆ indent()

int Isis::PvlKeyword::indent ( ) const
inline

Returns the current indent level.

Referenced by Isis::PvlContainer::indent(), Isis::operator<<(), and setIndent().

◆ isEquivalent()

bool Isis::PvlKeyword::isEquivalent ( QString  QString1,
int  index = 0 
) const

Checks to see if a value with a specified index is equivalent to another QString.

Parameters
QString1The QString to compare the value to.
indexThe index of the existing value.
Returns
bool True if the two QStrings are equivalent, false if they're not.
Exceptions
iExceptionArraySubscriptNotInRange (index) Index out of bounds.

References _FILEINFO_, and Isis::Message::ArraySubscriptNotInRange().

Referenced by Isis::Blob::Find().

◆ isNamed()

bool Isis::PvlKeyword::isNamed ( QString  name) const
inline

Determines whether two PvlKeywords have the same name or not.

Parameters
nameThe name of the keyword to compare with this one.
Returns
True if the names are equal, false if not.

References name(), and stringEqual().

Referenced by Isis::KernelDb::findAll(), and Isis::KernelDb::matches().

◆ isNull()

bool Isis::PvlKeyword::isNull ( const int  index = 0) const

Decides whether a value is null or not at a given index.

Defaults to index = 0.

Parameters
indexThe value index
Returns
bool True if the value is null, false if it's not.

References _FILEINFO_, and Isis::Message::ArraySubscriptNotInRange().

◆ name()

◆ operator double()

Isis::PvlKeyword::operator double ( ) const
inline

Returns the first value in this keyword converted to a double.

References Isis::toDouble().

◆ operator int()

Isis::PvlKeyword::operator int ( ) const
inline

Returns the first value in this keyword converted to an integer.

References Isis::toInt().

◆ operator Isis::BigInt()

Isis::PvlKeyword::operator Isis::BigInt ( ) const
inline

Returns the first value in this keyword converted to a BigInt.

References Isis::toBigInt().

◆ operator QString()

Isis::PvlKeyword::operator QString ( ) const

◆ operator!=()

bool Isis::PvlKeyword::operator!= ( const PvlKeyword key) const
inline

Returns true of the keyword names do not match.

Parameters
keyThe keyword to compare names with

◆ operator+=()

PvlKeyword & Isis::PvlKeyword::operator+= ( QString  value)

Adds a value.

Overwrites the '+=' operators to add a new value. Like addValue(), this method keeps any previously existing values and adds the new value with unit = "" (empty QString) to the array of values for this PvlKeyword object.

Parameters
valueThe new value.
Returns
PvlKeyword& Reference to PvlKeyword object.
See also
addValue()
setValue()
operator=

◆ operator=() [1/3]

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

This is an assignment operator.

References m_formatter.

◆ operator=() [2/3]

PvlKeyword & Isis::PvlKeyword::operator= ( Isis::PvlSequence seq)

Add values and units from a PvlSequence.

(Clears current values and units)

Parameters
seqThe PvlSequence to add from.
Returns
PvlKeyword& Reference to PvlKeyword object.

References Isis::PvlSequence::Size().

◆ operator=() [3/3]

PvlKeyword & Isis::PvlKeyword::operator= ( QString  value)

Sets new values.

Overwrites the '=' operator to add a new value using addValue(). Like setValue(), this method clears any previously existing values and resets to the given value with unit = "" (empty QString).

Parameters
valueThe value to be added.
Returns
PvlKeyword& Reference to PvlKeyword object.
See also
addValue()
setValue()
operator+=

◆ operator==()

bool Isis::PvlKeyword::operator== ( const PvlKeyword key) const
inline

Returns true of the keyword names match.

Parameters
keyThe keyword to compare names with

References stringEqual().

◆ operator[]() [1/2]

QString & Isis::PvlKeyword::operator[] ( int  index)

Gets value for this object at specified index.

Overrides the '[]' operator to return the element in the array of values at the specified index.

Parameters
indexThe index of the value.
Returns
IString The value at the index.
Exceptions
iExceptionArraySubscriptNotInRange (index) Index out of bounds.
See also
const operator[]

References _FILEINFO_, and Isis::Message::ArraySubscriptNotInRange().

◆ operator[]() [2/2]

const QString & Isis::PvlKeyword::operator[] ( int  index) const

Gets value for this object at specified index.

Overrides the '[]' operator to return the element in the array of values at the specified index.

Parameters
indexThe index of the value.
Returns
IString The value at the index.
Exceptions
iExceptionArraySubscriptNotInRange (index) Index out of bounds.
See also
operator[]

References _FILEINFO_, and Isis::Message::ArraySubscriptNotInRange().

◆ readCleanKeyword()

bool Isis::PvlKeyword::readCleanKeyword ( QString  keyword,
std::vector< QString > &  keywordComments,
QString &  keywordName,
std::vector< std::pair< QString, QString > > &  keywordValues 
)
static

This reads a keyword compressed back to 1 line of data (excluding comments, which are included on separate lines of data before the keyword).

Line concatenations must have already been handled. This returns the data of the keyword (if valid) and its status.

Parameters
keywordPvl "#COMMENT\n//COMMENT\nKeyword = (Value1,Value2,...)" QString
keywordCommentsOutput: Lines of data that are comments
keywordNameOutput: Name of keyword
keywordValuesOutput: vector< pair<Value, Units> >
Returns
bool false if it is invalid but could become valid given more data, true if it is a valid keyword and successful

References _FILEINFO_.

◆ readLine()

QString Isis::PvlKeyword::readLine ( std::istream &  is,
bool  insideComment 
)
static

This method reads one line of data from the input stream.

All spaces, newlines, returns and tabs are trimmed from the result. Once a newline is encountered, if the line we read is blank, we keep reading. Once a line with data is encountered, that is the result. All newlines, spaces, returns and tabs are consumed past this line of data until the next different character (seeks to next valid data).

Parameters
isThe stream to read from
Returns
QString The first encountered line of data

◆ readValue() [1/2]

QString Isis::PvlKeyword::readValue ( QString &  keyword,
bool &  quoteProblem 
)
static

◆ readValue() [2/2]

QString Isis::PvlKeyword::readValue ( QString &  keyword,
bool &  quoteProblem,
const std::vector< std::pair< char, char > > &  otherDelimiters 
)
static

This method looks for a data element in the QString.

A data element is a quoted QString, a units value, or one value of an array (not including units). As an example, each value in the following QString is quoted:

'VALUE' '=' ('VALUE','VALUE', 'VALUE' '

')

The returned values of each of these elements is VALUE. Explicitly defined quotes (', ", <>) are stripped from the return value.

Parameters
keywordInput/Output: The keyword to get the next value from (DESTRUCTIVE)
quoteProblemOutput: The QString has an unclosed quote character
Returns
QString The stripped out token.

◆ reform()

QString Isis::PvlKeyword::reform ( const QString &  value) const
protected

Checks if the value needs to be converted to PVL or iPVL and returns it in the correct format.

Parameters
valueThe value to be converted.
Returns
QString The value in its proper format (iPVL or PVL).

References Isis::PvlObject::findGroup(), Isis::Preference::Preferences(), Isis::PvlObject::Traverse, and Isis::IString::UpCase().

◆ setFormat()

void Isis::PvlKeyword::setFormat ( PvlFormat formatter)

Set the PvlFormatter used to format the keyword name and value(s)

Parameters
formatterA pointer to the formatter to be used

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

◆ setIndent()

void Isis::PvlKeyword::setIndent ( int  indent)
inline

Sets the indent level when outputted(for formatting)

Parameters
indentThe new indent

References indent().

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

◆ setName()

void Isis::PvlKeyword::setName ( QString  name)

Sets the keyword name.

Parameters
nameThe new keyword name.

References _FILEINFO_.

Referenced by Isis::Strategy::composite(), Isis::PvlToPvlTranslationManager::DoTranslation(), Isis::operator>>(), and Isis::PvlObject::PvlObject().

◆ setUnits() [1/2]

void Isis::PvlKeyword::setUnits ( QString  units)

Sets the unit of measure for all current values if any exist.

Parameters
unitsNew units to be assigned.

◆ setUnits() [2/2]

void Isis::PvlKeyword::setUnits ( QString  value,
QString  units 
)

Sets the unit of measure for a given value.

Parameters
valueThe value to match
unitsNew units to be assigned.
Exceptions
Isis::iException::Programmer- Given value must exist

References _FILEINFO_, and ASSERT.

◆ setValue()

void Isis::PvlKeyword::setValue ( QString  value,
QString  unit = "" 
)

Sets new values.

If no current value exists, this method sets the given value to the PvlKeyword. Otherwise, it clears any existing values and resets to the value given using addValue(). Defaults to unit = "" (empty QString).

Parameters
valueNew value to be assigned.
unitUnits of measurement corresponding to the value.
See also
addValue()
operator=
operator+=

Referenced by Isis::PvlObject::PvlObject(), Isis::PvlContainer::setName(), Isis::ProcessExportPds::StandardAllMapping(), Isis::ProcessMosaic::StartProcess(), and Isis::OverlapStatistics::toPvl().

◆ setWidth()

void Isis::PvlKeyword::setWidth ( int  width)
inline

The width of the longest keyword name (for formatting)

Parameters
widththe new width

References width().

◆ size()

int Isis::PvlKeyword::size ( ) const
inline

Returns the number of values stored in this keyword.

Referenced by Isis::PvlFormat::accuracy(), Isis::PvlFormat::add(), Isis::PvlToXmlTranslationManager::addAttributes(), Isis::PvlToXmlTranslationManager::addSiblings(), Isis::PvlTranslationTable::AddTable(), Isis::PvlFlatMap::append(), Isis::Cube::attachSpiceFromIsd(), Isis::BundleObservationSolveSettings::BundleObservationSolveSettings(), Isis::XmlToPvlTranslationManager::checkDependencies(), Isis::ClipperNacRollingShutterCamera::ClipperNacRollingShutterCamera(), Isis::DbProfile::count(), Isis::LabelTranslationManager::CreateContainer(), Isis::PvlToXmlTranslationManager::createParentElements(), Isis::ProcessExportPds4::createUnitMap(), Isis::PvlFormatPds::formatBinary(), Isis::PvlFormatPds::formatBool(), Isis::PvlFormatPds::formatEnum(), Isis::PvlFormatPds::formatHex(), Isis::PvlFormatPds::formatInteger(), Isis::PvlFormatPds::formatReal(), Isis::PvlFormatPds::formatString(), Isis::PvlFormatPds::formatUnknown(), Isis::PvlFormat::formatValue(), Isis::CubeViewport::getAllWhatsThisInfo(), Isis::PvlToPvlTranslationManager::GetContainer(), Isis::PvlToXmlTranslationManager::GetContainer(), Isis::Spice::hasKernels(), Isis::PvlTranslationTable::InputGroup(), Isis::PvlToPvlTranslationManager::InputKeyword(), Isis::PvlToXmlTranslationManager::InputKeyword(), Isis::PvlFormat::isSingleUnit(), Isis::PvlFlatMap::keywordValues(), Isis::Stretch::Load(), Isis::SpiceRotation::LoadCache(), Isis::SpiceRotation::loadPCFromTable(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::MarciCamera::MarciCamera(), Isis::KernelDb::matches(), Isis::NewHorizonsLeisaCamera::NewHorizonsLeisaCamera(), Isis::NewHorizonsMvicFrameCamera::NewHorizonsMvicFrameCamera(), Isis::PvlSequence::operator+=(), Isis::operator<<(), Isis::PvlSequence::operator=(), Isis::pvlKeywordToJSON(), Isis::ReseauDistortionMap::ReseauDistortionMap(), Isis::LunarLambertEmpirical::SetPhotoLList(), Isis::LunarLambertEmpirical::SetPhotoPhaseCurveList(), Isis::LunarLambertEmpirical::SetPhotoPhaseList(), Isis::Spice::storeValue(), Isis::ThemisIrCamera::ThemisIrCamera(), Isis::ThemisVisCamera::ThemisVisCamera(), Isis::XmlToPvlTranslationManager::Translate(), Isis::ProcessExportPds4::translateBandBinSpectrumBinSet(), Isis::ProcessExportPds4::translateBandBinSpectrumUniform(), and validateKeyword().

◆ stringEqual()

bool Isis::PvlKeyword::stringEqual ( const QString &  QString1,
const QString &  QString2 
)
static

Checks to see if two QStrings are equal.

Each is converted to uppercase and removed of underscores and whitespaces.

Parameters
QString1The first QString
QString2The second QString
Returns
bool True or false, depending on whether the QString values are equal.

References Isis::IString::ConvertWhiteSpace(), Isis::IString::Remove(), and Isis::IString::UpCase().

Referenced by Isis::PvlToPvlTranslationManager::GetContainer(), Isis::PvlToXmlTranslationManager::GetContainer(), Isis::PvlContainer::isNamed(), isNamed(), Isis::PvlFormat::isSingleUnit(), Isis::PvlGroup::operator==(), operator==(), and Isis::PvlObject::operator==().

◆ toIPvl()

QString Isis::PvlKeyword::toIPvl ( const QString &  value) const
protected

Converts a value to iPVL format.

Parameters
valueThe value to be converted.
Returns
QString The value in iPVL format.

◆ toPvl()

QString Isis::PvlKeyword::toPvl ( const QString &  value) const
protected

Converts a value to PVL format.

Parameters
valueThe value to be converted.
Returns
QString The value in PVL format.

◆ unit()

QString Isis::PvlKeyword::unit ( const int  index = 0) const

Returns the units of measurement of the element of the array of values for the object at the specified index.

Defaults to index = 0.

Parameters
indexThe index of the unit.
Returns
QString The unit at the index.
Exceptions
iExceptionArraySubscriptNotInRange (index) Index out of bounds.

References _FILEINFO_, and Isis::Message::ArraySubscriptNotInRange().

Referenced by Isis::PvlToXmlTranslationManager::doTranslation(), Isis::PvlFormatPds::formatBinary(), Isis::PvlFormatPds::formatEnum(), Isis::PvlFormatPds::formatHex(), Isis::PvlFormatPds::formatInteger(), Isis::PvlFormatPds::formatReal(), Isis::PvlFormatPds::formatString(), Isis::PvlFormatPds::formatUnknown(), Isis::PvlFormat::formatValue(), Isis::PvlFormat::isSingleUnit(), Isis::pvlKeywordToJSON(), Isis::ProcessExportPds::StandardAllMapping(), and Isis::ProcessExportPds4::translateBandBinSpectrumUniform().

◆ validateKeyword()

void Isis::PvlKeyword::validateKeyword ( PvlKeyword pvlKwrd,
QString  psValueType = "",
PvlKeyword pvlKwrdValue = NULL 
)

Validate Keyword for type and required values.

Validate a Keyword, comparing against corresponding Template Keyword.

Template Keyword has the format: keyName = (valueType, optional/required, Values allowed separated by comma)

Author
Sharmila Prasad (9/22/2010)
Parameters
pvlKwrd- Keyword to be validated
psValueType- Value Type (positive / negative) for numbers
pvlKwrdValue- Template Keyword __Value or __Range to validate keyword's value

References _FILEINFO_, name(), size(), Isis::toDouble(), and Isis::toInt().

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

◆ width()

int Isis::PvlKeyword::width ( ) const
inline

Returns the current set longest keyword name.

Referenced by Isis::operator<<(), and setWidth().

◆ writeWithWrap()

ostream & Isis::PvlKeyword::writeWithWrap ( std::ostream &  os,
const QString &  textToWrite,
int  startColumn,
PvlFormat format 
) const
protected

Wraps output so that length doesn't exceed the character limit.

By default, the character limit is set to 80, and can be changed with the method SetCharLimit. Used as a helper method for output of PvlKeyword.

Parameters
osDesignated output stream
textToWriteThe text to be written
startColumnThe starting column after the "=" sign.
endOfLineThe EOL character
Returns
ostream& Reference to ostream.
See also
operator<<

References Isis::PvlFormat::charLimit(), and Isis::PvlFormat::formatEOL().

Referenced by Isis::operator<<().

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const PvlKeyword keyword 
)
friend

Write out the keyword.

Parameters
osThe output stream.
keywordThe PvlKeyword object to output.
Returns
ostream& Reference to ostream.
See also
writeWithWrap()

◆ operator>>

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

Read in a keyword.

http://pds.jpl.nasa.gov/tools/standards-reference.shtml

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

Member Data Documentation

◆ m_formatter

PvlFormat* Isis::PvlKeyword::m_formatter
protected

Formatter object.

Referenced by Isis::operator<<(), and operator=().


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