rasdaman complete source
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
CommandLineParameter Class Referenceabstract

#include <cmlparser.hh>

Inheritance diagram for CommandLineParameter:
FlagParameter StringParameter

Public Member Functions

virtual ~CommandLineParameter ()
 
void setDescription (const char *)
 
bool doesMatch (char c)
 
bool doesMatch (const char *s)
 
char getShortName () const
 
const char * getLongName () const
 
virtual bool setPresent (char c)=0 throw (CmlException)
 
virtual bool setPresent (const char *s)=0 throw (CmlException)
 
virtual bool needsValue ()=0
 
virtual bool takeValue (const char *s)=0
 
virtual void popValue ()=0
 
virtual void reset ()
 
const char * calledName ()
 
virtual bool isPresent ()=0
 
virtual const char * getValueAsString ()=0 throw (CmlException)
 
virtual long getValueAsLong ()=0 throw (CmlException)
 
virtual double getValueAsDouble ()=0 throw (CmlException)
 
virtual ostream & printStatus (ostream &=cout)=0
 
ostream & printHelp (ostream &=cout)
 

Static Public Attributes

static const char * defaultTitle
 
static const char * descSep
 
static const char * descTab
 
static const char * descIndent
 
static const char * descLineSep
 
static const char descOpen
 
static const char descClose
 
static const char * descLeftDefault
 
static const char * descRightDefault
 

Protected Member Functions

 CommandLineParameter (char newShortName, const char *newLongName, const char *newDefaultValue) throw (CmlException)
 
 CommandLineParameter (char newShortName, const char *newLongName, long newDefaultValue) throw (CmlException)
 

Protected Attributes

char shortName
 
char * longName
 
bool present
 
bool wasLongName
 
char * defaultValue
 
char shNameString [2]
 
char * descriptionText
 
char * paramDescription
 

Constructor & Destructor Documentation

virtual CommandLineParameter::~CommandLineParameter ( )
virtual
CommandLineParameter::CommandLineParameter ( char  newShortName,
const char *  newLongName,
const char *  newDefaultValue 
)
throw (CmlException
)
protected
CommandLineParameter::CommandLineParameter ( char  newShortName,
const char *  newLongName,
long  newDefaultValue 
)
throw (CmlException
)
protected

Member Function Documentation

const char* CommandLineParameter::calledName ( )
bool CommandLineParameter::doesMatch ( char  c)
bool CommandLineParameter::doesMatch ( const char *  s)
const char* CommandLineParameter::getLongName ( ) const
char CommandLineParameter::getShortName ( ) const
virtual double CommandLineParameter::getValueAsDouble ( )
throw (CmlException
)
pure virtual

Implemented in StringParameter, and FlagParameter.

virtual long CommandLineParameter::getValueAsLong ( )
throw (CmlException
)
pure virtual

Implemented in StringParameter, and FlagParameter.

virtual const char* CommandLineParameter::getValueAsString ( )
throw (CmlException
)
pure virtual

Implemented in StringParameter, and FlagParameter.

virtual bool CommandLineParameter::isPresent ( )
pure virtual

Implemented in StringParameter, and FlagParameter.

virtual bool CommandLineParameter::needsValue ( )
pure virtual

Implemented in StringParameter, and FlagParameter.

virtual void CommandLineParameter::popValue ( )
pure virtual

Implemented in StringParameter, and FlagParameter.

ostream& CommandLineParameter::printHelp ( ostream &  = cout)
virtual ostream& CommandLineParameter::printStatus ( ostream &  = cout)
pure virtual

Implemented in StringParameter, and FlagParameter.

virtual void CommandLineParameter::reset ( )
virtual

Reimplemented in StringParameter.

void CommandLineParameter::setDescription ( const char *  )
virtual bool CommandLineParameter::setPresent ( char  c)
throw (CmlException
)
pure virtual

Implemented in StringParameter, and FlagParameter.

virtual bool CommandLineParameter::setPresent ( const char *  s)
throw (CmlException
)
pure virtual

Implemented in StringParameter, and FlagParameter.

virtual bool CommandLineParameter::takeValue ( const char *  s)
pure virtual

Implemented in StringParameter, and FlagParameter.

Member Data Documentation

const char* CommandLineParameter::defaultTitle
static
char* CommandLineParameter::defaultValue
protected
const char CommandLineParameter::descClose
static
const char* CommandLineParameter::descIndent
static
const char* CommandLineParameter::descLeftDefault
static
const char* CommandLineParameter::descLineSep
static
const char CommandLineParameter::descOpen
static
const char* CommandLineParameter::descRightDefault
static
char* CommandLineParameter::descriptionText
protected
const char* CommandLineParameter::descSep
static
const char* CommandLineParameter::descTab
static
char* CommandLineParameter::longName
protected
char* CommandLineParameter::paramDescription
protected
bool CommandLineParameter::present
protected
char CommandLineParameter::shNameString[2]
protected
char CommandLineParameter::shortName
protected
bool CommandLineParameter::wasLongName
protected

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