Isis::PvlToken Class Reference

Container for Keyword-value pair. More...

#include <PvlToken.h>

Collaboration diagram for Isis::PvlToken:

Public Member Functions
	PvlToken (const QString &k)
	Constructs a Token with k for keyword and NULL for the value list. More...
	PvlToken ()
	Constructs a Token with NULL for both the keyword and value list. More...
	~PvlToken ()
	Destroys the Token object. More...
void	setKey (const QString &k)
	Set the token keyword. More...
QString	key () const
	Returns the token keyword. More...
QString	keyUpper () const
	Returns the token keyword in all uppercase characters. More...
void	addValue (const QString &v)
	Adds a value to the value-vector. More...
QString	value (const int index=0) const
	Returns one element of the value-vector. More...
QString	valueUpper (const int index=0) const
	Returns one element of the value-vector in uppercase. More...
int	valueSize () const
	Returns the number of elements in the value-vector. More...
void	valueClear ()
	Removes all elements from the value-vector. More...
const std::vector< QString > &	valueVector () const

Private Attributes
QString	m_key
	Storage for the keyword name. More...
std::vector< QString >	m_value
	Vector storage for a list of values. More...

Detailed Description

Container for Keyword-value pair.

This class is used for internalizing keyword-value(s) pairs. For example, SPACECRAFT=MARS_GLOBAL_SURVEYOR or FROM=file.cub. This is useful when parsing ASCII files such as PDS labels or command lines.

Author

2002-03-18 Jeff Anderson

History:

2003-05-16 Stuart Sides - Modified schema from astrogeology... isis.astrogeology...

History:

2005-02-14 Elizabeth Ribelin - Modified file to support Doxygen

History:

2013-03-11 Steven Lambright and Mathew Eis - Brought method names and member variable names up to the current Isis 3 coding standards. Fixes #1533. documentation

Todo:

2005-02-14 Jeff Anderson - add coded and implemetation example to class documentation

Definition at line 38 of file PvlToken.h.

Constructor & Destructor Documentation

PvlToken() [1/2]

Isis::PvlToken::PvlToken

(

const QString &

k

)

Constructs a Token with k for keyword and NULL for the value list.

Parameters

k	Value of the keyword

Definition at line 19 of file PvlToken.cpp.

PvlToken() [2/2]

Isis::PvlToken::PvlToken

(

)

Constructs a Token with NULL for both the keyword and value list.

Definition at line 25 of file PvlToken.cpp.

~PvlToken()

Isis::PvlToken::~PvlToken

(

)

Destroys the Token object.

Definition at line 30 of file PvlToken.cpp.

Member Function Documentation

addValue()

void Isis::PvlToken::addValue

(

const QString &

v

)

Adds a value to the value-vector.

Successive calls add values to the end of the vector.

Parameters

v	IString add to the value-vector list

Definition at line 82 of file PvlToken.cpp.

Referenced by Isis::PvlTokenizer::Load(), and Isis::PvlTokenizer::ParseCommaList().

key()

QString Isis::PvlToken::key

(

)

const

Returns the token keyword.

Returns

QString

Definition at line 49 of file PvlToken.cpp.

Referenced by Isis::PvlTokenizer::Load().

keyUpper()

QString Isis::PvlToken::keyUpper

(

)

const

Returns the token keyword in all uppercase characters.

Returns

QString

Definition at line 58 of file PvlToken.cpp.

Referenced by Isis::PvlTokenizer::Load().

setKey()

void Isis::PvlToken::setKey

(

const QString &

k

)

Set the token keyword.

Parameters

k	IString to load into the token keyword

Definition at line 40 of file PvlToken.cpp.

value()

QString Isis::PvlToken::value

(

const int

index = 0

)

const

Returns one element of the value-vector.

Parameters

index

Zero-based index of vector element to return. Defaults to 0

Returns

QString

Exceptions

Isis::IException::Programmer

Definition at line 95 of file PvlToken.cpp.

References Isis::Message::ArraySubscriptNotInRange().

valueClear()

void Isis::PvlToken::valueClear

(

)

Removes all elements from the value-vector.

Definition at line 63 of file PvlToken.cpp.

valueSize()

int Isis::PvlToken::valueSize

(

)

const

Returns the number of elements in the value-vector.

Returns

int

Definition at line 72 of file PvlToken.cpp.

valueUpper()

QString Isis::PvlToken::valueUpper

(

const int

index = 0

)

const

Returns one element of the value-vector in uppercase.

Parameters

index

Zero-based index of vector element to return. Defaults to 0

Returns

QString

Exceptions

Isis::IException::Programmer

Definition at line 112 of file PvlToken.cpp.

References Isis::Message::ArraySubscriptNotInRange().

Member Data Documentation

m_key

QString Isis::PvlToken::m_key

private

Storage for the keyword name.

Definition at line 40 of file PvlToken.h.

m_value

std::vector<QString> Isis::PvlToken::m_value

private

Vector storage for a list of values.

See the standard template library for more information on vectors.

Definition at line 41 of file PvlToken.h.

---

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

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