ossimArgumentParser Class Reference

#include <ossimArgumentParser.h>

Classes
class	ossimParameter

Public Types
enum	ossimErrorSeverity { OSSIM_BENIGN = 0, OSSIM_CRITICAL = 1 }
typedef std::map< std::string, ossimErrorSeverity >	ossimErrorMessageMap

Public Member Functions
	ossimArgumentParser (int *argc, char **argv)
	ossimArgumentParser (const ossimString &commandLine)
	~ossimArgumentParser ()
void	initialize (int *argc, const char **argv)
	Initialize from command arguments. More...
void	setApplicationUsage (ossimApplicationUsage *usage)
ossimApplicationUsage *	getApplicationUsage ()
const ossimApplicationUsage *	getApplicationUsage () const
int &	argc ()
	return the argument count. More...
char **	argv ()
	return the argument array. More...
char *	operator[] (int pos)
	return char* argument at specificed position. More...
const char *	operator[] (int pos) const
	return const char* argument at specificed position. More...
std::string	getApplicationName () const
	return the application name, as specified by argv[0] More...
int	find (const std::string &str) const
	return the position of an occurence of a string in the argument list. More...
bool	isOption (int pos) const
	return return true if specified parameter is an option in the form of -option or –option . More...
bool	isString (int pos) const
	return return true if specified parameter is an string, which can be any other string apart from an option. More...
bool	isNumber (int pos) const
	return return true if specified parameter is an number. More...
bool	containsOptions () const
void	remove (int pos, int num=1)
	remove one or more arguments from the argv argument list, and decrement the argc respectively. More...
void	insert (int pos, const ossimString &arg)
	Inserts string into the argv argument list, and increment the argc respectively. More...
bool	match (int pos, const std::string &str) const
	return true if specified argument matches string. More...
bool	read (const std::string &str)
	search for an occurance of a string in the argument list, on sucess remove that occurance from the list and return true, otherwise return false. More...
bool	read (const std::string &str, ossimParameter value1)
bool	read (const std::string &str, ossimParameter value1, ossimParameter value2)
bool	read (const std::string &str, ossimParameter value1, ossimParameter value2, ossimParameter value3)
bool	read (const std::string &str, ossimParameter value1, ossimParameter value2, ossimParameter value3, ossimParameter value4)
bool	read (const std::string &str, ossimParameter value1, ossimParameter value2, ossimParameter value3, ossimParameter value4, ossimParameter value5)
bool	read (const std::string &str, ossimParameter value1, ossimParameter value2, ossimParameter value3, ossimParameter value4, ossimParameter value5, ossimParameter value6)
bool	read (const std::string &str, std::vector< ossimString > &param_list)
	Alternate form for reading variable length arguments (must be comma-separated), e.g.,. More...
int	numberOfParams (const std::string &str, const ossimParameter value) const
bool	read (int pos, const std::string &str)
	if the argument value at the position pos matches specified string, and subsequent paramters are also matched then set the paramter values and remove the from the list of arguments. More...
bool	read (int pos, const std::string &str, ossimParameter value1)
bool	read (int pos, const std::string &str, ossimParameter value1, ossimParameter value2)
bool	read (int pos, const std::string &str, ossimParameter value1, ossimParameter value2, ossimParameter value3)
bool	read (int pos, const std::string &str, ossimParameter value1, ossimParameter value2, ossimParameter value3, ossimParameter value4)
bool	errors (ossimErrorSeverity severity=OSSIM_BENIGN) const
void	reportError (const std::string &message, ossimErrorSeverity severity=OSSIM_CRITICAL)
	report an error message by adding to the ErrorMessageMap. More...
void	reportRemainingOptionsAsUnrecognized (ossimErrorSeverity severity=OSSIM_BENIGN)
	for each remaining option report it as an unrecongnized. More...
ossimErrorMessageMap &	getErrorMessageMap ()
const ossimErrorMessageMap &	getErrorMessageMap () const
void	writeErrorMessages (std::ostream &output, ossimErrorSeverity sevrity=OSSIM_BENIGN)
	write out error messages at an above specified . More...

Static Public Member Functions
static bool	isOption (const char *str)
	return return true if specified string is an option in the form of -option or –option . More...
static bool	isString (const char *str)
	return return true if string is any other string apart from an option. More...
static bool	isNumber (const char *str)
	return return true if specified parameter is an number. More...

Protected Attributes
int *	theArgc
char **	theArgv
ossimErrorMessageMap	theErrorMessageMap
ossimApplicationUsage *	theUsage
bool	theMemAllocated

Detailed Description

Definition at line 18 of file ossimArgumentParser.h.

Member Typedef Documentation

ossimErrorMessageMap

typedef std::map<std::string,ossimErrorSeverity> ossimArgumentParser::ossimErrorMessageMap

Definition at line 212 of file ossimArgumentParser.h.

Member Enumeration Documentation

ossimErrorSeverity

enum ossimArgumentParser::ossimErrorSeverity

Enumerator
OSSIM_BENIGN
OSSIM_CRITICAL

Definition at line 206 of file ossimArgumentParser.h.

   {
      OSSIM_BENIGN = 0,
      OSSIM_CRITICAL = 1
   };

Constructor & Destructor Documentation

ossimArgumentParser() [1/2]

ossimArgumentParser::ossimArgumentParser	(	int *	argc,
		char **	argv
	)

Definition at line 169 of file ossimArgumentParser.cpp.

References argv(), ossimApplicationUsage::setApplicationName(), theArgc, and theUsage.

                                                             :
   theArgc(argc),
   theArgv(argv),
   theUsage(ossimApplicationUsage::instance()),
   theMemAllocated(false)
{
   if (theArgc)
      theUsage->setApplicationName(argv[0]);
}

ossimArgumentParser() [2/2]

ossimArgumentParser::ossimArgumentParser

(

const ossimString &

commandLine

)

Definition at line 179 of file ossimArgumentParser.cpp.

References n, ossimApplicationUsage::setApplicationName(), ossimString::split(), theArgc, theArgv, and theUsage.

                                                                      :
   theArgc(new int),
   theArgv(0),
   theUsage(ossimApplicationUsage::instance()),
   theMemAllocated(true)
{
   vector<ossimString> args = commandLine.split(" ", true);
   *theArgc = (int)args.size();
   if (*theArgc > 0)
   {
      theArgv = new char* [*theArgc];
      for (size_t i=0; i<args.size(); i++)
      {
         size_t n = args[i].size();
         theArgv[i] = new char [n+1];
         strncpy(theArgv[i], args[i].chars(), n);
         theArgv[i][n] = '\0';
      }
      theUsage->setApplicationName(theArgv[0]);
   }
}

~ossimArgumentParser()

ossimArgumentParser::~ossimArgumentParser

(

)

Definition at line 201 of file ossimArgumentParser.cpp.

References theArgc, theArgv, and theMemAllocated.

{
   if (theMemAllocated)
   {
      for (int i=0; i<*theArgc; ++i)
         delete [] theArgv[i];
      delete [] theArgv;
      delete theArgc;
   }
}

Member Function Documentation

argc()

int& ossimArgumentParser::argc ( )

inline

return the argument count.

Definition at line 109 of file ossimArgumentParser.h.

Referenced by ossimEquationUtil::execute(), ossimVerticesFinderTool::initialize(), ossimPointCloudTool::initialize(), ossimBatchTest::initialize(), initialize(), ossimChipProcTool::processRemainingArgs(), and reportRemainingOptionsAsUnrecognized().

{ return *theArgc; }

argv()

char** ossimArgumentParser::argv ( )

inline

return the argument array.

Definition at line 112 of file ossimArgumentParser.h.

Referenced by ossimBatchTest::initialize(), initialize(), and ossimArgumentParser().

{ return theArgv; }

containsOptions()

bool ossimArgumentParser::containsOptions

(

)

const

Definition at line 262 of file ossimArgumentParser.cpp.

References isOption(), and theArgc.

{
   for(int pos=1;pos<*theArgc;++pos)
   {
      if (isOption(pos)) return true;
   }
   return false;
}

errors()

bool ossimArgumentParser::errors

(

ossimErrorSeverity

severity = OSSIM_BENIGN

)

const

Returns

The error flag, true if an error has occured when reading arguments.

Definition at line 594 of file ossimArgumentParser.cpp.

References theErrorMessageMap.

Referenced by ossimBatchTest::initialize(), and ossimChipProcTool::processRemainingArgs().

{
   for(ossimErrorMessageMap::const_iterator itr=theErrorMessageMap.begin();
       itr!=theErrorMessageMap.end();
       ++itr)
   {
      if (itr->second>=severity) return true;
   }
   return false;
}

find()

int ossimArgumentParser::find

(

const std::string &

str

)

const

return the position of an occurence of a string in the argument list.

return -1 when no string is found.

Definition at line 245 of file ossimArgumentParser.cpp.

References theArgc, and theArgv.

Referenced by numberOfParams(), and read().

{
   for(int pos=1;pos<*theArgc;++pos)
   {
      if (str==theArgv[pos])
      {
         return pos;
      }
   }
   return 0;
}

getApplicationName()

std::string ossimArgumentParser::getApplicationName

(

)

const

return the application name, as specified by argv[0]

Definition at line 224 of file ossimArgumentParser.cpp.

References theArgc, and theArgv.

Referenced by ossimPointCloudTool::addArguments(), ossimImageUtil::addArguments(), ossimAutRegUtil::addArguments(), ossimChipperUtil::addArguments(), ossimEquationUtil::ossimEquationUtil(), reportRemainingOptionsAsUnrecognized(), ossimRegTool::setUsage(), ossimVerticesFinderTool::setUsage(), ossimBandMergeTool::setUsage(), ossimPotraceTool::setUsage(), ossimDemTool::setUsage(), ATP::ossimAtpTool::setUsage(), ossimOrthoTool::setUsage(), ossimSlopeTool::setUsage(), ossimSubImageTool::setUsage(), ossimViewshedTool::setUsage(), ossimHdf5Tool::setUsage(), ossimHlzTool::setUsage(), ossimHillshadeTool::setUsage(), ossimShorelineTool::setUsage(), ossimInfo::setUsage(), ossimChipProcTool::setUsage(), ossimTool::setUsage(), ossimAutRegUtil::usage(), ossimImageUtil::usage(), ossimChipperUtil::usage(), and writeErrorMessages().

{
   if (theArgc && *theArgc>0 ) return std::string(theArgv[0]);
   return "";
}

getApplicationUsage() [1/2]

ossimApplicationUsage* ossimArgumentParser::getApplicationUsage ( )

inline

Definition at line 105 of file ossimArgumentParser.h.

Referenced by ossimPointCloudTool::addArguments(), ossimImageUtil::addArguments(), ossimAutRegUtil::addArguments(), ossimChipperUtil::addArguments(), ossimInit::addOptions(), ossimTool::initialize(), ossimBandMergeTool::setUsage(), ossimRegTool::setUsage(), ossimVerticesFinderTool::setUsage(), ossimPotraceTool::setUsage(), ATP::ossimAtpTool::setUsage(), ossimDemTool::setUsage(), ossimOrthoTool::setUsage(), ossimSlopeTool::setUsage(), ossimSubImageTool::setUsage(), ossimHdf5Tool::setUsage(), ossimViewshedTool::setUsage(), ossimHlzTool::setUsage(), ossimHillshadeTool::setUsage(), ossimShorelineTool::setUsage(), ossimInfo::setUsage(), ossimChipProcTool::setUsage(), ossimTool::setUsage(), ossimPointCloudTool::usage(), ossimBatchTest::usage(), ossimAutRegUtil::usage(), ossimImageUtil::usage(), and ossimChipperUtil::usage().

{ return theUsage; }

getApplicationUsage() [2/2]

const ossimApplicationUsage* ossimArgumentParser::getApplicationUsage ( ) const

inline

Definition at line 106 of file ossimArgumentParser.h.

{ return theUsage; }

getErrorMessageMap() [1/2]

ossimArgumentParser::ossimErrorMessageMap & ossimArgumentParser::getErrorMessageMap

(

)

Returns

The error message, if any has occured.

Definition at line 649 of file ossimArgumentParser.cpp.

References theErrorMessageMap.

{
   return theErrorMessageMap;
}

getErrorMessageMap() [2/2]

const ossimArgumentParser::ossimErrorMessageMap & ossimArgumentParser::getErrorMessageMap

(

)

const

Returns

The error message, if any has occured.

Definition at line 654 of file ossimArgumentParser.cpp.

References theErrorMessageMap.

{
   return theErrorMessageMap;
}

initialize()

void ossimArgumentParser::initialize	(	int *	argc,
		const char **	argv
	)

Initialize from command arguments.

Definition at line 212 of file ossimArgumentParser.cpp.

References argc(), argv(), theArgc, and theArgv.

{
   if(*argc > 0) delete (theArgv);
   theArgc = argc;
   theArgv = new char*[*argc];
   for(int i=0;i<*argc;i++)
   {
      theArgv[i] = new char[strlen(argv[i])];
      strcpy(theArgv[i], argv[i]);
   }
}

insert()

void ossimArgumentParser::insert	(	int	pos,
		const ossimString &	arg
	)

Inserts string into the argv argument list, and increment the argc respectively.

If string contains spaces, it will be split up into component simple strings.

Definition at line 299 of file ossimArgumentParser.cpp.

References ossimString::size(), ossimString::split(), theArgc, theArgv, and theMemAllocated.

{
   if (argstr.size()==0)
      return;

   // Split arg into components (separated by spaces). Need to reallocate args array to new size:
   vector<ossimString> components = argstr.split(" ");
   int new_argc = *theArgc + (int)components.size();
   char** new_argv = new char*[new_argc];

   // First copy the original list, leaving space for the new components:
   int j = 0;
   for (int i=0; i<*theArgc; ++i)
   {
      if (j == pos)
         j += (int)components.size();
      new_argv[j] = theArgv[i];
      ++j;
   }

   // Insert new components:
   for(ossim_uint32 i=0; i<components.size(); ++i)
      new_argv[pos+i]=components[i].stringDup();

   // Need to deallocate old arg storage?
   if (theMemAllocated)
      delete [] theArgv;
   theArgv = new_argv;
   *theArgc = new_argc;
   theMemAllocated = true;
}

isNumber() [1/2]

bool ossimArgumentParser::isNumber ( const char *  str )

static

return return true if specified parameter is an number.

Definition at line 32 of file ossimArgumentParser.cpp.

Referenced by isNumber().

{
   if (!str) return false;
   
   bool hadPlusMinus = false;
   bool hadDecimalPlace = false;
   bool hadExponent = false;
   bool couldBeInt = true;
   bool couldBeFloat = true;
   int noZeroToNine = 0;

   const char* ptr = str;

   // check if could be a hex number.
   if (std::strncmp(ptr,"0x",2)==0)
   {
      // skip over leading 0x, and then go through rest of string
      // checking to make sure all values are 0...9 or a..f.
      ptr+=2;
      while (
         *ptr!=0 &&
         ((*ptr>='0' && *ptr<='9') ||
          (*ptr>='a' && *ptr<='f') ||
          (*ptr>='A' && *ptr<='F'))
         )
      {
         ++ptr;
      }

      // got to end of string without failure, therefore must be a hex integer.
      if (*ptr==0) return true;
   }

   ptr = str;

   // check if a float or an int.
   while (*ptr!=0 && couldBeFloat)
   {
      if (*ptr=='+' || *ptr=='-')
      {
         if (hadPlusMinus)
         {
            couldBeInt = false;
            couldBeFloat = false;
         }
         else
         {
            hadPlusMinus = true;
         }
      }
      else if (*ptr>='0' && *ptr<='9')
      {
         noZeroToNine++;
      }
      else if (*ptr=='.')
      {
         if (hadDecimalPlace)
         {
            couldBeInt = false;
            couldBeFloat = false;
         }
         else
         {
            hadDecimalPlace = true;
            couldBeInt = false;
         }
      }
      else if (*ptr=='e' || *ptr=='E')
      {
         if (hadExponent || noZeroToNine==0)
         {
            couldBeInt = false;
            couldBeFloat = false;
         }
         else
         {
            hadExponent = true;
            couldBeInt = false;
            hadDecimalPlace = false;
            hadPlusMinus = false;
            noZeroToNine=0;
         }
      }
      else
      {
         couldBeInt = false;
         couldBeFloat = false;
      }
      ++ptr;
   }

   if (couldBeInt && noZeroToNine>0) return true;
   if (couldBeFloat && noZeroToNine>0) return true;

   return false;

}

isNumber() [2/2]

bool ossimArgumentParser::isNumber

(

int

pos

)

const

return return true if specified parameter is an number.

Definition at line 240 of file ossimArgumentParser.cpp.

References isNumber(), theArgc, and theArgv.

{
   return pos < *theArgc && isNumber(theArgv[pos]);
}

isOption() [1/2]

bool ossimArgumentParser::isOption ( const char *  str )

static

return return true if specified string is an option in the form of -option or –option .

Definition at line 19 of file ossimArgumentParser.cpp.

Referenced by containsOptions(), isOption(), and reportRemainingOptionsAsUnrecognized().

{
   return str && str[0]=='-';
}

isOption() [2/2]

bool ossimArgumentParser::isOption

(

int

pos

)

const

return return true if specified parameter is an option in the form of -option or –option .

Definition at line 230 of file ossimArgumentParser.cpp.

References isOption(), theArgc, and theArgv.

{
   return pos<*theArgc && isOption(theArgv[pos]);
}

isString() [1/2]

bool ossimArgumentParser::isString ( const char *  str )

static

return return true if string is any other string apart from an option.

Definition at line 24 of file ossimArgumentParser.cpp.

Referenced by isString().

{
   if (!str) return false;

   return true;
//    return !isOption(str);
}

isString() [2/2]

bool ossimArgumentParser::isString

(

int

pos

)

const

return return true if specified parameter is an string, which can be any other string apart from an option.

Definition at line 235 of file ossimArgumentParser.cpp.

References isString(), theArgc, and theArgv.

{
   return pos < *theArgc && isString(theArgv[pos]);
}

match()

bool ossimArgumentParser::match	(	int	pos,
		const std::string &	str
	)		const

return true if specified argument matches string.

Definition at line 257 of file ossimArgumentParser.cpp.

References theArgc, and theArgv.

Referenced by read().

{
   return pos<*theArgc && str==theArgv[pos];
}

numberOfParams()

int ossimArgumentParser::numberOfParams	(	const std::string &	str,
		const ossimParameter	value
	)		const

Returns

The number of parameters of type value associated with specified option, or -1 if option not found

Definition at line 271 of file ossimArgumentParser.cpp.

References find(), theArgv, and ossimArgumentParser::ossimParameter::valid().

{
   int pos=find(str);
   if (pos<=0) 
      return -1;

   ++pos;
   int num_params = 0;
   while (param.valid(theArgv[pos+num_params]))
      ++num_params;
   return num_params;
}

operator[]() [1/2]

char* ossimArgumentParser::operator[] ( int  pos )

inline

return char* argument at specificed position.

Definition at line 115 of file ossimArgumentParser.h.

{ return theArgv[pos]; }

operator[]() [2/2]

const char* ossimArgumentParser::operator[] ( int  pos ) const

inline

return const char* argument at specificed position.

Definition at line 118 of file ossimArgumentParser.h.

{ return theArgv[pos]; }

read() [1/13]

bool ossimArgumentParser::read

(

const std::string &

str

)

search for an occurance of a string in the argument list, on sucess remove that occurance from the list and return true, otherwise return false.

Definition at line 331 of file ossimArgumentParser.cpp.

References find().

Referenced by ossimEquationUtil::execute(), ossimVerticesFinderTool::initialize(), ossimBandMergeTool::initialize(), ossimRegTool::initialize(), ossimPotraceTool::initialize(), ATP::ossimAtpTool::initialize(), ossimDemTool::initialize(), ossimPointCloudTool::initialize(), ossimTool::initialize(), ossimHlzTool::initialize(), ossimViewshedTool::initialize(), ossimSubImageTool::initialize(), ossimHdf5Tool::initialize(), ossimHillshadeTool::initialize(), ossimShorelineTool::initialize(), ossimBatchTest::initialize(), ossimChipProcTool::initialize(), ossimInit::parseEnvOptions(), ossimInit::parseNotifyOption(), and ossimChipProcTool::processRemainingArgs().

{
   int pos=find(str);
   if (pos<=0) return false;
   remove(pos);
   return true;
}

read() [2/13]

bool ossimArgumentParser::read	(	const std::string &	str,
		ossimParameter	value1
	)

Definition at line 339 of file ossimArgumentParser.cpp.

References ossimArgumentParser::ossimParameter::assign(), find(), reportError(), theArgv, and ossimArgumentParser::ossimParameter::valid().

{
   int pos=find(str);
   if (pos<=0) return false;
   if (!value1.valid(theArgv[pos+1]))
   {
      reportError("argument to `"+str+"` is missing");
      return false;
   }
   value1.assign(theArgv[pos+1]);
   remove(pos,2);
   return true;
}

read() [3/13]

bool ossimArgumentParser::read	(	const std::string &	str,
		ossimParameter	value1,
		ossimParameter	value2
	)

Definition at line 353 of file ossimArgumentParser.cpp.

References ossimArgumentParser::ossimParameter::assign(), find(), reportError(), theArgv, and ossimArgumentParser::ossimParameter::valid().

{
   int pos=find(str);
   if (pos<=0) return false;
   if (!value1.valid(theArgv[pos+1]) ||
       !value2.valid(theArgv[pos+2]))
   {
      reportError("argument to `"+str+"` is missing");
      return false;
   }
   value1.assign(theArgv[pos+1]);
   value2.assign(theArgv[pos+2]);
   remove(pos,3);
   return true;
}

read() [4/13]

bool ossimArgumentParser::read	(	const std::string &	str,
		ossimParameter	value1,
		ossimParameter	value2,
		ossimParameter	value3
	)

Definition at line 370 of file ossimArgumentParser.cpp.

References ossimArgumentParser::ossimParameter::assign(), find(), reportError(), theArgv, and ossimArgumentParser::ossimParameter::valid().

{
   int pos=find(str);
   if (pos<=0) return false;
   if (!value1.valid(theArgv[pos+1]) ||
       !value2.valid(theArgv[pos+2]) ||
       !value3.valid(theArgv[pos+3]))
   {
      reportError("argument to `"+str+"` is missing");
      return false;
   }
   value1.assign(theArgv[pos+1]);
   value2.assign(theArgv[pos+2]);
   value3.assign(theArgv[pos+3]);
   remove(pos,4);
   return true;
}

read() [5/13]

bool ossimArgumentParser::read	(	const std::string &	str,
		ossimParameter	value1,
		ossimParameter	value2,
		ossimParameter	value3,
		ossimParameter	value4
	)

Definition at line 389 of file ossimArgumentParser.cpp.

References ossimArgumentParser::ossimParameter::assign(), find(), reportError(), theArgv, and ossimArgumentParser::ossimParameter::valid().

{
   int pos=find(str);
   if (pos<=0) return false;
   if (!value1.valid(theArgv[pos+1]) ||
       !value2.valid(theArgv[pos+2]) ||
       !value3.valid(theArgv[pos+3]) ||
       !value4.valid(theArgv[pos+4]))
   {
      reportError("argument to `"+str+"` is missing");
      return false;
   }
   value1.assign(theArgv[pos+1]);
   value2.assign(theArgv[pos+2]);
   value3.assign(theArgv[pos+3]);
   value4.assign(theArgv[pos+4]);
   remove(pos,5);
   return true;
}

read() [6/13]

bool ossimArgumentParser::read	(	const std::string &	str,
		ossimParameter	value1,
		ossimParameter	value2,
		ossimParameter	value3,
		ossimParameter	value4,
		ossimParameter	value5
	)

Definition at line 411 of file ossimArgumentParser.cpp.

References ossimArgumentParser::ossimParameter::assign(), find(), reportError(), theArgv, and ossimArgumentParser::ossimParameter::valid().

{
   int pos=find(str);
   if (pos<=0) return false;
   if (!value1.valid(theArgv[pos+1]) ||
       !value2.valid(theArgv[pos+2]) ||
       !value3.valid(theArgv[pos+3]) ||
       !value4.valid(theArgv[pos+4]) ||
       !value5.valid(theArgv[pos+5]))
   {
      reportError("argument to `"+str+"` is missing");
      return false;
   }
   value1.assign(theArgv[pos+1]);
   value2.assign(theArgv[pos+2]);
   value3.assign(theArgv[pos+3]);
   value4.assign(theArgv[pos+4]);
   value5.assign(theArgv[pos+5]);    
   remove(pos,6);
   return true;
}

read() [7/13]

bool ossimArgumentParser::read	(	const std::string &	str,
		ossimParameter	value1,
		ossimParameter	value2,
		ossimParameter	value3,
		ossimParameter	value4,
		ossimParameter	value5,
		ossimParameter	value6
	)

Definition at line 435 of file ossimArgumentParser.cpp.

References ossimArgumentParser::ossimParameter::assign(), find(), reportError(), theArgv, and ossimArgumentParser::ossimParameter::valid().

{
   int pos=find(str);
   if (pos<=0) return false;
   if (!value1.valid(theArgv[pos+1]) ||
       !value2.valid(theArgv[pos+2]) ||
       !value3.valid(theArgv[pos+3]) ||
       !value4.valid(theArgv[pos+4]) ||
       !value5.valid(theArgv[pos+5]) ||
       !value6.valid(theArgv[pos+6]))       
   {
      reportError("argument to `"+str+"` is missing");
      return false;
   }
   value1.assign(theArgv[pos+1]);
   value2.assign(theArgv[pos+2]);
   value3.assign(theArgv[pos+3]);
   value4.assign(theArgv[pos+4]);
   value5.assign(theArgv[pos+5]);
   value6.assign(theArgv[pos+6]);    
   remove(pos,7);
   return true;
}

read() [8/13]

bool ossimArgumentParser::read	(	const std::string &	str,
		std::vector< ossimString > &	param_list
	)

Alternate form for reading variable length arguments (must be comma-separated), e.g.,.

–input_files file1, file2, file3,file4 next_arg

Note that spaces between arguments are optional. The next_arg entry will not be considered part of the list since there's no comma separator and will be left on the argument array.

Parameters

str	The option string (with "-" or "--")
param_list	Vector to contain results as strings. Always cleared before populating

Returns

True if option found (param_list may be empty f no args followed).

Definition at line 462 of file ossimArgumentParser.cpp.

References find(), ossimString::length(), ossimString::split(), ossimString::string(), theArgc, and theArgv.

{
   // This method reads a comma-separated list.
   param_list.clear();

   int pos=find(str);
   if (pos<=0)
      return false;

   // Option is removed even if no values found:
   remove(pos, 1);
   bool includeNextItem = true;
   while (pos < *theArgc)
   {
      // Check for occurence of next option:
      if (theArgv[pos][0] == '-')
         break;

      // Skip a comma surrounded by spaces:
      ossimString arg = theArgv[pos];
      if (arg == ",")
      {
         remove(pos, 1);
         includeNextItem = true;
         continue;
      }

      if (!includeNextItem && (arg.string()[0] != ','))
         break;

      // Handle comma separated with no spaces (i.e., multiple args reflected as one in theArgv):
      vector<ossimString> sub_args = arg.split(",", true);
      for (ossim_uint32 i=0; i<sub_args.size(); ++i)
         param_list.push_back(sub_args[i]);

      // If current item ends with comma, the list continues:
      if (arg[arg.length()-1] != ',')
         includeNextItem = false;

      remove(pos, 1);
   }

   return true;
}

read() [9/13]

bool ossimArgumentParser::read	(	int	pos,
		const std::string &	str
	)

if the argument value at the position pos matches specified string, and subsequent paramters are also matched then set the paramter values and remove the from the list of arguments.

if the argument value at the posotion pos matches specified string, and subsequent parameters are also matched then set the paramter values and remove the from the list of arguments.

Definition at line 509 of file ossimArgumentParser.cpp.

References match().

{
   if (match(pos,str))
   {
      remove(pos,1);
      return true;
   }
   else
   {
      return false;
   }
}

read() [10/13]

bool ossimArgumentParser::read	(	int	pos,
		const std::string &	str,
		ossimParameter	value1
	)

Definition at line 522 of file ossimArgumentParser.cpp.

References ossimArgumentParser::ossimParameter::assign(), match(), theArgv, and ossimArgumentParser::ossimParameter::valid().

{
   if (match(pos,str) &&
       value1.valid(theArgv[pos+1]))
   {
      value1.assign(theArgv[pos+1]);
      remove(pos,2);
      return true;
   }
   else
   {
      return false;
   }
}

read() [11/13]

bool ossimArgumentParser::read	(	int	pos,
		const std::string &	str,
		ossimParameter	value1,
		ossimParameter	value2
	)

Definition at line 537 of file ossimArgumentParser.cpp.

References ossimArgumentParser::ossimParameter::assign(), match(), theArgv, and ossimArgumentParser::ossimParameter::valid().

{
   if (match(pos,str) &&
       value1.valid(theArgv[pos+1]) &&
       value2.valid(theArgv[pos+2]))
   {
      value1.assign(theArgv[pos+1]);
      value2.assign(theArgv[pos+2]);
      remove(pos,3);
      return true;
   }
   else
   {
      return false;
   }
}

read() [12/13]

bool ossimArgumentParser::read	(	int	pos,
		const std::string &	str,
		ossimParameter	value1,
		ossimParameter	value2,
		ossimParameter	value3
	)

Definition at line 554 of file ossimArgumentParser.cpp.

References ossimArgumentParser::ossimParameter::assign(), match(), theArgv, and ossimArgumentParser::ossimParameter::valid().

{
   if (match(pos,str) &&
       value1.valid(theArgv[pos+1]) &&
       value2.valid(theArgv[pos+2]) &&
       value3.valid(theArgv[pos+3]))
   {
      value1.assign(theArgv[pos+1]);
      value2.assign(theArgv[pos+2]);
      value3.assign(theArgv[pos+3]);
      remove(pos,4);
      return true;
   }
   else
   {
      return false;
   }
}

read() [13/13]

bool ossimArgumentParser::read	(	int	pos,
		const std::string &	str,
		ossimParameter	value1,
		ossimParameter	value2,
		ossimParameter	value3,
		ossimParameter	value4
	)

Definition at line 573 of file ossimArgumentParser.cpp.

References ossimArgumentParser::ossimParameter::assign(), match(), theArgv, and ossimArgumentParser::ossimParameter::valid().

{
   if (match(pos,str) &&
       value1.valid(theArgv[pos+1]) &&
       value2.valid(theArgv[pos+2]) &&
       value3.valid(theArgv[pos+3]) &&
       value4.valid(theArgv[pos+4]))
   {
      value1.assign(theArgv[pos+1]);
      value2.assign(theArgv[pos+2]);
      value3.assign(theArgv[pos+3]);
      value4.assign(theArgv[pos+4]);
      remove(pos,5);
      return true;
   }
   else
   {
      return false;
   }
}

remove()

void ossimArgumentParser::remove	(	int	pos,
		int	num = 1
	)

remove one or more arguments from the argv argument list, and decrement the argc respectively.

Definition at line 284 of file ossimArgumentParser.cpp.

References theArgc, and theArgv.

Referenced by ossimVerticesFinderTool::initialize().

{
   if (num==0) return;
   
   for(;pos+num<*theArgc;++pos)
   {
      theArgv[pos]=theArgv[pos+num];
   }
   for(;pos<*theArgc;++pos)
   {
      theArgv[pos]=0;
   }
   *theArgc-=num;
}

reportError()

void ossimArgumentParser::reportError	(	const std::string &	message,
		ossimErrorSeverity	severity = OSSIM_CRITICAL
	)

report an error message by adding to the ErrorMessageMap.

Definition at line 605 of file ossimArgumentParser.cpp.

References theErrorMessageMap.

Referenced by read(), and reportRemainingOptionsAsUnrecognized().

{
   theErrorMessageMap[message]=severity;
}

reportRemainingOptionsAsUnrecognized()

void ossimArgumentParser::reportRemainingOptionsAsUnrecognized

(

ossimErrorSeverity

severity = OSSIM_BENIGN

)

for each remaining option report it as an unrecongnized.

Definition at line 610 of file ossimArgumentParser.cpp.

References argc(), getApplicationName(), ossimApplicationUsage::getCommandLineOptions(), isOption(), reportError(), theArgv, and theUsage.

Referenced by ossimBatchTest::initialize(), and ossimChipProcTool::processRemainingArgs().

{
   std::set<std::string> options;
   if (theUsage)
   {
      // parse the usage options to get all the option that the application can potential handle.
      for(ossimApplicationUsage::UsageMap::const_iterator itr=theUsage->getCommandLineOptions().begin();
          itr!=theUsage->getCommandLineOptions().end();
          ++itr)
      {
         const std::string& option = itr->first;
         std::string::size_type prevpos = 0, pos = 0;
         while ((pos=option.find(' ',prevpos))!=std::string::npos)
         {
            if (option[prevpos]=='-')
            {
               options.insert(std::string(option,prevpos,pos-prevpos));
            }
            prevpos=pos+1;
         }
         if (option[prevpos]=='-')
         {

            options.insert(std::string(option,prevpos,std::string::npos));
         }
      }

   }

   for(int pos=1;pos<argc();++pos)
   {
      // if an option and havn't been previous querried for report as unrecognized.
      if (isOption(pos) && options.find(theArgv[pos])==options.end())
      {
         reportError(getApplicationName() +": unrecognized option "+theArgv[pos],severity);
      }
   }
}

setApplicationUsage()

void ossimArgumentParser::setApplicationUsage ( ossimApplicationUsage *  usage )

inline

Definition at line 104 of file ossimArgumentParser.h.

References usage().

{ theUsage = usage; }

writeErrorMessages()

void ossimArgumentParser::writeErrorMessages	(	std::ostream &	output,
		ossimErrorSeverity	sevrity = OSSIM_BENIGN
	)

write out error messages at an above specified .

Definition at line 659 of file ossimArgumentParser.cpp.

References getApplicationName(), and theErrorMessageMap.

Referenced by ossimBatchTest::initialize(), ossimChipProcTool::initialize(), and ossimChipProcTool::processRemainingArgs().

{
   for(ossimErrorMessageMap::iterator itr=theErrorMessageMap.begin();
       itr!=theErrorMessageMap.end();
       ++itr)
   {
      if (itr->second>=severity)
      {
         output<< getApplicationName() << ": " << itr->first << std::endl;
      }
   }
}

Member Data Documentation

theArgc

int* ossimArgumentParser::theArgc

protected

Definition at line 241 of file ossimArgumentParser.h.

Referenced by containsOptions(), find(), getApplicationName(), initialize(), insert(), isNumber(), isOption(), isString(), match(), ossimArgumentParser(), read(), remove(), and ~ossimArgumentParser().

theArgv

char** ossimArgumentParser::theArgv

protected

Definition at line 242 of file ossimArgumentParser.h.

Referenced by find(), getApplicationName(), initialize(), insert(), isNumber(), isOption(), isString(), match(), numberOfParams(), ossimArgumentParser(), read(), remove(), reportRemainingOptionsAsUnrecognized(), and ~ossimArgumentParser().

theErrorMessageMap

ossimErrorMessageMap ossimArgumentParser::theErrorMessageMap

protected

Definition at line 243 of file ossimArgumentParser.h.

Referenced by errors(), getErrorMessageMap(), reportError(), and writeErrorMessages().

theMemAllocated

bool ossimArgumentParser::theMemAllocated

protected

Definition at line 245 of file ossimArgumentParser.h.

Referenced by insert(), and ~ossimArgumentParser().

theUsage

ossimApplicationUsage* ossimArgumentParser::theUsage

protected

Definition at line 244 of file ossimArgumentParser.h.

Referenced by ossimArgumentParser(), and reportRemainingOptionsAsUnrecognized().

---

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

• ossimArgumentParser.h
• ossimArgumentParser.cpp