ossimKeyword Class Reference

#include <ossimKeyword.h>

Public Member Functions
	ossimKeyword ()
	ossimKeyword (const char *key, const char *description)
	ossimKeyword (const char *key, const char *description, const char *value)
	ossimKeyword (const ossimKeyword &src)
	~ossimKeyword ()
const ossimKeyword &	operator= (const ossimKeyword &kw)
	operator const char * () const
const char *	key () const
const char *	description () const
const char *	value () const
ossimString	keyString () const
ossimString	descriptionString () const
ossimString	valueString () const
void	setValue (const char *val)
void	setValue (const ossimString &val)
void	setDescription (const char *desc)
void	setDescription (const ossimString &desc)

Private Attributes
ossimString	theKey
ossimString	theDesc
ossimString	theValue

Friends
OSSIM_DLL std::ostream &	operator<< (std::ostream &os, const ossimKeyword &kw)

Detailed Description

Definition at line 17 of file ossimKeyword.h.

Constructor & Destructor Documentation

ossimKeyword() [1/4]

ossimKeyword::ossimKeyword

(

)

Definition at line 16 of file ossimKeyword.cpp.

   :
      theKey(""),
      theDesc(""),
      theValue("")
{}

ossimKeyword() [2/4]

ossimKeyword::ossimKeyword	(	const char *	key,
		const char *	description
	)

Definition at line 23 of file ossimKeyword.cpp.

   :
      theKey(key),
      theDesc(description),
      theValue("")
{}

ossimKeyword() [3/4]

ossimKeyword::ossimKeyword	(	const char *	key,
		const char *	description,
		const char *	value
	)

Definition at line 30 of file ossimKeyword.cpp.

   :
      theKey(key),
      theDesc(description),
      theValue(value)      
{}

ossimKeyword() [4/4]

ossimKeyword::ossimKeyword

(

const ossimKeyword &

src

)

Definition at line 39 of file ossimKeyword.cpp.

   :
      theKey(src.key()),
      theDesc(src.description()),
      theValue(src.value())
{}

~ossimKeyword()

ossimKeyword::~ossimKeyword

(

)

Definition at line 46 of file ossimKeyword.cpp.

{}

Member Function Documentation

description()

const char * ossimKeyword::description

(

)

const

Definition at line 59 of file ossimKeyword.cpp.

References ossimString::c_str(), and theDesc.

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

{
   return theDesc.c_str();
}

descriptionString()

ossimString ossimKeyword::descriptionString

(

)

const

Definition at line 74 of file ossimKeyword.cpp.

References theDesc.

{
   return theDesc;
}

key()

const char * ossimKeyword::key

(

)

const

Definition at line 54 of file ossimKeyword.cpp.

References ossimString::c_str(), and theKey.

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

{
   return theKey.c_str();
}

keyString()

ossimString ossimKeyword::keyString

(

)

const

Definition at line 69 of file ossimKeyword.cpp.

References theKey.

{
   return theKey;
}

operator const char *()

ossimKeyword::operator const char *

(

)

const

Definition at line 49 of file ossimKeyword.cpp.

{
   return theKey.c_str();
}

operator=()

const ossimKeyword & ossimKeyword::operator=

(

const ossimKeyword &

kw

)

Definition at line 104 of file ossimKeyword.cpp.

References description(), key(), theDesc, theKey, theValue, and value().

{
   if (this != &kw)
   {
      theKey = kw.key();
      theDesc = kw.description();
      theValue = kw.value();
   }
   
   return *this;
}

setDescription() [1/2]

void ossimKeyword::setDescription

(

const char *

desc

)

Definition at line 94 of file ossimKeyword.cpp.

References theDesc.

{
   theDesc  = desc;
}

setDescription() [2/2]

void ossimKeyword::setDescription

(

const ossimString &

desc

)

Definition at line 99 of file ossimKeyword.cpp.

References theDesc.

{
   theDesc  = desc;
}

setValue() [1/2]

void ossimKeyword::setValue

(

const char *

val

)

Definition at line 84 of file ossimKeyword.cpp.

References theValue.

{
   theValue = val;
}

setValue() [2/2]

void ossimKeyword::setValue

(

const ossimString &

val

)

Definition at line 89 of file ossimKeyword.cpp.

References theValue.

{
   theValue = val;
}

value()

const char * ossimKeyword::value

(

)

const

Definition at line 64 of file ossimKeyword.cpp.

References ossimString::c_str(), and theValue.

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

{
   return theValue.c_str();
}

valueString()

ossimString ossimKeyword::valueString

(

)

const

Definition at line 79 of file ossimKeyword.cpp.

References theValue.

{
   return theValue;
}

Friends And Related Function Documentation

operator<<

OSSIM_DLL std::ostream& operator<< ( std::ostream &  os, const ossimKeyword &  kw  )

friend

Definition at line 116 of file ossimKeyword.cpp.

{
   os << "\n key   = " << kw.key()
      << "\n desc  = " << kw.description()
      << "\n value = " << kw.value()
      << std::endl;
   return os;
}

Member Data Documentation

theDesc

ossimString ossimKeyword::theDesc

private

Definition at line 46 of file ossimKeyword.h.

Referenced by description(), descriptionString(), operator=(), and setDescription().

theKey

ossimString ossimKeyword::theKey

private

Definition at line 45 of file ossimKeyword.h.

Referenced by key(), keyString(), and operator=().

theValue

ossimString ossimKeyword::theValue

private

Definition at line 47 of file ossimKeyword.h.

Referenced by operator=(), setValue(), value(), and valueString().

---

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

• ossimKeyword.h
• ossimKeyword.cpp