alma::AlmaArg Struct Reference

extend the option::Arg struct to provide the necessary argument checking for the alma apps for use with the optionparser suite More...

#include <AlmaArg.h>

Inheritance diagram for alma::AlmaArg:

Static Public Member Functions
static void	printError (const char *msg1, const option::Option &opt, const char *msg2)
static option::ArgStatus	Unknown (const option::Option &option, bool msg)
	unknown argument More...
static option::ArgStatus	Required (const option::Option &option, bool msg)
	an associated value is required opt=arg, no constraints on type More...
static option::ArgStatus	Long (const option::Option &option, bool msg)
	an associated value is required and must be an a long integer More...
static option::ArgStatus	uInt (const option::Option &option, bool msg)
	an associated value is required and must be an unsigned int More...
static option::ArgStatus	Float (const option::Option &option, bool msg)
	an associated value is required and must be a valid floating point (double) More...
static option::ArgStatus	Bool (const option::Option &option, bool msg)
	an associated value is required and must be either "true" or "false" ignores case More...
Static Public Member Functions inherited from option::Arg
static ArgStatus	None (const Option &, bool)
	! More...
static ArgStatus	Optional (const Option &option, bool)
	! More...

Detailed Description

extend the option::Arg struct to provide the necessary argument checking for the alma apps for use with the optionparser suite

Definition at line 19 of file AlmaArg.h.

Member Function Documentation

static option::ArgStatus alma::AlmaArg::Bool ( const option::Option &  option, bool  msg  )

inlinestatic

an associated value is required and must be either "true" or "false" ignores case

Definition at line 83 of file AlmaArg.h.

References option::Option::arg, option::ARG_ILLEGAL, option::ARG_OK, and casacore::trim().

static option::ArgStatus alma::AlmaArg::Float ( const option::Option &  option, bool  msg  )

inlinestatic

an associated value is required and must be a valid floating point (double)

Definition at line 70 of file AlmaArg.h.

References option::Option::arg, option::ARG_ILLEGAL, and option::ARG_OK.

static option::ArgStatus alma::AlmaArg::Long ( const option::Option &  option, bool  msg  )

inlinestatic

an associated value is required and must be an a long integer

Definition at line 44 of file AlmaArg.h.

References option::Option::arg, option::ARG_ILLEGAL, and option::ARG_OK.

static void alma::AlmaArg::printError ( const char *  msg1, const option::Option &  opt, const char *  msg2  )

inlinestatic

Definition at line 21 of file AlmaArg.h.

References option::Option::name, and option::Option::namelen.

static option::ArgStatus alma::AlmaArg::Required ( const option::Option &  option, bool  msg  )

inlinestatic

an associated value is required opt=arg, no constraints on type

Definition at line 34 of file AlmaArg.h.

References option::Option::arg, option::ARG_ILLEGAL, and option::ARG_OK.

static option::ArgStatus alma::AlmaArg::uInt ( const option::Option &  option, bool  msg  )

inlinestatic

an associated value is required and must be an unsigned int

uses strtoul, but must also check that converted value would fit in an unsigned int

Definition at line 56 of file AlmaArg.h.

References option::Option::arg, option::ARG_ILLEGAL, and option::ARG_OK.

static option::ArgStatus alma::AlmaArg::Unknown ( const option::Option &  option, bool  msg  )

inlinestatic

unknown argument

Definition at line 27 of file AlmaArg.h.

References option::ARG_ILLEGAL.

---

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

• casa/code/alma/Options/AlmaArg.h