Represents serializable keyword/value map. More...

#include <ossimKeywordlist.h>

Inheritance diagram for ossimKeywordlist:

Public Types
typedef std::map< std::string, std::string >	KeywordMap

Public Member Functions
	ossimKeywordlist (const ossimKeywordlist &src)

	ossimKeywordlist (const std::map< std::string, std::string > &keywordMap)

	ossimKeywordlist (char delimiter=DEFAULT_DELIMITER, bool expandEnvVars=false)

	ossimKeywordlist (const char *file, char delimiter=DEFAULT_DELIMITER, bool ignoreBinaryChars=false, bool expandEnvVars=false)

	ossimKeywordlist (const ossimFilename &fileName, char delimiter=DEFAULT_DELIMITER, bool ignoreBinaryChars=false, bool expandEnvVars=false)

	~ossimKeywordlist ()

bool	addFile (const char *file)

bool	addFile (const ossimFilename &file)

void	change_delimiter (char del)

ossimString	delimiter_str () const

void	setExpandEnvVarsFlag (bool flag)

bool	getExpandEnvVarsFlag (void) const

void	add (const char *prefix, const ossimKeywordlist &kwl, bool overwrite=true)

template<class CompareType >
bool	findValue (ossimString &value, const CompareType &compare) const
	This is a generic find method that takes a comparator type and iterates through the map executing the overloaded operator (). More...

std::string &	operator[] (const std::string &key)

std::string	operator[] (const std::string &key) const

void	addPair (const std::string &key, const std::string &value, bool overwrite=true)

void	addPair (const std::string &prefix, const std::string &key, const std::string &value, bool overwrite=true)

void	add (const ossimKeywordlist &kwl, const char *prefix=0, bool stripPrefix=true)

void	add (const char key, const char value, bool overwrite=true)

void	add (const char prefix, const char key, const char *value, bool overwrite=true)

void	add (const char *key, char value, bool overwrite=true)

void	add (const char prefix, const char key, char value, bool overwrite=true)

void	add (const char *key, ossim_int16 value, bool overwrite=true)

void	add (const char prefix, const char key, ossim_int16 value, bool overwrite=true)

void	add (const char *key, ossim_uint16 value, bool overwrite=true)

void	add (const char prefix, const char key, ossim_uint16 value, bool overwrite=true)

void	add (const char *key, ossim_int32 value, bool overwrite=true)

void	add (const char prefix, const char key, ossim_int32 value, bool overwrite=true)

void	add (const char *key, ossim_uint32 value, bool overwrite=true)

void	add (const char prefix, const char key, ossim_uint32 value, bool overwrite=true)

void	add (const char *key, ossim_int64 value, bool overwrite=true)

void	add (const char prefix, const char key, ossim_int64 value, bool overwrite=true)

void	add (const char *key, ossim_uint64 value, bool overwrite=true)

void	add (const char prefix, const char key, ossim_uint64 value, bool overwrite=true)

void	add (const char *key, ossim_float32 value, bool overwrite=true, int precision=8)

void	add (const char prefix, const char key, ossim_float32 value, bool overwrite=true, int precision=8)

void	add (const char *key, ossim_float64 value, bool overwrite=true, int precision=15)

void	add (const char prefix, const char key, ossim_float64 value, bool overwrite=true, int precision=15)

bool	hasKey (const std::string &key) const
	Checks for key in map. More...

const std::string &	findKey (const std::string &key) const
	Find methods that take std::string(s). More...

const std::string &	findKey (const std::string &prefix, const std::string &key) const

const char *	find (const char *key) const

const char *	find (const char prefix, const char key) const

void	remove (const char *key)

void	remove (const char prefix, const char key)

ossim_uint32	numberOf (const char *str) const

ossim_uint32	numberOf (const char prefix, const char key) const

virtual bool	write (const char file, const char comment=0) const
	Methods to dump the ossimKeywordlist to a file on disk. More...

virtual ossimString	toString () const

virtual void	toString (ossimString &result) const

virtual void	writeToStream (std::ostream &out) const

void	toXML (std::ostream &out, const std::string &rootTag="info") const
	Outputs in xml format. More...

void	toJSON (std::ostream &out, const std::string &rootTag="info") const
	Outputs in json format. More...

virtual std::ostream &	print (std::ostream &os) const
	Outputs theErrorStatus as an ossimErrorCode and an ossimString. More...

bool	operator== (ossimKeywordlist &kwl) const

bool	operator!= (ossimKeywordlist &kwl) const

void	clear ()

void	addList (const ossimKeywordlist &src, bool overwrite=true)

virtual bool	parseStream (ossim::istream &is, bool ignoreBinaryChars)
	deprecated method More...

virtual bool	parseStream (ossim::istream &is)

virtual bool	parseString (const std::string &inString)

void	getSortedList (std::vector< ossimString > &prefixValues, const ossimString &prefixKey) const
	This return the sorted keys if you have a list. More...

std::vector< ossimString >	findAllKeysThatContains (const ossimString &searchString) const

void	findAllKeysThatMatch (std::vector< ossimString > &result, const ossimString &regularExpression) const
	Finds keys that match regular expression. More...

ossim_uint32	getNumberOfKeysThatMatch (const ossimString &regularExpression) const
	Gets number keys that match regular expression. More...

void	extractKeysThatMatch (ossimKeywordlist &kwl, const ossimString &regularExpression) const

void	removeKeysThatMatch (const ossimString &regularExpression)

std::vector< ossimString >	getSubstringKeyList (const ossimString &regularExpression) const

void	getSubstringKeyList (std::vector< ossimString > &result, const ossimString &regularExpression) const

ossim_uint32	getNumberOfSubstringKeys (const ossimString &regularExpression) const

void	addPrefixToAll (const ossimString &prefix)

void	addPrefixToKeysThatMatch (const ossimString &prefix, const ossimString &regularExpression)

void	stripPrefixFromAll (const ossimString &regularExpression)

ossim_uint32	getSize () const

const ossimKeywordlist::KeywordMap &	getMap () const

ossimKeywordlist::KeywordMap &	getMap ()

ossimKeywordlist &	downcaseKeywords ()

ossimKeywordlist &	upcaseKeywords ()

ossimKeywordlist &	trimAllValues (const ossimString &valueToTrim=ossimString(" \\))

ossimKeywordlist	trimAllValues (const ossimString &valueToTrim=ossimString(" \\)) const

bool	getBoolKeywordValue (bool &rtn_val, const char keyword, const char prefix=0) const
	[OLK, Aug/2008] Sets the boolean <rtn_val> depending on value associated with keyword for values = (yes\|no\|true\|false\|1\|0). More...

Public Member Functions inherited from ossimErrorStatusInterface
	ossimErrorStatusInterface ()

virtual	~ossimErrorStatusInterface ()

virtual ossimErrorCode	getErrorStatus () const

virtual ossimString	getErrorStatusString () const

virtual void	setErrorStatus (ossimErrorCode error_status) const

virtual void	setErrorStatus () const

virtual void	clearErrorStatus () const

bool	hasError () const

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

int	referenceCount () const

Static Public Attributes
static const std::string	NULL_KW = ""

Protected Types
enum	KeywordlistParseState { KeywordlistParseState_OK = 0, KeywordlistParseState_FAIL = 1, KeywordlistParseState_BAD_STREAM = 2 }

Protected Member Functions
bool	parseFile (const ossimFilename &file, bool ignoreBinaryChars=false)

bool	isValidKeywordlistCharacter (ossim_uint8 c) const

void	skipWhitespace (ossim::istream &in) const

KeywordlistParseState	readComments (ossimString &sequence, ossim::istream &in) const

KeywordlistParseState	readPreprocDirective (ossim::istream &in)

KeywordlistParseState	readKey (ossimString &sequence, ossim::istream &in) const

KeywordlistParseState	readValue (ossimString &sequence, ossim::istream &in) const

KeywordlistParseState	readKeyAndValuePair (ossimString &key, ossimString &value, ossim::istream &in) const

KeywordMap::iterator	getMapEntry (const std::string &key)

KeywordMap::iterator	getMapEntry (const ossimString &key)

KeywordMap::iterator	getMapEntry (const char *key)

bool	isSpecialXmlCharacters (const ossimString &value) const

bool	isValidTag (const std::string &value) const

void	replaceSpecialCharacters (ossimString &value) const

bool	isSame (const std::vector< ossimString > &a, const std::vector< ossimString > &b) const

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
KeywordMap	m_map

char	m_delimiter

bool	m_preserveKeyValues

bool	m_expandEnvVars

ossimFilename	m_currentlyParsing

Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

Friends
OSSIMDLLEXPORT friend std::ostream &	operator<< (std::ostream &os, const ossimKeywordlist &kwl)

Detailed Description

Represents serializable keyword/value map.

The format is

[<prefix>.]<keyword>: value [value ...]

The map is not a multimap, i.e., the keywords must be unique. Only the last occurrence of identical keywords will be saved in the map. Methods are provided for reading from and writing to an ascii file. Methods are also provided for merging multiple maps (a.k.a. "lists" or "KWLs") as well as assorted operations for pruning and counting.

Disk files representing a KWL can use the C-style "#include <filename>" preprocessor directive, where <filename> specifies another external KWL file that will be merged with the current list. This is convenient for sourcing common settings needed by multiple KWL files. Instead of duplicating all common keywords/value pairs, the various KWL files can all specify, for example,

 #include common_prefs.kwl
 #include "common config.kwl"

The second form with quotes can be used, especially if the filename has spaces.

Definition at line 50 of file ossimKeywordlist.h.

Member Typedef Documentation

◆ KeywordMap

typedef std::map<std::string, std::string> ossimKeywordlist::KeywordMap

Definition at line 55 of file ossimKeywordlist.h.

Member Enumeration Documentation

◆ KeywordlistParseState

enum ossimKeywordlist::KeywordlistParseState

protected

Enumerator
KeywordlistParseState_OK
KeywordlistParseState_FAIL
KeywordlistParseState_BAD_STREAM

Definition at line 548 of file ossimKeywordlist.h.

    {
       KeywordlistParseState_OK         = 0,
       
       // Used to say this set of token has failed the rules.
       KeywordlistParseState_FAIL       = 1,
 
       // Means an error occured that is a mal formed stream for Keywordlist.
       KeywordlistParseState_BAD_STREAM = 2, 
    };

Constructor & Destructor Documentation

◆ ossimKeywordlist() [1/5]

ossimKeywordlist::ossimKeywordlist ( const ossimKeywordlist & src )

Definition at line 40 of file ossimKeywordlist.cpp.

 :m_map(src.m_map),
 m_delimiter(src.m_delimiter),
 m_preserveKeyValues(src.m_preserveKeyValues),
 m_expandEnvVars(src.m_expandEnvVars)
 {
 }

◆ ossimKeywordlist() [2/5]

ossimKeywordlist::ossimKeywordlist ( const std::map< std::string, std::string > & keywordMap )

Definition at line 48 of file ossimKeywordlist.cpp.

 :m_map(keywordMap),
 m_delimiter(DEFAULT_DELIMITER),
 m_preserveKeyValues(true),
 m_expandEnvVars(true)
 {
 
 }

◆ ossimKeywordlist() [3/5]

ossimKeywordlist::ossimKeywordlist	(	char	delimiter = `DEFAULT_DELIMITER`,
		bool	expandEnvVars = `false`
	)

Definition at line 57 of file ossimKeywordlist.cpp.

References ossimNotify(), and ossimNotifyLevel_DEBUG.

 :
 m_map(),
 m_delimiter(delimiter),
 m_preserveKeyValues(true),
 m_expandEnvVars(expandEnvVars)
 {
 #ifdef OSSIM_ID_ENABLED
    if (TRACE) ossimNotify(ossimNotifyLevel_DEBUG) << OSSIM_ID << std::endl;
 #endif
 }

◆ ossimKeywordlist() [4/5]

ossimKeywordlist::ossimKeywordlist	(	const char *	file,
		char	delimiter = `DEFAULT_DELIMITER`,
		bool	ignoreBinaryChars = `false`,
		bool	expandEnvVars = `false`
	)

Definition at line 70 of file ossimKeywordlist.cpp.

References ossimErrorCodes::OSSIM_ERROR, parseFile(), and ossimErrorStatusInterface::theErrorStatus.

 :
 m_map(),
 m_delimiter(delimiter),
 m_preserveKeyValues(true),
 //m_lineContinuationCharacter('\\'),
 m_expandEnvVars(expandEnvVars)
 {
    ossimFilename in_file(file);
    
    if (!parseFile(in_file, ignoreBinaryChars))
    {
       theErrorStatus = ossimErrorCodes::OSSIM_ERROR;
    }
 }

◆ ossimKeywordlist() [5/5]

ossimKeywordlist::ossimKeywordlist	(	const ossimFilename &	fileName,
		char	delimiter = `DEFAULT_DELIMITER`,
		bool	ignoreBinaryChars = `false`,
		bool	expandEnvVars = `false`
	)

Definition at line 89 of file ossimKeywordlist.cpp.

References ossimErrorCodes::OSSIM_ERROR, parseFile(), and ossimErrorStatusInterface::theErrorStatus.

 :
 m_map(),
 m_delimiter(delimiter),
 m_preserveKeyValues(true),
 m_expandEnvVars(expandEnvVars)
 
 {
    if (!parseFile(file, ignoreBinaryChars))
    {
       theErrorStatus = ossimErrorCodes::OSSIM_ERROR;
    }
 }

◆ ~ossimKeywordlist()

ossimKeywordlist::~ossimKeywordlist ( )

Definition at line 106 of file ossimKeywordlist.cpp.

References m_map.

 {
    m_map.clear();
 }

Member Function Documentation

◆ add() [1/22]

void ossimKeywordlist::add	(	const char *	prefix,
		const ossimKeywordlist &	kwl,
		bool	overwrite = `true`
	)

Definition at line 177 of file ossimKeywordlist.cpp.

References addPair(), and m_map.

 {
    std::string p = prefix ? prefix : "";
    std::map<std::string, std::string>::const_iterator iter = kwl.m_map.begin();
    while(iter != kwl.m_map.end())
    {
       std::string k( p + (*iter).first );
       addPair( k, (*iter).second, overwrite );
       ++iter;
    }
 }

◆ add() [2/22]

void ossimKeywordlist::add	(	const ossimKeywordlist &	kwl,
		const char *	prefix = `0`,
		bool	stripPrefix = `true`
	)

Allows you to extract out a sub keywordlist from another you can also collapse the hieracrchy by setting strip prefix to true.

Definition at line 144 of file ossimKeywordlist.cpp.

References addPair(), ossimRegExp::compile(), ossimRegExp::find(), m_map, ossimString::string(), and ossimString::substitute().

 {
    std::map<std::string, std::string>::const_iterator iter = kwl.m_map.begin();
    
    ossimRegExp regExp;
    
    // Check for null prefix.
    std::string tmpPrefix;
    if (prefix) tmpPrefix = prefix;
    
    regExp.compile(("^("+tmpPrefix+")").c_str());
    
    while(iter != kwl.m_map.end())
    {
       ossimString newKey;
       
       if(regExp.find( (*iter).first.c_str()))
       {
          newKey = (*iter).first;
          if(stripPrefix && prefix)
          {
             newKey = newKey.substitute(prefix, "");
             
          }
          
          addPair(newKey.string(), (*iter).second, true);
       }
       ++iter;
    }
 }

◆ add() [3/22]

void ossimKeywordlist::add	(	const char *	key,
		const char *	value,
		bool	overwrite = `true`
	)

Definition at line 225 of file ossimKeywordlist.cpp.

References addPair().

 {
    if ( key )
    {
       std::string k(key);
       std::string v(value?value:"");
       addPair(k, v, overwrite);
    }
 }

◆ add() [4/22]

void ossimKeywordlist::add	(	const char *	prefix,
		const char *	key,
		const char *	value,
		bool	overwrite = `true`
	)

Definition at line 237 of file ossimKeywordlist.cpp.

References addPair().

 {
    if ( key )
    {
       std::string k(prefix ? (std::string(prefix)+std::string(key)) : key);
       std::string v(value ? value : "");
       addPair(k, v, overwrite);
    }
 }

◆ add() [5/22]

void ossimKeywordlist::add	(	const char *	key,
		char	value,
		bool	overwrite = `true`
	)

Definition at line 250 of file ossimKeywordlist.cpp.

References addPair().

 {
    if ( key )
    {
       std::string k(key);
       std::string v(1, value);
       addPair(k, v, overwrite);
    }
 }

◆ add() [6/22]

void ossimKeywordlist::add	(	const char *	prefix,
		const char *	key,
		char	value,
		bool	overwrite = `true`
	)

Definition at line 262 of file ossimKeywordlist.cpp.

References addPair().

 {
    if ( key )
    {
       std::string k(prefix ? (std::string(prefix)+std::string(key)) : key);
       std::string v(1, value);
       addPair(k, v, overwrite);
    }
 }

◆ add() [7/22]

void ossimKeywordlist::add	(	const char *	key,
		ossim_int16	value,
		bool	overwrite = `true`
	)

Definition at line 275 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(key);
       std::string v = ossimString::toString(value).string();
       addPair(k, v, overwrite);
    }
 }

◆ add() [8/22]

void ossimKeywordlist::add	(	const char *	prefix,
		const char *	key,
		ossim_int16	value,
		bool	overwrite = `true`
	)

Definition at line 287 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(prefix ? (std::string(prefix)+std::string(key)) : key);
       std::string v = ossimString::toString(value).string();
       addPair(k, v, overwrite);
    }
 }

◆ add() [9/22]

void ossimKeywordlist::add	(	const char *	key,
		ossim_uint16	value,
		bool	overwrite = `true`
	)

Definition at line 300 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(key);
       std::string v = ossimString::toString(value).string();
       addPair(k, v, overwrite);
    }
 }

◆ add() [10/22]

void ossimKeywordlist::add	(	const char *	prefix,
		const char *	key,
		ossim_uint16	value,
		bool	overwrite = `true`
	)

Definition at line 312 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(prefix ? (std::string(prefix)+std::string(key)) : key);
       std::string v = ossimString::toString(value).string();
       addPair(k, v, overwrite);
    }
 }

◆ add() [11/22]

void ossimKeywordlist::add	(	const char *	key,
		ossim_int32	value,
		bool	overwrite = `true`
	)

Definition at line 325 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(key);
       std::string v = ossimString::toString(value).string();
       addPair(k, v, overwrite);
    }
 }

◆ add() [12/22]

void ossimKeywordlist::add	(	const char *	prefix,
		const char *	key,
		ossim_int32	value,
		bool	overwrite = `true`
	)

Definition at line 337 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(prefix ? (std::string(prefix)+std::string(key)) : key);
       std::string v = ossimString::toString(value).string();
       addPair(k, v, overwrite);
    }
 }

◆ add() [13/22]

void ossimKeywordlist::add	(	const char *	key,
		ossim_uint32	value,
		bool	overwrite = `true`
	)

Definition at line 350 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(key);
       std::string v = ossimString::toString(value).string();
       addPair(k, v, overwrite);
    }
 }

◆ add() [14/22]

void ossimKeywordlist::add	(	const char *	prefix,
		const char *	key,
		ossim_uint32	value,
		bool	overwrite = `true`
	)

Definition at line 362 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(prefix ? (std::string(prefix)+std::string(key)) : key);
       std::string v = ossimString::toString(value).string();
       addPair(k, v, overwrite);
    }
 }

◆ add() [15/22]

void ossimKeywordlist::add	(	const char *	key,
		ossim_int64	value,
		bool	overwrite = `true`
	)

Definition at line 375 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(key);
       std::string v = ossimString::toString(value).string();
       addPair(k, v, overwrite);
    }
 }

◆ add() [16/22]

void ossimKeywordlist::add	(	const char *	prefix,
		const char *	key,
		ossim_int64	value,
		bool	overwrite = `true`
	)

Definition at line 387 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(prefix ? (std::string(prefix)+std::string(key)) : key);
       std::string v = ossimString::toString(value).string();
       addPair(k, v, overwrite);
    }
 }

◆ add() [17/22]

void ossimKeywordlist::add	(	const char *	key,
		ossim_uint64	value,
		bool	overwrite = `true`
	)

Definition at line 400 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(key);
       std::string v = ossimString::toString(value).string();
       addPair(k, v, overwrite);
    }
 }

◆ add() [18/22]

void ossimKeywordlist::add	(	const char *	prefix,
		const char *	key,
		ossim_uint64	value,
		bool	overwrite = `true`
	)

Definition at line 412 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(prefix ? (std::string(prefix)+std::string(key)) : key);
       std::string v = ossimString::toString(value).string();
       addPair(k, v, overwrite);
    }
 }

◆ add() [19/22]

void ossimKeywordlist::add	(	const char *	key,
		ossim_float32	value,
		bool	overwrite = `true`,
		int	precision = `8`
	)

Parameters

key	Key for key-value pair.
value	Value to pair with key. Note this will be stored as a string.
precision	Decimal point precision of the output. (default = 8)
trimZeroFlag	If true trailing '0's and any trailing '.' will be trimmed from the converted string. (default = false)
scientific	If true output will be in scientific notation else fixed is used. (default = false)

Definition at line 425 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(key);
       std::string v = ossimString::toString(value, precision).string();
       addPair(k, v, overwrite);
    }
 }

◆ add() [20/22]

void ossimKeywordlist::add	(	const char *	prefix,
		const char *	key,
		ossim_float32	value,
		bool	overwrite = `true`,
		int	precision = `8`
	)

Parameters

key	Key for key-value pair.
value	Value to pair with key. Note this will be stored as a string.
precision	Decimal point precision of the output. (default = 8)
trimZeroFlag	If true trailing '0's and any trailing '.' will be trimmed from the converted string. (default = false)
scientific	If true output will be in scientific notation else fixed is used. (default = false)

Definition at line 438 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(prefix ? (std::string(prefix)+std::string(key)) : key);
       std::string v = ossimString::toString(value, precision).string();
       addPair(k, v, overwrite);
    }
 }

◆ add() [21/22]

void ossimKeywordlist::add	(	const char *	key,
		ossim_float64	value,
		bool	overwrite = `true`,
		int	precision = `15`
	)

Parameters

key	Key for key-value pair.
value	Value to pair with key. Note this will be stored as a string.
precision	Decimal point precision of the output. (default = 15)
trimZeroFlag	If true trailing '0's and any trailing '.' will be trimmed from the converted string. (default = false)
scientific	If true output will be in scientific notation else fixed is used. (default = false)

Definition at line 452 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(key);
       std::string v = ossimString::toString(value, precision).string();
       addPair(k, v, overwrite);
    }
 }

◆ add() [22/22]

void ossimKeywordlist::add	(	const char *	prefix,
		const char *	key,
		ossim_float64	value,
		bool	overwrite = `true`,
		int	precision = `15`
	)

Parameters

key	Key for key-value pair.
value	Value to pair with key. Note this will be stored as a string.
precision	Decimal point precision of the output. (default = 15)
trimZeroFlag	If true trailing '0's and any trailing '.' will be trimmed from the converted string. (default = false)
scientific	If true output will be in scientific notation else fixed is used. (default = false)

Definition at line 465 of file ossimKeywordlist.cpp.

References addPair(), ossimString::string(), and ossimString::toString().

 {
    if ( key )
    {
       std::string k(prefix ? (std::string(prefix)+std::string(key)) : key);
       std::string v = ossimString::toString(value, precision).string();
       addPair(k, v, overwrite);
    }
 }

◆ addFile() [1/2]

bool ossimKeywordlist::addFile ( const char * file )

Reads file and adds keywords to the KeywordMap. Returns true if file was parsed, false on error.

Definition at line 121 of file ossimKeywordlist.cpp.

References parseFile().

Referenced by ossimSensorModelFactory::createProjection(), ossimMapProjectionFactory::createProjection(), ossimMiscProjectionFactory::createProjection(), ossimPointCloudTool::execute(), ossimBatchTest::execute(), ossimGeneralRasterTileSource::getHdrInfo(), ossimTool::getKwlTemplate(), ossimChipProcTool::initialize(), ossimNitfWriterBase::initializeDefaultsFromConfigFile(), ossimGeneralRasterInfo::initializeFromHdr(), ossimGdalOgrVectorAnnotation::loadExternalGeometryFile(), ossimDtedTileSource::loadMetaData(), ossimGdalOgrVectorAnnotation::loadOmdFile(), ossimMapViewController::loadState(), ossimRgbLutDataObject::loadState(), ossimNBandLutDataObject::loadState(), ossimERSTileSource::open(), ossimKakaduJpipHandler::open(), ossimKakaduJpipInfo::open(), ossimNBandLutDataObject::open(), ossimInfo::openImageFromState(), ossimInfo::openImageHandler(), ossimEquationUtil::parseKwl(), readPreprocDirective(), ossimMapViewController::setFilename(), ossimGeneralRasterElevHandler::setFilename(), ossimNBandToIndexFilter::setProperty(), ossimApplanixUtmModel::setupOptimizer(), ossimSpectraboticsRedEdgeModel::setupOptimizer(), ossimApplanixEcefModel::setupOptimizer(), ossimSpot5Model::setupOptimizer(), ossimplugins::ossimFormosatModel::setupOptimizer(), ossimRpcProjection::setupOptimizer(), and ossimRpcModel::setupOptimizer().

 {
    ossimFilename in_file(file);
    
    return parseFile(in_file);
 }

◆ addFile() [2/2]

bool ossimKeywordlist::addFile ( const ossimFilename & file )

Reads file and adds keywords to the KeywordMap. Returns true if file was parsed, false on error.

Definition at line 128 of file ossimKeywordlist.cpp.

References parseFile().

 {
    return parseFile(file);
 }

◆ addList()

void ossimKeywordlist::addList	(	const ossimKeywordlist &	src,
		bool	overwrite = `true`
	)

Add contents of another keyword list to this one.

Parameters

src	the keyword list to copy items from.
overwrite	true if keys existing in this and src should have their value overwritten by the src value, otherwise false to preserve the original value. Defaults to true.

Definition at line 133 of file ossimKeywordlist.cpp.

References addPair(), and m_map.

Referenced by ossimEpsgProjectionFactory::createProjection(), ossimChipperUtil::getChip(), ossimVerticesFinderTool::initialize(), ossimPotraceTool::initialize(), ossimHlzTool::initialize(), ossimShorelineTool::initialize(), ossimHdf5Tool::initialize(), ossimChipProcTool::initialize(), ossimAutRegUtil::initialize(), and ossimChipperUtil::initialize().

 {
    KeywordMap::const_iterator i = src.m_map.begin();
    
    while (i != src.m_map.end())
    {
       addPair( (*i).first, (*i).second, overwrite );
       i++;
    }
 }

◆ addPair() [1/2]

void ossimKeywordlist::addPair	(	const std::string &	key,
		const std::string &	value,
		bool	overwrite = `true`
	)

Definition at line 191 of file ossimKeywordlist.cpp.

References ossimString::expandEnvironmentVariable(), getMapEntry(), m_expandEnvVars, m_map, and ossimString::string().

 {
    if ( key.size() )
    {
       ossimString v = value;
       if ( m_expandEnvVars == true )
       {
          v = v.expandEnvironmentVariable();
       }
       
       KeywordMap::iterator i = getMapEntry(key);
       
       if (i == m_map.end())
       {
          m_map.insert(std::make_pair(key, v.string()));
       }
       else if (overwrite)
       {
          (*i).second = v.string();
       }
    }
 }

◆ addPair() [2/2]

void ossimKeywordlist::addPair	(	const std::string &	prefix,
		const std::string &	key,
		const std::string &	value,
		bool	overwrite = `true`
	)

Definition at line 216 of file ossimKeywordlist.cpp.

References addPair().

 {
    std::string k(prefix + key);
    addPair(k, value, overwrite);
 }

◆ addPrefixToAll()

void ossimKeywordlist::addPrefixToAll ( const ossimString & prefix )

Definition at line 1237 of file ossimKeywordlist.cpp.

References addPair(), clear(), m_map, and ossimString::string().

Referenced by ossimEnviInfo::print(), and ossimKakaduJpipInfo::print().

 {
    ossimKeywordlist tempKwl = *this;
    
    clear();
    
    KeywordMap::const_iterator values = tempKwl.m_map.begin();
    
    while(values != tempKwl.m_map.end())
    {
       std::string newKey = prefix.string() + (*values).first;
       addPair(newKey, (*values).second, true);
       ++values;
    }
 }

◆ addPrefixToKeysThatMatch()

void ossimKeywordlist::addPrefixToKeysThatMatch	(	const ossimString &	prefix,
		const ossimString &	regularExpression
	)

Definition at line 1253 of file ossimKeywordlist.cpp.

References addPair(), ossimString::c_str(), clear(), ossimRegExp::compile(), ossimRegExp::find(), m_map, and ossimString::string().

 {
    ossimKeywordlist tempKwl = *this;
    
    clear();
    
    KeywordMap::const_iterator values = tempKwl.m_map.begin();
    ossimRegExp regExp;
    
    regExp.compile(regularExpression.c_str());
    
    while(values != tempKwl.m_map.end())
    {
       std::string newKey = prefix.string()+(*values).first;
       if(regExp.find( (*values).first.c_str()))
       {
          
          addPair(newKey, (*values).second, true);
       }
       else
       {
          addPair((*values).first, (*values).second, true);
       }
       ++values;
    }
 }

◆ change_delimiter()

void ossimKeywordlist::change_delimiter ( char del )

Method to change default delimiter. Handy when parsing files similar to a ossimKeywordlist. (DEFAULT = ':')

Definition at line 1325 of file ossimKeywordlist.cpp.

References m_delimiter.

Referenced by ossimGeneralRasterTileSource::getHdrInfo(), and ossimGeneralRasterInfo::initializeFromHdr().

 {
    m_delimiter = del;
 }

◆ clear()

void ossimKeywordlist::clear ( )

Clear all contents out of the ossimKeywordlist.

Definition at line 693 of file ossimKeywordlist.cpp.

References m_map.

Referenced by addPrefixToAll(), addPrefixToKeysThatMatch(), ossimImageGeometryEvent::clearGeometry(), ossimFgdcTxtDoc::close(), ossimHttpResponse::convertHeaderStreamToKeywordlist(), ossimSensorModelFactory::createProjection(), demo1(), demo3(), ossimIgenGenerator::generateInputKwl(), ossimIgenGenerator::generateNoTiledSpecList(), ossimIgenGenerator::generateOutputKwl(), ossimIgenGenerator::generateViewKwl(), ossimHdf5Info::getKeywordlist(), ossimHdf5Info::getKeywordlistDataset(), ossimHdf5Info::getKeywordlistGroup(), ossimIgenGenerator::getSpec(), ossimVerticesFinderTool::initialize(), ossimPotraceTool::initialize(), ossimHlzTool::initialize(), ossimShorelineTool::initialize(), ossimHdf5Tool::initialize(), ossimChipProcTool::initialize(), ossimAutRegUtil::initialize(), ossimChipperUtil::initialize(), ossimEnviHeader::readStream(), ossimEnviHeader::reset(), ossimGeneralRasterElevHandler::setFilename(), ossimIgenGenerator::setOutput(), ossimGdalWriter::setOutputImageType(), ossimGdalWriter::setProperty(), ossimRpcProjection::setupOptimizer(), ossimRpcModel::setupOptimizer(), ossimIgen::slaveSetup(), and stripPrefixFromAll().

 {
    m_map.clear();
 }

◆ delimiter_str()

ossimString ossimKeywordlist::delimiter_str ( ) const

Definition at line 1330 of file ossimKeywordlist.cpp.

References m_delimiter.

Referenced by print(), toString(), and writeToStream().

 {
    char tmp[2];
    tmp[0] = m_delimiter;
    tmp[1] = '\0';
    return ossimString(tmp);
 }

◆ downcaseKeywords()

ossimKeywordlist & ossimKeywordlist::downcaseKeywords ( )

Definition at line 1394 of file ossimKeywordlist.cpp.

References ossimString::downcase(), m_map, and ossimString::string().

Referenced by ossimGeneralRasterTileSource::getHdrInfo(), ossimGeneralRasterTileSource::getImageGeometry(), and ossimGeneralRasterInfo::initializeFromHdr().

 {
    KeywordMap tempMap;
    KeywordMap::iterator iter = m_map.begin();
    
    while(iter != m_map.end())
    {
       ossimString k(iter->first);
       tempMap.insert(std::make_pair(k.downcase().string(), iter->second));
       ++iter;
    }
    m_map = tempMap;
    
    return *this;
 }

◆ extractKeysThatMatch()

void ossimKeywordlist::extractKeysThatMatch	(	ossimKeywordlist &	kwl,
		const ossimString &	regularExpression
	)		const

Definition at line 1160 of file ossimKeywordlist.cpp.

References addPair(), ossimString::c_str(), ossimRegExp::compile(), ossimRegExp::find(), and m_map.

Referenced by ossimGpkgWriter::loadState(), and ossimHistogram::loadState().

 {
    KeywordMap::const_iterator i;
    std::vector<ossimString> result;
    ossimRegExp regExp;
    
    regExp.compile(regularExpression.c_str());
    
    for(i = m_map.begin(); i != m_map.end(); ++i)
    {
       if(regExp.find( (*i).first.c_str()))
       {
          kwl.addPair((*i).first, (*i).second);
       }
    }
 }

◆ find() [1/2]

const char * ossimKeywordlist::find ( const char * key ) const

Definition at line 599 of file ossimKeywordlist.cpp.

References m_map.

 {
    const char* result = 0;
    if (key)
    {
       std::string k = key;
       KeywordMap::const_iterator i = m_map.find( k );
       if (i != m_map.end())
       {
          result = (*i).second.c_str();
       }
    }
    return result;
 }

◆ find() [2/2]

const char * ossimKeywordlist::find	(	const char *	prefix,
		const char *	key
	)		const

Definition at line 614 of file ossimKeywordlist.cpp.

References m_map.

 {
    const char* result = 0;
    if (key)
    {
       std::string k;
       if (prefix) k = prefix;
       k += key;
       KeywordMap::const_iterator i = m_map.find( k );
       if (i != m_map.end())
       {
          result = (*i).second.c_str();
       }
    }
    return result;
 }

◆ findAllKeysThatContains()

std::vector< ossimString > ossimKeywordlist::findAllKeysThatContains ( const ossimString & searchString ) const

Will return a list of keys that contain the string passed in. Later we will need to allow a user to specify regular expresion searches.

Definition at line 1112 of file ossimKeywordlist.cpp.

References ossimString::contains(), and m_map.

 {
    KeywordMap::const_iterator i;
    std::vector<ossimString> result;
    
    for(i = m_map.begin(); i != m_map.end(); ++i)
    {
       if( ossimString((*i).first).contains(searchString))
       {
          result.push_back((*i).first);
       }
    }
    
    return result;
 }

◆ findAllKeysThatMatch()

void ossimKeywordlist::findAllKeysThatMatch	(	std::vector< ossimString > &	result,
		const ossimString &	regularExpression
	)		const

Finds keys that match regular expression.

Note: This does not clear vector passed to it.

Parameters

result	Initialized by this.
regularExpression	e.g. "image[0-9]*\\.file"

Definition at line 1128 of file ossimKeywordlist.cpp.

References ossimString::c_str(), ossimRegExp::compile(), ossimRegExp::find(), and m_map.

Referenced by getKeyValue().

 {
    KeywordMap::const_iterator i;
    ossimRegExp regExp;
    regExp.compile(regularExpression.c_str());
    for(i = m_map.begin(); i != m_map.end(); ++i)
    {
       if(regExp.find( (*i).first.c_str()))
       {
          result.push_back((*i).first);
       }
    }
 }

◆ findKey() [1/2]

const std::string & ossimKeywordlist::findKey ( const std::string & key ) const

Find methods that take std::string(s).

Searches the map for key(/prefix) and returns the resulting value or an empty string if the key was not found.

Parameters

key	e.g. "number_line"
prefix	e..g "image0."

Returns: Reference to string. This will be empty if not found or if value is empty.

Definition at line 580 of file ossimKeywordlist.cpp.

References m_map, and NULL_KW.

 {
    // std::string result;
    KeywordMap::const_iterator i = m_map.find(key);
    if (i != m_map.end())
    {
       // result = (*i).second;
       return (*i).second;
    }
    return ossimKeywordlist::NULL_KW;
 }

◆ findKey() [2/2]

const std::string & ossimKeywordlist::findKey	(	const std::string &	prefix,
		const std::string &	key
	)		const

Definition at line 592 of file ossimKeywordlist.cpp.

References findKey().

 {
    std::string k = prefix+key;
    return findKey(k);
 }

◆ findValue()

template<class CompareType >

bool ossimKeywordlist::findValue	(	ossimString &	value,
		const CompareType &	compare
	)		const

inline

This is a generic find method that takes a comparator type and iterates through the map executing the overloaded operator ().

Typical code example format

typedef std::unary_function<std::pair<ossimString, ossimString>, bool> KwlCompareFunctionType;

class KwlKeyCaseInsensitiveEquals : public KwlCompareFunctionType
{
public:
   KwlKeyCaseInsensitiveEquals(const ossimString& key):m_key(key){}
   virtual bool operator()(const KwlComparePairType& rhs)const
   {
      return (m_key == rhs.first.downcase());
   }
   ossimString m_key;
};

// now for use case example:
kwl.findValue(value, KwlKeyCaseInsensitiveEquals("foo"));

This example shows how to supplly your own comparator and do a case insensitive search for the key foo and the value is set to the variable value.

Definition at line 138 of file ossimKeywordlist.h.

Referenced by ossimEnviHeader::findSubStringCaseInsensitive().

    {
       KeywordMap::const_iterator iter = std::find_if(m_map.begin(), m_map.end(), compare);
       bool result = (iter != m_map.end());
       if(result) value = iter->second;
       return result;
    }

◆ getBoolKeywordValue()

bool ossimKeywordlist::getBoolKeywordValue	(	bool &	rtn_val,
		const char *	keyword,
		const char *	prefix = `0`
	)		const

[OLK, Aug/2008] Sets the boolean <rtn_val> depending on value associated with keyword for values = (yes|no|true|false|1|0).

[OLK, Aug/2008] Sets the boolean destination arg depending on value associated with keyword for values = (yes|no|true|false|1|0).

Returns TRUE if keyword found, otherwise false. Also returns false if none of the above permitted values are specified (rtn_val left unchanged in this case).

Definition at line 1453 of file ossimKeywordlist.cpp.

References find(), and ossimString::upcase().

Referenced by ossimBandMergeTool::initialize().

 {
    bool found = true;
    const char* val_str = find(prefix, keyword);
    if (val_str) 
    {
       found = true;
       ossimString yesno (val_str);
       yesno.upcase();
       if ((yesno == "YES") || (yesno == "TRUE") || (yesno == "1"))
          rtn_val = true;
       else if ((yesno == "NO") || (yesno == "FALSE") || (yesno == "0"))
          rtn_val = false;
       else
          found = false;
    }
    else
       found = false;
    
    return found;
 }

◆ getExpandEnvVarsFlag()

bool ossimKeywordlist::getExpandEnvVarsFlag ( void ) const

Returns the flag that determines whether or not environment variables are expanded.

Definition at line 116 of file ossimKeywordlist.cpp.

References m_expandEnvVars.

 {
    return m_expandEnvVars;
 }

◆ getMap() [1/2]

const ossimKeywordlist::KeywordMap & ossimKeywordlist::getMap ( ) const

Definition at line 1315 of file ossimKeywordlist.cpp.

References m_map.

Referenced by ossimProjectionFactoryRegistry::createProjection(), ossimXmlDocument::fromKwl(), ossimCurlHttpRequest::getContentLength(), ossimHistogram::loadState(), and ossimUrl::setParams().

 {
    return m_map;
 }

◆ getMap() [2/2]

ossimKeywordlist::KeywordMap & ossimKeywordlist::getMap ( )

Definition at line 1320 of file ossimKeywordlist.cpp.

References m_map.

 {
    return m_map;
 }

◆ getMapEntry() [1/3]

ossimKeywordlist::KeywordMap::iterator ossimKeywordlist::getMapEntry ( const std::string & key )

protected

Definition at line 713 of file ossimKeywordlist.cpp.

References m_map.

Referenced by addPair().

 {
    return m_map.find(key);
 }

◆ getMapEntry() [2/3]

ossimKeywordlist::KeywordMap::iterator ossimKeywordlist::getMapEntry ( const ossimString & key )

protected

Definition at line 719 of file ossimKeywordlist.cpp.

References m_map, and ossimString::string().

 {
    return m_map.find(key.string());
 }

◆ getMapEntry() [3/3]

ossimKeywordlist::KeywordMap::iterator ossimKeywordlist::getMapEntry ( const char * key )

protected

Definition at line 699 of file ossimKeywordlist.cpp.

References m_map.

 {
    if (key)
    {
       std::string k = key;
       return m_map.find(k);
    }
    else
    {
       return m_map.end();
    }
 }

◆ getNumberOfKeysThatMatch()

ossim_uint32 ossimKeywordlist::getNumberOfKeysThatMatch ( const ossimString & regularExpression ) const

Gets number keys that match regular expression.

Parameters

regularExpression e.g. "image[0-9]*\\.file"

Returns: Number of keys matching regular expression.

Definition at line 1143 of file ossimKeywordlist.cpp.

References ossimString::c_str(), ossimRegExp::compile(), ossimRegExp::find(), and m_map.

Referenced by ossimChipperUtil::getNumberOfInputs(), and ossimChipperUtil::hasAnnotations().

 {
    ossim_uint32 result = 0;
    KeywordMap::const_iterator i;
    ossimRegExp regExp;
    regExp.compile(regularExpression.c_str());
    for(i = m_map.begin(); i != m_map.end(); ++i)
    {
       if(regExp.find( (*i).first.c_str()))
       {
          ++result;
       }
    }
    return result;
 }

◆ getNumberOfSubstringKeys()

ossim_uint32 ossimKeywordlist::getNumberOfSubstringKeys ( const ossimString & regularExpression ) const

Definition at line 1229 of file ossimKeywordlist.cpp.

References getSubstringKeyList().

 {
    KeywordMap::const_iterator i;
    std::vector<ossimString> currentList;
    getSubstringKeyList(currentList, regularExpression);
    return (ossim_uint32)currentList.size();
 }

◆ getSize()

ossim_uint32 ossimKeywordlist::getSize ( ) const

Returns the number of elements.

Definition at line 1310 of file ossimKeywordlist.cpp.

References m_map.

Referenced by ossimInfo::execute(), ossimIgenGenerator::generateNoTiledSpecList(), ossimChipperUtil::getChip(), ossimFgdcTxtDoc::getProjectionV1(), ossimImageGeometryEvent::isGeometrySet(), ossimSrcRecord::loadState(), ossimBatchTest::preprocessKwl(), and ossimGdalWriter::storeProperty().

 {
    return (ossim_uint32)m_map.size();
 }

◆ getSortedList()

void ossimKeywordlist::getSortedList	(	std::vector< ossimString > &	prefixValues,
		const ossimString &	prefixKey
	)		const

This return the sorted keys if you have a list.

Example:

// given a keywordlist called kwl with contents: 
// my.list.element1.prop
// my.list.element345.prop
// my.list.element22.prop
std::vector<ossimString> sortedPrefixValues;
kwl.getSortedList(sortedPrefixValues, "my.list.element");
if(sortedPrefixValues.size())
{
// contents should be my.list.element1, my.list.element22, my.list.element345
}

Definition at line 1086 of file ossimKeywordlist.cpp.

References ossimString::clear(), getSubstringKeyList(), ossimString::size(), ossimString::toInt(), and ossimString::toString().

 {
    ossimString regExpression     =  ossimString("^(") + prefixKey+ "[0-9]+)";
    prefixValues.clear();
    std::vector<ossimString> keys;
    getSubstringKeyList(keys, regExpression);
    ossim_uint32 nKeys = (long)keys.size();
 
    ossim_uint32 offset = (int)ossimString(prefixKey).size();
    ossim_uint32 idx = 0;
    std::vector<ossim_uint32> numberList(nKeys);
    for(idx = 0; idx < (ossim_uint32)numberList.size();++idx)
    {
     ossimString numberStr(keys[idx].begin() + offset,
            keys[idx].end());
     numberList[idx] = numberStr.toInt();
    }
    std::sort(numberList.begin(), numberList.end());
 
    for(idx=0;idx < (ossim_uint32)numberList.size();++idx)
    {
       prefixValues.push_back(prefixKey+ossimString::toString(numberList[idx]));
    }
 }

◆ getSubstringKeyList() [1/2]

std::vector< ossimString > ossimKeywordlist::getSubstringKeyList ( const ossimString & regularExpression ) const

Will return only the portion of the key that matches the regular expression.

example:

source1.source1.a: source1.source2.a: source1.source3.a: source1.source4.a: source1.source10.a:

kwl.getSubstringKeyList("source1.source[0-9]*\\.");

will return:

source1.source1. source1.source2. source1.source3. source1.source4. source1.source10.

Definition at line 1199 of file ossimKeywordlist.cpp.

Referenced by ossimConnectableContainer::addAllObjects(), ossimImageChain::addAllSources(), ossimGdalWriter::allocateGdalDriverOptions(), ossimGdalWriter::appendGdalOption(), ossimBatchTest::execute(), ossimConnectableContainer::findInputConnectionIds(), ossimImageChain::findInputConnectionIds(), ossimImageMetaData::getBandCount(), getNumberOfSubstringKeys(), getSortedList(), ossimGdalWriter::getStoredPropertyValue(), ossimEpsgProjectionDatabase::initialize(), ossimInit::initializePlugins(), ossimVpfAnnotationSource::loadState(), ossimVpfAnnotationLibraryInfo::loadState(), ossimVpfAnnotationCoverageInfo::loadState(), ossimGeoPolyCutter::loadState(), ossimBandSelector::loadState(), ossimHistogram::loadState(), ossimBatchTest::processConfigList(), ossimStringListProperty::setValue(), ossimGdalWriter::storeProperty(), and ossimImageMetaData::updateMetaData().

 {
    std::vector<ossimString> result;
    getSubstringKeyList(result, regularExpression);
    return result;
 }

◆ getSubstringKeyList() [2/2]

void ossimKeywordlist::getSubstringKeyList	(	std::vector< ossimString > &	result,
		const ossimString &	regularExpression
	)		const

Definition at line 1206 of file ossimKeywordlist.cpp.

References ossimString::c_str(), ossimRegExp::compile(), ossimRegExp::end(), ossimRegExp::find(), m_map, ossimString::push_back(), and ossimRegExp::start().

 {
    KeywordMap::const_iterator i;
    ossimRegExp regExp;
    
    regExp.compile(regularExpression.c_str());
    
    for(i = m_map.begin(); i != m_map.end(); ++i)
    {
       if(regExp.find( (*i).first.c_str()))
       {
          ossimString value = ossimString((*i).first.begin()+regExp.start(),
                                          (*i).first.begin()+regExp.start()+regExp.end());
          
          if(std::find(result.begin(), result.end(), value) == result.end())
          {
             result.push_back(value);
          }
       }
    }
 }

◆ hasKey()

bool ossimKeywordlist::hasKey ( const std::string & key ) const

Checks for key in map.

Note that "find" and findKey will alway return an empty string even if the key in not in the map.

Returns: true if key is in map even if value is empty; false, if not.

Definition at line 569 of file ossimKeywordlist.cpp.

References m_map.

Referenced by ossimChipperUtil::getImageSpacePivot(), ossimChipperUtil::getImageSpaceScale(), ossimEnviHeader::getValue(), ossimChipperUtil::hasBandSelection(), ossimChipperUtil::hasCutBoxWidthHeight(), ossimChipperUtil::hasHistogramOperation(), ossimChipperUtil::hasScaleOption(), ossimChipperUtil::hasWmsBboxCutWidthHeight(), ossimViewshedTool::initializeAOI(), and ossimChipProcTool::initializeAOI().

 {
    bool result = false;
    KeywordMap::const_iterator i = m_map.find(key);
    if (i != m_map.end())
    {
       result = true;
    }
    return result;
 }

◆ isSame()

bool ossimKeywordlist::isSame	(	const std::vector< ossimString > &	a,
		const std::vector< ossimString > &	b
	)		const

protected

Returns: true if a == b, false if not.

Definition at line 1860 of file ossimKeywordlist.cpp.

 {
    bool result = true;
    if ( a.size() == b.size() )
    {
       for ( ossim_uint32 i = 0; i < a.size(); ++i )
       {
          if ( a[i] != b[i] )
          {
             result = false;
             break;
          }
       }
    }
    else
    {
       result = false;
    }
    return result;
 }

◆ isSpecialXmlCharacters()

bool ossimKeywordlist::isSpecialXmlCharacters ( const ossimString & value ) const

protected

Definition at line 1477 of file ossimKeywordlist.cpp.

References ossimString::begin(), and ossimString::end().

Referenced by toXML().

 {
    for(ossimString::const_iterator it = value.begin(); it != value.end();++it)
    {
       switch(*it)
       {
          case '&':
          case '<':
          case '>':
          case '"':
          case '\'':
          {
             return true;
          }
          default:
          {
             break;
          }
       }
       
    }
    return false;
 }

◆ isValidKeywordlistCharacter()

bool ossimKeywordlist::isValidKeywordlistCharacter ( ossim_uint8 c ) const

protected

Definition at line 757 of file ossimKeywordlist.cpp.

Referenced by readComments(), readKey(), and readValue().

 {
    if((c>=0x20&&c<=0x7e))
    {
       return true;
    }
    switch(c)
    {
       case '\n':
       case '\r':
       case '\t':
          return true;
    }
    return false;
 }

◆ isValidTag()

bool ossimKeywordlist::isValidTag ( const std::string & value ) const

protected

Definition at line 1501 of file ossimKeywordlist.cpp.

Referenced by toXML().

 {
    std::string::const_iterator textChars = value.begin();
    bool result = true;
    if(!isalpha(*(textChars) ))
    {
       result = false;
    }
    else if(!value.empty())
    {
       for(++textChars;textChars!=value.end();++textChars)
       {
          if(!isalnum(*(textChars) ))
          {
             result = false;
             break;
          }
       }
    }
    else
    {
       result = false;
    }
    
    return result;
 }

◆ numberOf() [1/2]

ossim_uint32 ossimKeywordlist::numberOf ( const char * str ) const

Searches the map for the number of keys containing the string.

Definition at line 661 of file ossimKeywordlist.cpp.

References ossimString::contains(), and m_map.

Referenced by ossimImageUtil::getNextReaderPropIndex(), ossimImageUtil::getNextWriterPropIndex(), ossimBandLutFilter::initializeLut(), ossimChipProcTool::loadDemFiles(), ossimChipProcTool::loadImageFiles(), ossimBilinearProjection::loadState(), ossimImageViewProjectionTransform::loadState(), ossimTiling::loadState(), numberOf(), ossimAutRegUtil::setReaderProps(), ossimChipProcTool::setReaderProps(), and ossimChipperUtil::setReaderProps().

 {
    ossim_uint32 count = 0;
    
    if (str)
    {
       KeywordMap::const_iterator i = m_map.begin();
       
       while (i != m_map.end())
       {
          if ( ossimString((*i).first).contains(str) )
          {
             ++count;
          }
          ++i;
       }
    }
    
    return count;
 }

◆ numberOf() [2/2]

ossim_uint32 ossimKeywordlist::numberOf	(	const char *	prefix,
		const char *	key
	)		const

Searches the map for the number of keys containing the prefix+key.

Given the keyword list contains:

source.type1: foo source.type2: you

This:

int number_of_sources = numberOf("source", "type");

number_of_sources equals 2

Definition at line 682 of file ossimKeywordlist.cpp.

References numberOf().

 {
    if ( key ) // Must have key, sometimes no prefix.
    {
       std::string k(prefix ? (std::string(prefix)+std::string(key)) : key);
       return numberOf(k.c_str());
    }
    return 0;
 }

◆ operator!=()

bool ossimKeywordlist::operator!= ( ossimKeywordlist & kwl ) const

Definition at line 1389 of file ossimKeywordlist.cpp.

References m_map.

 {
    return (m_map != kwl.m_map);
 }

◆ operator==()

bool ossimKeywordlist::operator== ( ossimKeywordlist & kwl ) const

Definition at line 1367 of file ossimKeywordlist.cpp.

References m_map.

 {
    return (m_map == kwl.m_map);
    /*
    if(this==&kwl) return true;
    std::map<std::string, std::string>::const_iterator iter = m_map.begin();
    
    while(iter != m_map.end())
    {
       const char* value = kwl.find((*iter).first.c_str());
       
       if(ossimString(value) != (*iter).second)
       {
          return false;
       }
       ++iter;
    }
    
    return true;
    */
 }

◆ operator[]() [1/2]

std::string& ossimKeywordlist::operator[] ( const std::string & key )

inline

Definition at line 146 of file ossimKeywordlist.h.

    {
       return m_map[key];
    }

◆ operator[]() [2/2]

std::string ossimKeywordlist::operator[] ( const std::string & key ) const

inline

Definition at line 150 of file ossimKeywordlist.h.

References ossimString::c_str().

    {
       ossimString result = find(key.c_str());
       
       return result.c_str();
    }

◆ parseFile()

bool ossimKeywordlist::parseFile	(	const ossimFilename &	file,
		bool	ignoreBinaryChars = `false`
	)

protected

Method to parse files to initialize the list. Method will error on binary characters if "ignoreBinaryChars = false". This is used by ImageHandler factories that can be passed a binary file inadvertently by a user. The "ignoreBinaryChars" flag should be set to true if a text file contains mixed ascii/binary values. Returns true if file was parsed, false on error.

Definition at line 728 of file ossimKeywordlist.cpp.

References ossim::StreamFactoryRegistry::instance(), m_currentlyParsing, parseStream(), and ossimString::string().

Referenced by addFile(), and ossimKeywordlist().

 {
    bool result = false;
 
    std::shared_ptr<ossim::istream> is = ossim::StreamFactoryRegistry::instance()->
       createIstream( file.string() );
    if ( is )
    {
       m_currentlyParsing = file;
       result = parseStream(*is, ignoreBinaryChars);
       is.reset();
    }
    
    return result;
 }

◆ parseStream() [1/2]

bool ossimKeywordlist::parseStream	(	ossim::istream &	is,
		bool	ignoreBinaryChars
	)

virtual

deprecated method

Definition at line 745 of file ossimKeywordlist.cpp.

Referenced by ossimHttpResponse::convertHeaderStreamToKeywordlist(), ossimNitfInfo::getKeywordlist(), ossimInfoBase::getKeywordlist(), ossimMultiResLevelHistogram::importHistogram(), ossimImageHandler::loadMetaData(), ossimImageHandlerFactory::openSrcRecord(), parseFile(), parseString(), ossimNitfVqCompressionHeader::saveState(), ossimNitfImageHeaderV2_0::saveState(), ossimNitfRegisteredDes::saveState(), ossimNitfRegisteredTag::saveState(), ossimNitfImageHeaderV2_1::saveState(), ossimStringListProperty::setValue(), ossimFontProperty::setValue(), ossimIgen::slaveSetup(), and ossimTiffTileSource::validateMinMaxNull().

 {
    return parseStream(is);
 }

◆ parseStream() [2/2]

bool ossimKeywordlist::parseStream ( ossim::istream & is )

virtual

Definition at line 1020 of file ossimKeywordlist.cpp.

References ossimString::empty(), ossimString::expandEnvironmentVariable(), KeywordlistParseState_BAD_STREAM, KeywordlistParseState_FAIL, KeywordlistParseState_OK, m_expandEnvVars, m_map, readComments(), readKeyAndValuePair(), readPreprocDirective(), skipWhitespace(), ossimString::string(), and ossimString::trim().

 {
    if (!is) // Check stream state.
    {
       return false;
    }
    ossimString key;
    ossimString value;
    ossimString sequence;
    KeywordlistParseState state = KeywordlistParseState_OK;
    while(!is.eof() && !is.bad())
    {
       skipWhitespace(is);
       if(is.eof() || is.bad())
          return true; // we skipped to end so valid keyword list
 
       state = readPreprocDirective(is);
       if(state & KeywordlistParseState_BAD_STREAM)
          return false;
 
       // if we failed a preprocessor directive parse then try comment parse.
       if(state == KeywordlistParseState_FAIL)
       {
          state = readComments(sequence, is);
          if(state & KeywordlistParseState_BAD_STREAM)
             return false;
       }
 
       // if we failed a comment parse then try key value parse.
       if(state == KeywordlistParseState_FAIL)
       {
          key = sequence; // just in case there is a 1 token look ahead residual for a single slash test.
          ossimKeywordlist::KeywordlistParseState testKeyValueState = readKeyAndValuePair(key, value, is);
          if(testKeyValueState == KeywordlistParseState_OK)
          {
             key = key.trim();
             if(key.empty())
                return true;
 
             if ( m_expandEnvVars == true )
                value = value.expandEnvironmentVariable();
             m_map.insert(std::make_pair(key.string(), value.string()));
          }
          else if(testKeyValueState & KeywordlistParseState_BAD_STREAM)
          {
             return false;
          }
 #if 0
          // Commented out to allow an invalid line in keyword list without
          // erroring out, effectively skipping bad line. drb - 01 Sep. 2001
          else
          {
             return false;
          }
 #endif
       }
       else if(state & KeywordlistParseState_BAD_STREAM)
       {
          return false;
       }
       sequence = key = value = "";
    }   
    
    return true;
 }

◆ parseString()

bool ossimKeywordlist::parseString ( const std::string & inString )

virtual

Definition at line 750 of file ossimKeywordlist.cpp.

References parseStream().

Referenced by ossim::Image::loadJSON(), and ossimSharedLibraryInitialize().

 {
    ossim::istringstream in(inString);
    
    return parseStream(in);
 }

◆ print()

std::ostream & ossimKeywordlist::print ( std::ostream & out ) const

virtual

Outputs theErrorStatus as an ossimErrorCode and an ossimString.

Returns: std::ostream&

Note: Derived classes should only have to implement a virtual print, not an operator<< funtion as it's implemented here.

Reimplemented from ossimErrorStatusInterface.

Definition at line 1341 of file ossimKeywordlist.cpp.

References ossimString::c_str(), delimiter_str(), m_map, and writeToStream().

Referenced by ossimHdf5Tool::execute(), operator<<(), and ossimSarModel::print().

 {
    writeToStream(os);
 #if 0
    KeywordMap::const_iterator i;
    
    for(i = m_map.begin(); i != m_map.end(); ++i)
    {
       os << (*i).first << delimiter_str().c_str() << "  "
       << (*i).second << std::endl;
    }
 #endif
    return os;
 }

◆ readComments()

ossimKeywordlist::KeywordlistParseState ossimKeywordlist::readComments	(	ossimString &	sequence,
		ossim::istream &	in
	)		const

protected

Definition at line 784 of file ossimKeywordlist.cpp.

References isValidKeywordlistCharacter(), KeywordlistParseState_BAD_STREAM, KeywordlistParseState_FAIL, and KeywordlistParseState_OK.

Referenced by parseStream().

 {
    KeywordlistParseState result = KeywordlistParseState_FAIL;
    char c = (char)in.peek();
    if(c == '/')
    {
       sequence += (char)in.get();
       c = in.peek();
       if(c == '/')
       {
          result = KeywordlistParseState_OK;
          sequence += c;
          while(!in.bad()&&!in.eof())
          {
             c = (char)in.get();
             if (in.bad() || in.eof())
                break;
 
             if(!isValidKeywordlistCharacter(c))
             {
                result = KeywordlistParseState_BAD_STREAM;
                break;
             }
             if((c == '\n')|| (c == '\r'))
                break;
 
             sequence += c;
          }
       }
    }
    return result;
 }

◆ readKey()

ossimKeywordlist::KeywordlistParseState ossimKeywordlist::readKey	(	ossimString &	sequence,
		ossim::istream &	in
	)		const

protected

Definition at line 863 of file ossimKeywordlist.cpp.

References ossimString::begin(), ossimString::clear(), ossimString::empty(), isValidKeywordlistCharacter(), KeywordlistParseState_BAD_STREAM, KeywordlistParseState_FAIL, KeywordlistParseState_OK, m_delimiter, ossimString::size(), and ossimString::trim().

Referenced by readKeyAndValuePair().

 {
    KeywordlistParseState result = KeywordlistParseState_FAIL;
    if(!sequence.empty())
    {
       if(*(sequence.begin()+(sequence.size()-1)) == m_delimiter)
       {
          sequence = ossimString(sequence.begin(), sequence.begin() + (sequence.size()-1));
          return KeywordlistParseState_OK;
       }
    }
    // not a comment so read til key delimeter
    while(!in.eof() && in.good())
    {
       ossim_uint8 c = in.get();
       if( isValidKeywordlistCharacter(c) )
       {
          if ( (c == '\n') || (c == '\r') ) 
          {
             // Hit end of line with no delimiter.
             if ( in.peek() == EOF )
             {
                //---
                // Allowing on last line only.
                // Note the empty key will trigger parseStream to return true.
                //---
                sequence.clear();
                result = KeywordlistParseState_OK;
                break;
             }
             else // Line with no delimiter.
             {
                // mal formed input stream for keyword list specification
                result = KeywordlistParseState_BAD_STREAM;
                break;
             }
          }
          else if(c != m_delimiter)
          {
             sequence += (char)c;
          }
          else // at m_delimiter
          {
             result = KeywordlistParseState_OK;
             sequence = sequence.trim();
             break;
          }
       }
       else 
       {
          // mal formed input stream for keyword list specification
          result = KeywordlistParseState_BAD_STREAM;
          break;
       }
    }
    // we never found a delimeter so we are mal formed
    if(!sequence.empty()&&(result!=KeywordlistParseState_OK))
    {
       result = KeywordlistParseState_BAD_STREAM;
    }
    return result;
 }

◆ readKeyAndValuePair()

ossimKeywordlist::KeywordlistParseState ossimKeywordlist::readKeyAndValuePair	(	ossimString &	key,
		ossimString &	value,
		ossim::istream &	in
	)		const

protected

Definition at line 1011 of file ossimKeywordlist.cpp.

References KeywordlistParseState_BAD_STREAM, readKey(), and readValue().

Referenced by parseStream().

 {
    ossimKeywordlist::KeywordlistParseState keyState   = readKey(key, in);
    if(keyState & KeywordlistParseState_BAD_STREAM) return keyState;
    ossimKeywordlist::KeywordlistParseState valueState = readValue(value, in);
    return static_cast<ossimKeywordlist::KeywordlistParseState>( (static_cast<int>(keyState) |
                                                                  static_cast<int>(valueState)) );
 }

◆ readPreprocDirective()

ossimKeywordlist::KeywordlistParseState ossimKeywordlist::readPreprocDirective ( ossim::istream & in )

protected

Definition at line 818 of file ossimKeywordlist.cpp.

References addFile(), ossimString::after(), ossimString::before(), ossimString::empty(), ossimString::expandEnvironmentVariable(), KeywordlistParseState_FAIL, KeywordlistParseState_OK, m_currentlyParsing, ossimFilename::path(), readValue(), status, ossimString::string(), and ossimString::trim().

Referenced by parseStream().

 {
    KeywordlistParseState status = KeywordlistParseState_FAIL;
 
    char c = (char)in.peek();
    while (c == '#')
    {
       // Read the line as one big value:
       ossimString sequence;
       status = readValue(sequence, in);
       if (status)
          break;
 
       ossimString directive = sequence.before(" ");
 
       // Check for external KWL include file:
       if (directive == "#include")
       {
          ossimFilename includeFile = sequence.after(" ");
          if (includeFile.empty())
             break; // ignore bogus preproc line
          includeFile.trim("\"");
          includeFile.expandEnvironmentVariable();
 
          // The filename can be either relative to the current file being parsed or absolute:
          if (includeFile.string()[0] != '/')
             includeFile = m_currentlyParsing.path() + "/" + includeFile;
 
          // Save the current path in case the new one contains it's own include directive!
          ossimFilename savedCurrentPath = m_currentlyParsing;
          addFile(includeFile); // Quietly ignore any errors loading external KWL.
          m_currentlyParsing = savedCurrentPath;
       }
 
 //      else if (directive == "#add_new_directive_here")
 //      {
 //         process directive
 //      }
 
       status = KeywordlistParseState_OK;
       break;
    }
    return status;
 }

◆ readValue()

ossimKeywordlist::KeywordlistParseState ossimKeywordlist::readValue	(	ossimString &	sequence,
		ossim::istream &	in
	)		const

protected

Definition at line 926 of file ossimKeywordlist.cpp.

References ossimString::begin(), ossimString::end(), isValidKeywordlistCharacter(), KeywordlistParseState_BAD_STREAM, KeywordlistParseState_OK, ossimString::size(), and ossimString::string().

Referenced by readKeyAndValuePair(), and readPreprocDirective().

 {
    KeywordlistParseState result = KeywordlistParseState_OK;
    
    ossim_int32 quoteCount = 0; // mark as not set
    
    // make sure we check for a blank value
    while(!in.eof()&&!in.bad())
    {
       if(in.peek() == ' '||
          in.peek() == '\t')
       {
          in.ignore();
       }
       else if(in.peek() == '\n' ||
               in.peek() == '\r')
       {
          in.ignore();
          return result;
       }
       else 
       {
          break;
       }
    }
    // The ifstream object will end in '�' (character 255 or -1) if the end-of-file indicator 
    // will not be set(e.g \n). In this case, end-of-file conditions would never be detected. 
    // add EOF (which is actually the integer -1 or 255) check here.
    // Reference link http://www.cplusplus.com/forum/general/33821/
    while(!in.eof()&&!in.bad()&&in.peek()!=EOF)
    {
       ossim_uint8 c = in.get();
       if(isValidKeywordlistCharacter(c))
       {
          if(((c == '\n'||c=='\r') && !quoteCount) || in.eof())
          {
             break;
          }
          sequence += (char)c;
          if(sequence.size() >2)
          {
             if(quoteCount < 1)
             {
                //---
                // If string has leading tripple quoted bump the "quoteCount" so
                // we start skipping line breaks, preserving paragraph style strings.
                //---
                if(ossimString(sequence.begin(), sequence.begin()+3) == "\"\"\"")
                {
                   ++quoteCount;
                }
             }
             else // check for ending quotes 
             {
                if(ossimString(sequence.begin() + sequence.size()-3, sequence.end()) == "\"\"\"")
                {
                   ++quoteCount;
                }
             }
          }
          if(quoteCount > 1)
          {
             //---
             // Have leading and trailing tripple quotes. Some tiff writers, e.g. Space
             // Imaging are using four quotes.  Below code strips all quotes from each end.
             //---
             char quote = '"';
             std::string::size_type startPos = sequence.string().find_first_not_of(quote);
             std::string::size_type stopPos  = sequence.string().find_last_not_of(quote);
             if ( ( startPos != std::string::npos ) && (stopPos != std::string::npos) )
             {
                sequence = sequence.string().substr( startPos, stopPos-startPos+1 );
             }
             break;
          }
       }
       else 
       {
          result = KeywordlistParseState_BAD_STREAM;
          break;
       }
    }
    return result;
 }

◆ remove() [1/2]

void ossimKeywordlist::remove ( const char * key )

Definition at line 632 of file ossimKeywordlist.cpp.

References m_map.

Referenced by ossimEpsgProjectionFactory::createProjection(), ossimEpsgProjectionDatabase::createProjFromFormatBRecord(), and getKeyValue().

 {
    ossimString k = key?key:"";
    
    KeywordMap::iterator i = m_map.find(k);
    
    if(i != m_map.end())
    {
       m_map.erase(i);
    }
 }

◆ remove() [2/2]

void ossimKeywordlist::remove	(	const char *	prefix,
		const char *	key
	)

Definition at line 644 of file ossimKeywordlist.cpp.

References m_map.

 {
    if (key)
    {
       ossimString k;
       if (prefix) k = prefix;
       k += key;
       
       KeywordMap::iterator i = m_map.find(k);
       
       if(i != m_map.end())
       {
          m_map.erase(i);
       }
    }
 }

◆ removeKeysThatMatch()

void ossimKeywordlist::removeKeysThatMatch ( const ossimString & regularExpression )

Definition at line 1178 of file ossimKeywordlist.cpp.

References ossimString::c_str(), ossimRegExp::compile(), ossimRegExp::find(), and m_map.

Referenced by ossimSlopeTool::initProcessingChain().

 {
    KeywordMap::const_iterator i;
    std::vector<ossimString> result;
    ossimRegExp regExp;
    
    regExp.compile(regularExpression.c_str());
    
    for(i = m_map.begin(); i != m_map.end(); ++i)
    {
       if(regExp.find( (*i).first.c_str()))
       {
          result.push_back((*i).first);
       }
    }
    for(ossim_uint32 i2 = 0; i2 < result.size(); ++i2)
    {
       remove(result[i2]);
    }
 }

◆ replaceSpecialCharacters()

void ossimKeywordlist::replaceSpecialCharacters ( ossimString & value ) const

protected

Definition at line 1528 of file ossimKeywordlist.cpp.

References ossimString::begin(), and ossimString::end().

Referenced by toXML().

 {
    ossimString::iterator iter = value.begin();
    
    while(iter!=value.end())
    {
       if(!(isdigit(*iter) ||
            isalpha(*iter)||
            (*iter=='/')))
       {
          *iter = '_';
       }
       ++iter;
    }
 }

◆ setExpandEnvVarsFlag()

void ossimKeywordlist::setExpandEnvVarsFlag ( bool flag )

If set to true, then strings found having the format "$(env_var_name)" are expanded in place.

Definition at line 111 of file ossimKeywordlist.cpp.

References m_expandEnvVars.

Referenced by ossimBatchTest::execute(), ossimChipperUtil::ossimChipperUtil(), ossimChipProcTool::ossimChipProcTool(), ossimHillshadeTool::ossimHillshadeTool(), and ossimPreferences::ossimPreferences().

 {
    m_expandEnvVars = flag;
 }

◆ skipWhitespace()

void ossimKeywordlist::skipWhitespace ( ossim::istream & in ) const

protected

Definition at line 773 of file ossimKeywordlist.cpp.

Referenced by parseStream().

 {
    int c = in.peek();
    while( !in.fail() &&
          ( (c == ' ') || (c == '\t') || (c == '\n') || (c == '\r') ) )
    {
       in.ignore(1);
       c = in.peek();
    }
 }

◆ stripPrefixFromAll()

void ossimKeywordlist::stripPrefixFromAll ( const ossimString & regularExpression )

Definition at line 1281 of file ossimKeywordlist.cpp.

References addPair(), ossimString::c_str(), clear(), ossimRegExp::compile(), ossimRegExp::end(), ossimRegExp::find(), m_map, and ossimRegExp::start().

Referenced by ossimWktProjectionFactory::createProjection(), ossimGpkgWriter::loadState(), and ossimKakaduJpipInfo::print().

 {
    ossimKeywordlist tempKwl = *this;
    
    clear();
    
    KeywordMap::const_iterator values = tempKwl.m_map.begin();
    ossimRegExp regExp;
    
    regExp.compile(regularExpression.c_str());
    
    while(values != tempKwl.m_map.end())
    {
       std::string newKey = (*values).first;
       if(regExp.find( (*values).first.c_str()))
       {
          newKey.erase(newKey.begin()+regExp.start(),
                       newKey.begin()+regExp.start()+regExp.end());
          
          addPair(newKey, (*values).second, true);
       }
       else
       {
          addPair(newKey, (*values).second, true);
       }
       ++values;
    }
 }

◆ toJSON()

void ossimKeywordlist::toJSON	(	std::ostream &	out,
		const std::string &	rootTag = `"info"`
	)		const

Outputs in json format.

Parameters

out	Stream to write to.
rootTag	name of the root json element/tag

Definition at line 1624 of file ossimKeywordlist.cpp.

 {
    const std::string C   = ": "; // colon
    const std::string DQ  = "\""; // double Quote
    const std::string LB  = "{"; // left bracket
    const std::string CNL = ",\n"; // coma, new line
    const std::string NL  = "\n"; // new line   
    const std::string RB  = "}"; // left bracket
    const std::string S   = " ";  // space
    ossim_uint32 nameCount = 0;
    ossimString lastObject;
    ossim_uint32 indentCount = 3;
    ossim_uint32 indentOffset = 3;
    
    bool stringify = true;
    bool closeObject = false;
    std::vector<ossimString> objectStack;
 
    // Opening bracket:
    out << LB;
    
    if( rootTag.size() )
    {
       if ( stringify )
       {
          indentOffset = indentCount;
          std::string indent(indentCount, ' ');
          out << NL << indent;
       }
       else
       {
          out << NL;
       }
       // Note: not adding rootTag to object stack
       out << DQ << rootTag << DQ << C << LB << NL;
    }
 
    ossimKeywordlist::KeywordMap::const_iterator iter = m_map.begin();
    while(iter != m_map.end())
    {
       bool outputValue  = true;
       ossimString key   = iter->first;
       ossimString value = iter->second;
       value = value.trim(); // remove spaces
 
 #if 0
       if(key.contains("unformatted_tag_data"))
       {
          ossimString temp = value.trim();
          if(ossimString(temp.begin(), temp.begin()+5) == "<?xml")
          {
             value = "data not converted";
             outputValue = false;
          }
       }
 #endif
       
       if ( outputValue && key.size() )
       {
          std::vector<ossimString> keys;
          key.split(keys,".");
          
          if ( keys.size() )
          {
             // The last key is the name so grab it now and pop it off the stack:
             ossimString name = keys[keys.size()-1];
             keys.pop_back();
 
             bool sameObject = isSame( keys, objectStack );
             if ( !sameObject && keys.size() )
             {
                for ( ossim_uint32 i = 0; i < keys.size(); ++i )
                {
                   if ( i < objectStack.size() )
                   {
                      if ( keys[i] == objectStack[i] )
                      {
                         // On stack already. Nothng to do. Go to next key.
                         continue;
                      }
                      else
                      {
                         // Different object:
                         while ( i <  objectStack.size() )
                         {
                            // Write bracket, then pop:
                            if ( stringify )
                            {
                               std::string indent(indentOffset+(indentCount*objectStack.size()), ' ');
                               out << NL << indent << RB;
                            }
                            else
                            {
                               out << NL << RB;
                            }
                            objectStack.pop_back();
                            nameCount = 0;
                            closeObject = true;
                            if ( objectStack.size() )
                            {
                               lastObject = objectStack[objectStack.size()-1];
                            }
                            else
                            {
                               lastObject.clear();
                            }
                         }
                      }
                   }
                   
                   //---
                   // New object:
                   // If we had written a key:value for previos object, do a
                   // newline and zero it out.
                   //---
                   if ( nameCount )
                   {
                      out << CNL;
                      nameCount = 0;
                   }
                         
                   objectStack.push_back( keys[i] );
 
                   if ( closeObject )
                   {
                      out << CNL;
                      closeObject = false;
                   }
 
                   if ( stringify )
                   {
                      std::string indent(indentOffset+(indentCount*objectStack.size()), ' ');
                      out << indent;
                   }
                   out << DQ << keys[i] << DQ << C << LB << NL;
                }
 
                // Final check if keys shrunk, pop objects off the object stack.
                while ( keys.size() <  objectStack.size() )
                {
                   // Write bracket then pop:
                   if ( stringify )
                   {
                      std::string indent(indentOffset+(indentCount*objectStack.size()), ' ');
                      out << NL << indent << RB;
                   }
                   else
                   {
                      out << NL << RB;
                   }
                   objectStack.pop_back();
                   nameCount = 0;
                   closeObject = true;
                   if ( objectStack.size() )
                   {
                      lastObject = objectStack[objectStack.size()-1];
                   }
                   else
                   {
                      lastObject.clear();
                   }
                }
             }
 
             if ( objectStack.size() )
             {       
                if ( lastObject == objectStack[objectStack.size()-1] )
                {
                   out << CNL;
                   closeObject = false;
                }
             }
             else if ( nameCount ) // No objects loaded on the stack.
             {
                out << CNL;
             }  
 
             // Output "key": "value"
             if ( stringify )
             {
                std::string indent(indentOffset+indentCount*(objectStack.size()+1), ' ');
                out << indent;
             }
             out << DQ << name << DQ << C << DQ << value << DQ;
 
             if ( objectStack.size() )
             {
                lastObject = objectStack[objectStack.size()-1];
             }
             else
             {
                lastObject.clear();
             }
             
             ++nameCount;
          }
       }
       ++iter;
       
    } // Matches: while(iter != m_map.end())
 
    // Close out brackets:
    ossim_uint32 stackSize = objectStack.size();
    if ( stackSize )
    {
       for ( ossim_uint32 i = stackSize; i > 0; --i )
       {
          if ( stringify )
          {
             std::string indent(indentOffset+indentCount*i, ' ');
             out << NL << indent << RB;
          }
          else
          {
             out << NL << RB;
          }
       }
    }
 
    if( rootTag.size() )
    {
       if ( stringify )
       {
          std::string indent(indentCount, ' ');
          out << NL << indent << RB;
       }
       else
       {
          out << NL << RB;
       }
    }
    
    // Closing bracket, newline with flush:
    out << NL << RB << std::endl;
 }

◆ toString() [1/2]

ossimString ossimKeywordlist::toString ( ) const

virtual

Definition at line 507 of file ossimKeywordlist.cpp.

References ossimString::c_str(), delimiter_str(), m_map, and writeToStream().

Referenced by ossim::Image::saveJSON(), ossimStringListProperty::valueToString(), and ossimFontProperty::valueToString().

 {
    std::ostringstream out;
    writeToStream(out);
    
 #if 0
    KeywordMap::const_iterator i;
    ossimString result;
    
    for(i = m_map.begin(); i != m_map.end(); i++)
    {
       result += (*i).first;
       result += delimiter_str().c_str();
       result += " ";
       result += (*i).second;
       result += '\n';
    }
 #endif
    return ossimString(out.str());
 }

◆ toString() [2/2]

void ossimKeywordlist::toString ( ossimString & result ) const

virtual

Definition at line 528 of file ossimKeywordlist.cpp.

References ossimString::c_str(), delimiter_str(), m_map, and writeToStream().

 {
    std::ostringstream out;
    writeToStream(out);
    
    result = out.str();
 #if 0
    KeywordMap::const_iterator i;
    
    for(i = m_map.begin(); i != m_map.end(); i++)
    {
       result += (*i).first;
       result += delimiter_str().c_str();
       result += " ";
       result += (*i).second;
       result += '\n';
    }
 #endif
 }

◆ toXML()

void ossimKeywordlist::toXML	(	std::ostream &	out,
		const std::string &	rootTag = `"info"`
	)		const

Outputs in xml format.

Parameters

out	Stream to write to.
rootTag	name of the root XML element/tag

Definition at line 1544 of file ossimKeywordlist.cpp.

References ossimXmlNode::addNode(), ossimString::begin(), ossimString::c_str(), ossimString::contains(), ossimRefPtr< T >::get(), ossimXmlNode::getChildNodes(), isSpecialXmlCharacters(), isValidTag(), ossimString::join(), m_map, replaceSpecialCharacters(), ossimXmlNode::setCDataFlag(), ossimXmlNode::setTag(), ossimString::split(), ossimString::substitute(), and ossimString::trim().

 {
    std::string rootTagStr = rootTag;
    if (!isValidTag(rootTagStr))
    {
       rootTagStr = "info";
    }
 
    ossimRefPtr<ossimXmlNode> metadata = new ossimXmlNode;
    metadata->setTag("metadata");
    ossimKeywordlist::KeywordMap::const_iterator iter = m_map.begin();
    while(iter != m_map.end())
    {
       ossimString path = iter->first;
       bool outputValue = true;
       ossimString value = iter->second;
       if(path.contains("unformatted_tag_data"))
       {
          ossimString temp = value.trim();
          if(ossimString(temp.begin(), temp.begin()+5) == "<?xml")
          {
             value = "XML not converted";
             outputValue = false;
          }
       }
       
       if(outputValue)
       {
          bool tagOk = true;
          path = path.substitute(".", "/", true);
          replaceSpecialCharacters(path);
          std::vector<ossimString> splitValues;
          path.split(splitValues,"/");
          if(splitValues.size())
          {
             splitValues[splitValues.size()-1] = splitValues[splitValues.size()-1].downcase();
             ossim_uint32 idx = 0;
             for(idx = 0; ((idx < splitValues.size()-1)&&tagOk);++idx)
             {
                if(!isValidTag(splitValues[idx]))
                {
                   tagOk = false;
                }
                splitValues[idx] = splitValues[idx].upcase();
             }
          }
          if(tagOk)
          {
             path.join(splitValues, "/");
             ossimRefPtr<ossimXmlNode> node = metadata->addNode(path.c_str(), value);
             if(isSpecialXmlCharacters(value))
             {
                node->setCDataFlag(true);
             }
          }
       }
       ++iter;
    }
    
    if( 1 ) // tmp dbr !m_includeMetadataTagName)
    {
       out << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" << std::endl
           << "<" << rootTagStr << ">\n";
       
       const ossimXmlNode::ChildListType& children = metadata->getChildNodes();
       ossimXmlNode::ChildListType::const_iterator iter = children.begin();
       while(iter != children.end())
       {
          out << *(iter->get());
          ++iter;
       }
       out << "\n</" << rootTagStr << ">" << std::endl;
    }
    else 
    {
       out << *(metadata.get()) << std::endl;
    }   
 }

◆ trimAllValues() [1/2]

ossimKeywordlist & ossimKeywordlist::trimAllValues ( const ossimString & valueToTrim = ossimString(" \t\n\r") )

Definition at line 1426 of file ossimKeywordlist.cpp.

References m_map, ossimString::string(), and ossimString::trim().

Referenced by trimAllValues().

 {
    KeywordMap::iterator iter = m_map.begin();
    
    while(iter != m_map.end())
    {
       iter->second = ossimString(iter->second).trim(valueToTrim).string();
       ++iter;
    }
    
    return *this;
 }

◆ trimAllValues() [2/2]

ossimKeywordlist ossimKeywordlist::trimAllValues ( const ossimString & valueToTrim = ossimString(" \t\n\r") ) const

Definition at line 1439 of file ossimKeywordlist.cpp.

References trimAllValues().

 {
    ossimKeywordlist result(*this);
    result.trimAllValues(valueToTrim);
    return result;
 }

◆ upcaseKeywords()

ossimKeywordlist & ossimKeywordlist::upcaseKeywords ( )

Definition at line 1410 of file ossimKeywordlist.cpp.

References m_map, ossimString::string(), and ossimString::upcase().

 {
    KeywordMap tempMap;
    KeywordMap::iterator iter = m_map.begin();
    
    while(iter != m_map.end())
    {
       ossimString k(iter->first);
       tempMap.insert(std::make_pair(k.upcase().string(), iter->second));
       ++iter;
    }
    m_map = tempMap;
    
    return *this;
 }

◆ write()

bool ossimKeywordlist::write	(	const char *	file,
		const char *	comment = `0`
	)		const

virtual

Methods to dump the ossimKeywordlist to a file on disk.

Parameters

file	Name of output file.
comment	Optional string that will be written to line 1 as a C++-style comment. A "//" is prepended to the input string.

Returns: true on success, false on error.

Definition at line 479 of file ossimKeywordlist.cpp.

References ossimString::c_str(), ossimNotify(), ossimNotifyLevel_WARN, and writeToStream().

Referenced by ossimHdf5Tool::execute(), ossimSubImageTool::execute(), ossimIgenGenerator::generateGeoTiledSpecList(), ossimIgenGenerator::generateNoTiledSpecList(), ossimIgenGenerator::generatePixelTiledSpecList(), ossimChipProcTool::processRemainingArgs(), ossimAutRegUtil::saveAdjustment(), ossimImageHandler::saveImageGeometry(), ossimHistogramSource::saveState(), ossimOverviewSequencer::writeHistogram(), and ossimImageHandler::writeValidImageVertices().

 {
    std::ofstream filename(file);
    if (!filename)
    {
       ossimNotify(ossimNotifyLevel_WARN)
       <<"ossimKeywordlist::write, Error opening file:  "
       << file << std::endl;
       return false;
    }
    
    if ( comment != 0 )
    {
       ossimString commentStr("// ");
       commentStr += comment;
       
       // Write out the input comment to the first line.
       filename << commentStr.c_str() << std::endl;
    }
    
    writeToStream(filename);
    
    filename.close();
    
    return true;
 }

◆ writeToStream()

void ossimKeywordlist::writeToStream ( std::ostream & out ) const

virtual

Definition at line 548 of file ossimKeywordlist.cpp.

References ossimString::c_str(), delimiter_str(), ossimString::empty(), ossimRegExp::find(), and m_map.

Referenced by print(), ossimMapViewController::saveState(), toString(), ossimFontProperty::valueToString(), and write().

 {
    KeywordMap::const_iterator i;
    ossimString value;
    ossimRegExp reg("\n|\r| $|^ ");
    for(i = m_map.begin(); i != m_map.end(); ++i)
    {
       value = (*i).second;
       if(!value.empty())
       {
          if(reg.find(value))
          {
             value = "\"\"\"" + value + "\"\"\"";
          }
       }
       //      value = value.substitute('\n', "\\\n", true);
       out << (*i).first  << delimiter_str().c_str() << "  "
       << value << std::endl;
    }
 }

Friends And Related Function Documentation

◆ operator<<

OSSIMDLLEXPORT friend std::ostream& operator<<	(	std::ostream &	os,
		const ossimKeywordlist &	kwl
	)

friend

Definition at line 1359 of file ossimKeywordlist.cpp.

 {
    kwl.print(os);
    
    return os;
 }

Member Data Documentation

◆ m_currentlyParsing

ossimFilename ossimKeywordlist::m_currentlyParsing

protected

Definition at line 603 of file ossimKeywordlist.h.

Referenced by parseFile(), and readPreprocDirective().

◆ m_delimiter

char ossimKeywordlist::m_delimiter

protected

Definition at line 595 of file ossimKeywordlist.h.

Referenced by change_delimiter(), delimiter_str(), and readKey().

◆ m_expandEnvVars

bool ossimKeywordlist::m_expandEnvVars

protected

Definition at line 600 of file ossimKeywordlist.h.

Referenced by addPair(), getExpandEnvVarsFlag(), parseStream(), and setExpandEnvVarsFlag().

◆ m_map

KeywordMap ossimKeywordlist::m_map

protected

◆ m_preserveKeyValues

bool ossimKeywordlist::m_preserveKeyValues

protected

Definition at line 598 of file ossimKeywordlist.h.

◆ NULL_KW

const std::string ossimKeywordlist::NULL_KW = ""

static

Definition at line 74 of file ossimKeywordlist.h.

Referenced by findKey().

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

Public Types

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ KeywordMap

Member Enumeration Documentation

◆ KeywordlistParseState

Constructor & Destructor Documentation

◆ ossimKeywordlist() [1/5]

◆ ossimKeywordlist() [2/5]

◆ ossimKeywordlist() [3/5]

◆ ossimKeywordlist() [4/5]

◆ ossimKeywordlist() [5/5]

◆ ~ossimKeywordlist()

Member Function Documentation

◆ add() [1/22]

◆ add() [2/22]

◆ add() [3/22]

◆ add() [4/22]

◆ add() [5/22]

◆ add() [6/22]

◆ add() [7/22]

◆ add() [8/22]

◆ add() [9/22]

◆ add() [10/22]

◆ add() [11/22]

◆ add() [12/22]

◆ add() [13/22]

◆ add() [14/22]

◆ add() [15/22]

◆ add() [16/22]

◆ add() [17/22]

◆ add() [18/22]

◆ add() [19/22]

◆ add() [20/22]

◆ add() [21/22]

◆ add() [22/22]

◆ addFile() [1/2]

◆ addFile() [2/2]

◆ addList()

◆ addPair() [1/2]

◆ addPair() [2/2]

◆ addPrefixToAll()

◆ addPrefixToKeysThatMatch()

◆ change_delimiter()

◆ clear()

◆ delimiter_str()

◆ downcaseKeywords()

◆ extractKeysThatMatch()

◆ find() [1/2]

◆ find() [2/2]

◆ findAllKeysThatContains()

◆ findAllKeysThatMatch()

◆ findKey() [1/2]

◆ findKey() [2/2]

◆ findValue()

◆ getBoolKeywordValue()

◆ getExpandEnvVarsFlag()

◆ getMap() [1/2]

◆ getMap() [2/2]

◆ getMapEntry() [1/3]

◆ getMapEntry() [2/3]

◆ getMapEntry() [3/3]

◆ getNumberOfKeysThatMatch()

◆ getNumberOfSubstringKeys()

◆ getSize()

◆ getSortedList()

◆ getSubstringKeyList() [1/2]

◆ getSubstringKeyList() [2/2]

◆ hasKey()

◆ isSame()

◆ isSpecialXmlCharacters()

◆ isValidKeywordlistCharacter()

◆ isValidTag()

◆ numberOf() [1/2]