ossimApplicationUsage Class Reference

#include <ossimApplicationUsage.h>

Public Types
enum	Type { OSSIM_COMMAND_LINE_OPTION = 0x1, OSSIM_ENVIRONMENTAL_VARIABLE = 0x2 }
typedef std::map< ossimString, ossimString, ossimStringLtstr >	UsageMap

Public Member Functions
	ossimApplicationUsage ()
	ossimApplicationUsage (const ossimString &commandLineUsage)
void	setApplicationName (const ossimString &name)
const ossimString &	getApplicationName () const
void	setDescription (const ossimString &desc)
const ossimString &	getDescription () const
void	addUsageExplanation (Type type, const ossimString &option, const ossimString &explanation)
void	setCommandLineUsage (const ossimString &explanation)
const ossimString &	getCommandLineUsage () const
void	addCommandLineOption (const ossimString &option, const ossimString &explanation)
const UsageMap &	getCommandLineOptions () const
void	addEnvironmentalVariable (const ossimString &option, const ossimString &explanation)
const UsageMap &	getEnvironmentalVariables () const
void	getFormatedString (ossimString &str, const UsageMap &um, unsigned int widthOfOutput=80)
void	write (std::ostream &output, const UsageMap &um, unsigned int widthOfOutput=80)
void	write (std::ostream &output, unsigned int type=OSSIM_COMMAND_LINE_OPTION|OSSIM_ENVIRONMENTAL_VARIABLE, unsigned int widthOfOutput=80)

Static Public Member Functions
static ossimApplicationUsage *	instance ()

Protected Attributes
ossimString	theApplicationName
ossimString	theDescription
ossimString	theCommandLineUsage
UsageMap	theCommandLineOptions
UsageMap	theEnvironmentalVariables

Detailed Description

Definition at line 15 of file ossimApplicationUsage.h.

Member Typedef Documentation

UsageMap

typedef std::map<ossimString,ossimString,ossimStringLtstr> ossimApplicationUsage::UsageMap

Definition at line 25 of file ossimApplicationUsage.h.

Member Enumeration Documentation

Type

enum ossimApplicationUsage::Type

Enumerator
OSSIM_COMMAND_LINE_OPTION
OSSIM_ENVIRONMENTAL_VARIABLE

Definition at line 33 of file ossimApplicationUsage.h.

        {
            OSSIM_COMMAND_LINE_OPTION    = 0x1,
            OSSIM_ENVIRONMENTAL_VARIABLE = 0x2
        };

Constructor & Destructor Documentation

ossimApplicationUsage() [1/2]

ossimApplicationUsage::ossimApplicationUsage ( )

inline

Definition at line 21 of file ossimApplicationUsage.h.

{}

ossimApplicationUsage() [2/2]

ossimApplicationUsage::ossimApplicationUsage

(

const ossimString &

commandLineUsage

)

Definition at line 13 of file ossimApplicationUsage.cpp.

                                                                               :
    theCommandLineUsage(commandLineUsage)
{
}

Member Function Documentation

addCommandLineOption()

void ossimApplicationUsage::addCommandLineOption	(	const ossimString &	option,
		const ossimString &	explanation
	)

Definition at line 64 of file ossimApplicationUsage.cpp.

References theCommandLineOptions.

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

{
    theCommandLineOptions[option]=explanation;
}

addEnvironmentalVariable()

void ossimApplicationUsage::addEnvironmentalVariable	(	const ossimString &	option,
		const ossimString &	explanation
	)

Definition at line 74 of file ossimApplicationUsage.cpp.

References theEnvironmentalVariables.

Referenced by addUsageExplanation().

{
    theEnvironmentalVariables[option]=explanation;
}

addUsageExplanation()

void ossimApplicationUsage::addUsageExplanation	(	Type	type,
		const ossimString &	option,
		const ossimString &	explanation
	)

Definition at line 42 of file ossimApplicationUsage.cpp.

References addCommandLineOption(), addEnvironmentalVariable(), OSSIM_COMMAND_LINE_OPTION, and OSSIM_ENVIRONMENTAL_VARIABLE.

Referenced by ApplicationUsageProxy::ApplicationUsageProxy().

{
    switch(type)
    {
        case(OSSIM_COMMAND_LINE_OPTION):
            addCommandLineOption(option,explanation);
            break;
        case(OSSIM_ENVIRONMENTAL_VARIABLE):
            addEnvironmentalVariable(option,explanation);
            break;
    }
}

getApplicationName()

const ossimString & ossimApplicationUsage::getApplicationName

(

)

const

Definition at line 28 of file ossimApplicationUsage.cpp.

References theApplicationName.

{
   return theApplicationName;
}

getCommandLineOptions()

const ossimApplicationUsage::UsageMap & ossimApplicationUsage::getCommandLineOptions

(

)

const

Definition at line 69 of file ossimApplicationUsage.cpp.

References theCommandLineOptions.

Referenced by ossimArgumentParser::reportRemainingOptionsAsUnrecognized(), and write().

{
   return theCommandLineOptions;
}

getCommandLineUsage()

const ossimString & ossimApplicationUsage::getCommandLineUsage

(

)

const

Definition at line 59 of file ossimApplicationUsage.cpp.

References theCommandLineUsage.

Referenced by write().

{
   return theCommandLineUsage;
}

getDescription()

const ossimString & ossimApplicationUsage::getDescription

(

)

const

Definition at line 37 of file ossimApplicationUsage.cpp.

References theDescription.

{
   return theDescription;
}

getEnvironmentalVariables()

const ossimApplicationUsage::UsageMap & ossimApplicationUsage::getEnvironmentalVariables

(

)

const

Definition at line 78 of file ossimApplicationUsage.cpp.

References theEnvironmentalVariables.

Referenced by write().

{
   return theEnvironmentalVariables;
}

getFormatedString()

void ossimApplicationUsage::getFormatedString	(	ossimString &	str,
		const UsageMap &	um,
		unsigned int	widthOfOutput = 80
	)

Definition at line 83 of file ossimApplicationUsage.cpp.

References ossimString::assign(), ossimString::begin(), ossimString::find(), ossimString::length(), ossim::max(), ossim::min(), and ossimString::replace().

Referenced by write().

{

    unsigned int maxNumCharsInOptions = 0;
    ossimApplicationUsage::UsageMap::const_iterator citr;
    for(citr=um.begin();
        citr!=um.end();
        ++citr)
    {
        maxNumCharsInOptions = ossim::max(maxNumCharsInOptions,(unsigned int)citr->first.length());
    }
    
    unsigned int fullWidth = widthOfOutput;
    unsigned int optionPos = 2;
    unsigned int explanationPos = 2+maxNumCharsInOptions+2;
    unsigned int explanationWidth = fullWidth-explanationPos;

    ossimString line;
    
    for(citr=um.begin();
        citr!=um.end();
        ++citr)
    {
        line.assign(fullWidth,' ');
        line.replace(optionPos,citr->first.length(),citr->first);
        
        const ossimString& explanation = citr->second;
        std::string::size_type pos = 0;
        std::string::size_type offset = 0;
        bool firstInLine = true;
        while (pos<explanation.length())
        {
            if (firstInLine) offset = 0;
                    
            // skip any leading white space.
            while (pos<explanation.length() && *(explanation.begin()+pos)==' ')
            {
                if (firstInLine) ++offset;
                ++pos;
            }
            
            firstInLine = false;
        
            std::string::size_type width = ossim::min((ossim_int64)(explanation.length()-pos),
                                                      (ossim_int64)(explanationWidth-offset));
            std::string::size_type slashn_pos = explanation.find('\n',pos);
            
            unsigned int extraSkip = 0;
            bool concatinated = false;
            if (slashn_pos!=std::string::npos)
            {
                if (slashn_pos<pos+width)
                {
                    width = slashn_pos-pos;
                    ++extraSkip;
                    firstInLine = true;
                }
                else if (slashn_pos==pos+width) 
                {
                    ++extraSkip;
                    firstInLine = true;
                }
            }
            
            if (pos+width<explanation.length())
            {
                // now reduce width until we get a space or a return
                // so that we ensure that whole words are printed.
                while (width>0 && 
                       *(explanation.begin()+(pos+width))!=' ' && 
                       *(explanation.begin()+(pos+width))!='\n') --width;
                       
                if (width==0)
                {
                    // word must be longer than a whole line so will need
                    // to concatinate it.
                    width = explanationWidth-1;
                    concatinated = true;
                }
            }

            line.replace(explanationPos+offset,explanationWidth, explanation, pos, width);

            if (concatinated) { str += line; str += "-\n"; }
            else { str += line; str += "\n"; }
            
            // move to the next line of output.
            line.assign(fullWidth,' ');
            
            pos += width+extraSkip;

            
        }
                
    }
}

instance()

ossimApplicationUsage * ossimApplicationUsage::instance ( )

static

Definition at line 18 of file ossimApplicationUsage.cpp.

Referenced by ApplicationUsageProxy::ApplicationUsageProxy().

{
    static ossimApplicationUsage theApplicationUsage;
    return &theApplicationUsage;
}

setApplicationName()

void ossimApplicationUsage::setApplicationName

(

const ossimString &

name

)

Definition at line 23 of file ossimApplicationUsage.cpp.

References theApplicationName.

Referenced by ossimArgumentParser::ossimArgumentParser(), ossimEquationUtil::ossimEquationUtil(), ossimTool::setUsage(), ossimAutRegUtil::usage(), ossimImageUtil::usage(), and ossimChipperUtil::usage().

{
   theApplicationName = name;
}

setCommandLineUsage()

void ossimApplicationUsage::setCommandLineUsage

(

const ossimString &

explanation

)

Definition at line 54 of file ossimApplicationUsage.cpp.

References theCommandLineUsage.

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

{
   theCommandLineUsage=explanation;
}

setDescription()

void ossimApplicationUsage::setDescription

(

const ossimString &

desc

)

Definition at line 32 of file ossimApplicationUsage.cpp.

References theDescription.

Referenced by ossimAutRegUtil::addArguments(), ossimChipperUtil::addArguments(), ossimEquationUtil::ossimEquationUtil(), ossimBandMergeTool::setUsage(), ossimVerticesFinderTool::setUsage(), ossimOrthoTool::setUsage(), ossimSlopeTool::setUsage(), ossimSubImageTool::setUsage(), ossimViewshedTool::setUsage(), ossimHdf5Tool::setUsage(), ossimHillshadeTool::setUsage(), ossimShorelineTool::setUsage(), and ossimInfo::setUsage().

{
   theDescription = desc;
}

write() [1/2]

void ossimApplicationUsage::write	(	std::ostream &	output,
		const UsageMap &	um,
		unsigned int	widthOfOutput = 80
	)

Definition at line 180 of file ossimApplicationUsage.cpp.

References getFormatedString().

Referenced by ossimEquationUtil::execute(), ossimTool::initialize(), ossimPointCloudTool::usage(), ossimBatchTest::usage(), ossimAutRegUtil::usage(), ossimImageUtil::usage(), ossimChipperUtil::usage(), and write().

{
    ossimString str;
    getFormatedString(str, um, widthOfOutput);
    output << str << std::endl;
}

write() [2/2]

void ossimApplicationUsage::write	(	std::ostream &	output,
		unsigned int	type = OSSIM_COMMAND_LINE_OPTION|OSSIM_ENVIRONMENTAL_VARIABLE,
		unsigned int	widthOfOutput = 80
	)

Definition at line 187 of file ossimApplicationUsage.cpp.

References ossimString::c_str(), getCommandLineOptions(), getCommandLineUsage(), getEnvironmentalVariables(), OSSIM_COMMAND_LINE_OPTION, OSSIM_ENVIRONMENTAL_VARIABLE, ossimString::size(), theDescription, and write().

{

    output << "Usage: "<<getCommandLineUsage()<<std::endl;
    if(theDescription.size()>0)
    {
       // TODO: take into account "widthOfOutput"
       output << "\nDescription:\n" << theDescription.c_str() << "\n"
              << std::endl;
    }
    
    bool needspace = false;
    if ((type&OSSIM_COMMAND_LINE_OPTION) && !getCommandLineOptions().empty())
    {
        // if (needspace) output << std::endl;
        output << "Options:"<<std::endl;
        write(output,getCommandLineOptions(),widthOfOutput);
        needspace = true;
    }
    
    if ((type&OSSIM_ENVIRONMENTAL_VARIABLE) && !getEnvironmentalVariables().empty())
    {
        if (needspace) output << std::endl;
        output << "Environmental Variables:"<<std::endl;
        write(output,getEnvironmentalVariables(),widthOfOutput);
        needspace = true;
    }

}

Member Data Documentation

theApplicationName

ossimString ossimApplicationUsage::theApplicationName

protected

Definition at line 63 of file ossimApplicationUsage.h.

Referenced by getApplicationName(), and setApplicationName().

theCommandLineOptions

UsageMap ossimApplicationUsage::theCommandLineOptions

protected

Definition at line 66 of file ossimApplicationUsage.h.

Referenced by addCommandLineOption(), and getCommandLineOptions().

theCommandLineUsage

ossimString ossimApplicationUsage::theCommandLineUsage

protected

Definition at line 65 of file ossimApplicationUsage.h.

Referenced by getCommandLineUsage(), and setCommandLineUsage().

theDescription

ossimString ossimApplicationUsage::theDescription

protected

Definition at line 64 of file ossimApplicationUsage.h.

Referenced by getDescription(), setDescription(), and write().

theEnvironmentalVariables

UsageMap ossimApplicationUsage::theEnvironmentalVariables

protected

Definition at line 67 of file ossimApplicationUsage.h.

Referenced by addEnvironmentalVariable(), and getEnvironmentalVariables().

---

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

• ossimApplicationUsage.h
• ossimApplicationUsage.cpp