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

#include <PvlFormatPds.h>

Inheritance diagram for Isis::PvlFormatPds:

Collaboration diagram for Isis::PvlFormatPds:

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.

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.

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.

Protected Attributes
QString	m_keywordMapFile

Pvl	m_keywordMap

unsigned int	m_charLimit
	Maximum number of characters on a single line of a keyword value.

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

◆ PvlFormatPds() [1/3]

Isis::PvlFormatPds::PvlFormatPds ( )

◆ PvlFormatPds() [2/3]

Isis::PvlFormatPds::PvlFormatPds ( const QString & file )

References Isis::PvlFormat::PvlFormat().

◆ PvlFormatPds() [3/3]

Isis::PvlFormatPds::PvlFormatPds ( Pvl & keymap )

References Isis::PvlFormat::PvlFormat().

◆ ~PvlFormatPds()

virtual Isis::PvlFormatPds::~PvlFormatPds ( )

inlinevirtual

Member Function Documentation

◆ accuracy()

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

virtualinherited

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

Referenced by Isis::PvlFormatPds::formatValue().

◆ add() [1/2]

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

inherited

References _FILEINFO_, add(), m_keywordMapFile, and Isis::IException::Programmer.

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

◆ add() [2/2]

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

inherited

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

◆ addQuotes()

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

protectedvirtual

Reimplemented from Isis::PvlFormat.

Referenced by formatString().

◆ charLimit()

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 m_charLimit.

◆ formatBinary()

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

protected

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

Referenced by formatValue().

◆ formatBool()

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

protected

References Isis::PvlKeyword::size().

Referenced by formatValue().

◆ formatEnd()

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

virtual

Reimplemented from Isis::PvlFormat.

◆ formatEnum()

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

protected

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

Referenced by formatValue().

◆ formatEOL()

virtual QString Isis::PvlFormatPds::formatEOL ( )

inlinevirtual

Reimplemented from Isis::PvlFormat.

◆ formatHex()

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().

◆ formatInteger()

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

protected

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

Referenced by formatValue().

◆ formatName()

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

virtual

Reimplemented from Isis::PvlFormat.

References Isis::PvlKeyword::name().

◆ formatReal()

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().

◆ formatString()

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

protected

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

Referenced by formatValue().

◆ formatUnknown()

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

protected

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

Referenced by formatValue().

◆ formatValue()

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

virtual

◆ isSingleUnit()

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().

Referenced by formatValue().

◆ setCharLimit()

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 m_charLimit.

◆ type()

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

virtualinherited

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

Referenced by add(), and Isis::PvlFormatPds::formatValue().

Member Data Documentation

◆ m_charLimit

unsigned int Isis::PvlFormat::m_charLimit

protectedinherited

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

Referenced by charLimit(), and setCharLimit().

◆ m_keywordMap

Pvl Isis::PvlFormat::m_keywordMap

protectedinherited

Referenced by accuracy(), add(), and type().

◆ m_keywordMapFile

QString Isis::PvlFormat::m_keywordMapFile

protectedinherited

Referenced by add().

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

/Users/astamile/ISIS3/isis/src/base/objs/PvlFormatPds/PvlFormatPds.h
/Users/astamile/ISIS3/isis/src/base/objs/PvlFormatPds/PvlFormatPds.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PvlFormatPds() [1/3]

◆ PvlFormatPds() [2/3]

◆ PvlFormatPds() [3/3]

◆ ~PvlFormatPds()

Member Function Documentation

◆ accuracy()

◆ add() [1/2]

◆ add() [2/2]

◆ addQuotes()

◆ charLimit()

◆ formatBinary()

◆ formatBool()

◆ formatEnd()

◆ formatEnum()

◆ formatEOL()

◆ formatHex()

◆ formatInteger()

◆ formatName()

◆ formatReal()

◆ formatString()

◆ formatUnknown()

◆ formatValue()

◆ isSingleUnit()

◆ setCharLimit()

◆ type()

Member Data Documentation

◆ m_charLimit

◆ m_keywordMap

◆ m_keywordMapFile