Cross-Platform C++

ot::auxil
class BasicOption

#include "ot/auxil/BasicOption.h"

ot::auxil::CommandLineOption ot::auxil::BooleanOption




Constructor/Destructor Summary
BasicOption(const String& longName, CharType shortName, ArgumentType argType)
        
~BasicOption()
        

Method Summary
 virtual const String getArgument() const
        
 virtual ArgumentType getArgumentType() const
        
 const String& getLongName() const
        
 CharType getShortName() const
        
 bool isPresent() const
        
 virtual void setArgument(const String& arg)
        
 virtual void setPresent(const String& howSpecified, OptionType optionTypeUsed)
         Called by the CommandLineParser to indicate to the option that is has been specified on the command line.
 virtual bool testLongOption(const String& option) const
        
 virtual bool testShortOption(CharType option) const
        

Constructor/Destructor Detail

BasicOption

 BasicOption(const String& longName,
             CharType shortName,
             ArgumentType argType)


~BasicOption

virtual ~BasicOption()


Method Detail

getArgument

virtual const String getArgument() const


getArgumentType

virtual ArgumentType getArgumentType() const


getLongName

const StringgetLongName() const


getShortName

CharType getShortName() const


isPresent

bool isPresent() const


setArgument

virtual void setArgument(const String& arg)


setPresent

virtual void setPresent(const String& howSpecified,
                        OptionType optionTypeUsed)
Called by the CommandLineParser to indicate to the option that is has been specified on the command line.

Parameters:
option - how the option was specified on the command line
optionTypeUsed - indicates whether the long or short option was used
Exceptions:
CommandLineException - if the option is a duplicate

testLongOption

virtual bool testLongOption(const String& option) const


testShortOption

virtual bool testShortOption(CharType option) const



Cross-Platform C++

Found a bug or missing feature? Please email us at support@elcel.com

Copyright © 2000-2003 ElCel Technology   Trademark Acknowledgements