Isis::PvlFormatPds Class Reference

Formats the value of a PvlKeyword into a PDS complient string. More...

#include <PvlFormatPds.h>

Inherits Isis::PvlFormat.

Public Member Functions
	PvlFormatPds ()
	PvlFormatPds (const QString &file)
	PvlFormatPds (Pvl &keymap)
virtual	~PvlFormatPds ()
virtual QString	formatValue (const PvlKeyword &keyword, int valueIndex=0)
virtual QString	formatName (const PvlKeyword &keyword)
virtual QString	formatEnd (const QString name, const PvlKeyword &keyword)
virtual QString	formatEOL ()
void	add (const QString &file)
void	add (Pvl &keymap)
void	setCharLimit (const unsigned int limit)
	Sets the maximum number of characters in a keyword value that can be printed to a line before it wraps to the next line. More...
unsigned int	charLimit () const
	Retrieves the maximum number of characters in a keyword value that can be printed to a line before it wraps to the next line. More...
virtual KeywordType	type (const PvlKeyword &keyword)
virtual int	accuracy (const PvlKeyword &keyword)

Protected Member Functions
virtual QString	addQuotes (const QString value)
QString	formatString (const PvlKeyword &keyword, int num)
QString	formatInteger (const PvlKeyword &keyword, int num, int bytes)
QString	formatReal (const PvlKeyword &keyword, int num, int precision)
QString	formatEnum (const PvlKeyword &keyword, int num)
QString	formatBinary (const PvlKeyword &keyword, int num, int bytes)
QString	formatHex (const PvlKeyword &keyword, int num, int bytes)
QString	formatBool (const PvlKeyword &keyword, int num)
QString	formatUnknown (const PvlKeyword &keyword, int num)
bool	isSingleUnit (const PvlKeyword &keyword)
	Returns true if the units are the same for all value in the keyword otherwise it returns false. More...

Protected Attributes
QString	m_keywordMapFile
Pvl	m_keywordMap
unsigned int	m_charLimit
	Maximum number of characters on a single line of a keyword value. More...

Detailed Description

Formats the value of a PvlKeyword into a PDS complient string.

This class is used to format a single PVL keyword-value pair. The supported formats are Normal and PDS. The keyword to type mapping is not defined until a Pvl or Pvl formatted file is supplied.

Author

2006-09-05 Stuart Sides

Constructor & Destructor Documentation

Isis::PvlFormatPds::PvlFormatPds

(

)

Isis::PvlFormatPds::PvlFormatPds

(

const QString &

file

)

Isis::PvlFormatPds::PvlFormatPds

(

Pvl &

keymap

)

virtual Isis::PvlFormatPds::~PvlFormatPds ( )

inlinevirtual

Member Function Documentation

int Isis::PvlFormat::accuracy ( const PvlKeyword &  keyword )

virtualinherited

References Isis::PvlKeyword::name(), Isis::PvlKeyword::size(), and Isis::toInt().

Referenced by formatValue().

void Isis::PvlFormat::add ( const QString &  file )

inherited

References _FILEINFO_.

Referenced by Isis::ProcessExportPds::CreateImageLabel(), Isis::ProcessExportPds::FixedJP2ImageRoot(), Isis::ProcessExportPds::StandardImageImage(), Isis::ProcessExportPds::StandardJP2Image(), and Isis::ProcessExportPds::StreamJP2ImageRoot().

void Isis::PvlFormat::add ( Pvl &  keymap )

inherited

References Isis::PvlKeyword::addValue(), Isis::PvlContainer::keywords(), Isis::PvlKeyword::name(), and Isis::PvlKeyword::size().

QString Isis::PvlFormatPds::addQuotes ( const QString  value )

protectedvirtual

Reimplemented from Isis::PvlFormat.

Referenced by formatString().

unsigned int Isis::PvlFormat::charLimit ( ) const

inlineinherited

Retrieves the maximum number of characters in a keyword value that can be printed to a line before it wraps to the next line.

By default, the limit is set to 80 characters.

Returns

unsigned int Maximum number of characters.

References Isis::PvlFormat::m_charLimit.

Referenced by Isis::PvlKeyword::writeWithWrap().

QString Isis::PvlFormatPds::formatBinary ( const PvlKeyword &  keyword, int  num, int  bytes  )

protected

References Isis::PvlKeyword::clear(), Isis::PvlKeyword::size(), Isis::toBigInt(), and Isis::PvlKeyword::unit().

Referenced by formatValue().

QString Isis::PvlFormatPds::formatBool ( const PvlKeyword &  keyword, int  num  )

protected

References Isis::PvlKeyword::size().

Referenced by formatValue().

QString Isis::PvlFormatPds::formatEnd ( const QString  name, const PvlKeyword &  keyword  )

virtual

Reimplemented from Isis::PvlFormat.

QString Isis::PvlFormatPds::formatEnum ( const PvlKeyword &  keyword, int  num  )

protected

References Isis::PvlKeyword::size(), and Isis::PvlKeyword::unit().

Referenced by formatValue().

virtual QString Isis::PvlFormatPds::formatEOL ( )

inlinevirtual

Reimplemented from Isis::PvlFormat.

QString Isis::PvlFormatPds::formatHex ( const PvlKeyword &  keyword, int  num, int  bytes  )

protected

References Isis::PvlKeyword::size(), Isis::toBigInt(), Isis::toInt(), and Isis::PvlKeyword::unit().

Referenced by formatValue().

QString Isis::PvlFormatPds::formatInteger ( const PvlKeyword &  keyword, int  num, int  bytes  )

protected

References Isis::PvlKeyword::size(), and Isis::PvlKeyword::unit().

Referenced by formatValue().

QString Isis::PvlFormatPds::formatName ( const PvlKeyword &  keyword )

virtual

Reimplemented from Isis::PvlFormat.

References Isis::PvlKeyword::name().

QString Isis::PvlFormatPds::formatReal ( const PvlKeyword &  keyword, int  num, int  precision  )

protected

References Isis::PvlKeyword::size(), Isis::toDouble(), and Isis::PvlKeyword::unit().

Referenced by formatValue().

QString Isis::PvlFormatPds::formatString ( const PvlKeyword &  keyword, int  num  )

protected

References addQuotes(), Isis::PvlKeyword::size(), and Isis::PvlKeyword::unit().

Referenced by formatValue().

QString Isis::PvlFormatPds::formatUnknown ( const PvlKeyword &  keyword, int  num  )

protected

References Isis::PvlFormat::addQuotes(), Isis::PvlKeyword::size(), and Isis::PvlKeyword::unit().

Referenced by formatValue().

QString Isis::PvlFormatPds::formatValue ( const PvlKeyword &  keyword, int  valueIndex = 0  )

virtual

Reimplemented from Isis::PvlFormat.

References Isis::PvlFormat::accuracy(), Isis::BinaryKeyword, Isis::BoolKeyword, Isis::EnumKeyword, formatBinary(), formatBool(), formatEnum(), formatHex(), formatInteger(), formatReal(), formatString(), formatUnknown(), Isis::HexKeyword, Isis::IntegerKeyword, Isis::PvlKeyword::name(), Isis::NoTypeKeyword, Isis::RealKeyword, Isis::StringKeyword, and Isis::PvlFormat::type().

bool Isis::PvlFormat::isSingleUnit ( const PvlKeyword &  keyword )

protectedinherited

Returns true if the units are the same for all value in the keyword otherwise it returns false.

Parameters

keyword

The PvlKeyword to be formatted

References Isis::PvlKeyword::size(), Isis::PvlKeyword::stringEqual(), and Isis::PvlKeyword::unit().

void Isis::PvlFormat::setCharLimit ( const unsigned int  limit )

inlineinherited

Sets the maximum number of characters in a keyword value that can be printed to a line before it wraps to the next line.

By default, the limit is set to 80 characters.

Parameters

limit

The new character limit.

References Isis::PvlFormat::m_charLimit.

KeywordType Isis::PvlFormat::type ( const PvlKeyword &  keyword )

virtualinherited

References Isis::PvlKeyword::name(), Isis::NoTypeKeyword, and Isis::toKeywordType().

Referenced by formatValue().

Member Data Documentation

unsigned int Isis::PvlFormat::m_charLimit

protectedinherited

Maximum number of characters on a single line of a keyword value.

Referenced by Isis::PvlFormat::charLimit(), and Isis::PvlFormat::setCharLimit().

Pvl Isis::PvlFormat::m_keywordMap

protectedinherited

QString Isis::PvlFormat::m_keywordMapFile

protectedinherited

---

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

• src/base/objs/PvlFormatPds/PvlFormatPds.h
• src/base/objs/PvlFormatPds/PvlFormatPds.cpp