rnr::cmd::CmdExtArg Class Reference

Command EXTended ARGument class holding parsed command context and the raw and converted argmument values. More...

#include <CmdExtArg.h>

Public Types
enum	CvtType {   CvtTypeUndef,   CvtTypeString,   CvtTypeEnum,   CvtTypeBoolean,   CvtTypeInteger,   CvtTypeFpn }
	Converted types. More...

Public Member Functions
	CmdExtArg ()
	Default constructor.
	CmdExtArg (const int &nCmdUid, const int &nFormIndex, const int &nArgIndex, const int &nArgInstance, const std::string &strArg)
	Initialization constructor. More...
	CmdExtArg (const CmdExtArg &src)
	Copy constructor. More...
virtual	~CmdExtArg ()
	Destructor.
CmdExtArg &	operator= (const CmdExtArg &rhs)
	Assignment operator. More...
int	uid () const
	Get the argument's associated parsed command unique id. More...
int	formIndex () const
	Get the argument's associated parsed form definition index. More...
int	argIndex () const
	Get the argument's associated parsed argument definition index. More...
int	argInstance () const
	Get the argument's instance number of (uid, formindex, argindex) parsed argument definition index. More...
const std::string &	arg () const
	Get raw source argument string (or a pirate grunting). More...
bool	isValid () const
	Check if converted value is valid. More...
CvtType	type () const
	Get the converted argument type. More...
const std::string &	s () const
	Get the converted string value. More...
long	e () const
	Get the converted enumeration index value. More...
bool	b () const
	Get the converted boolean value. More...
long	i () const
	Get the converted integer value. More...
double	f () const
	Get the converted floating-point number value. More...
bool	operator== (const CmdExtArg &rval) const
	Comparison operator this == rval. More...
bool	operator== (const std::string &rval) const
bool	operator== (const char *const &rval) const
bool	operator== (const bool &rval) const
bool	operator== (const long &rval) const
bool	operator== (const double &rval) const
bool	operator!= (const CmdExtArg &rval) const
	Comparison operator this != rval. More...
bool	operator!= (const std::string &rval) const
bool	operator!= (const char *const &rval) const
bool	operator!= (const bool &rval) const
bool	operator!= (const long &rval) const
bool	operator!= (const double &rval) const

Protected Member Functions
void	arg (const std::string &strArg)
	Set the argument string value. More...
void	s (const std::string &strVal)
	Set the converted string value. More...
void	e (const long eVal)
	Set the converted index into literal enum list value. More...
void	b (const bool bVal)
	Set the converted boolean value. More...
void	i (const long lVal)
	Set the converted integer value. More...
void	f (const double fVal)
	Set the converted floating-point number value. More...

Protected Attributes
int	m_nCmdUid
	command definition unique id
int	m_nFormIndex
	form definition index
int	m_nArgIndex
	argument definition index
int	m_nArgInstance
	argument instance (FUTURE)
std::string	m_strArg
	argument unconverted raw value string
CvtType	m_eCvtType
	converted type
std::string	m_strCvtVal
	converted string value
bool	m_bCvtVal
	converted boolean value
long	m_lCvtVal
	converted integer/index value
double	m_fCvtVal
	converted float-point number value

Friends
class	CmdArgDef
std::ostream &	operator<< (std::ostream &os, const CmdExtArg &arg)
	Insert object into output stream. More...
LogBook &	operator<< (LogBook &log, const CmdExtArg &arg)
	Insert object into LogBook pending entry. More...

Detailed Description

Command EXTended ARGument class holding parsed command context and the raw and converted argmument values.

Extended arguments are an alternative command interface to the standard simple command string arguments.

Definition at line 91 of file CmdExtArg.h.

Member Enumeration Documentation

enum rnr::cmd::CmdExtArg::CvtType

Converted types.

Enumerator
CvtTypeUndef	unknown or uninitialized type
CvtTypeString	string type
CvtTypeEnum	index into literal enumeration list
CvtTypeBoolean	boolean type
CvtTypeInteger	integer type
CvtTypeFpn	floating-point number type

Definition at line 97 of file CmdExtArg.h.

      {
        CvtTypeUndef,       ///< unknown or uninitialized type
        CvtTypeString,      ///< string type
        CvtTypeEnum,        ///< index into literal enumeration list
        CvtTypeBoolean,     ///< boolean type
        CvtTypeInteger,     ///< integer type
        CvtTypeFpn          ///< floating-point number type
      };

Constructor & Destructor Documentation

rnr::cmd::CmdExtArg::CmdExtArg	(	const int &	nCmdUid,
		const int &	nFormIndex,
		const int &	nArgIndex,
		const int &	nArgInstance,
		const std::string &	strArg
	)

Initialization constructor.

Parameters

nCmdUid	Command definition unique id.
nFormIndex	Form definition index.
nArgIndex	Argument definition index.
nArgInstance	Argument instance (FUTURE).
strArg	Source argument string.

CmdExtArg::CmdExtArg

(

const CmdExtArg &

src

)

Copy constructor.

Parameters

src	Source object.

Definition at line 109 of file CmdExtArg.cxx.

References m_bCvtVal, m_eCvtType, m_fCvtVal, m_lCvtVal, m_nArgIndex, m_nArgInstance, m_nCmdUid, m_nFormIndex, m_strArg, and m_strCvtVal.

{
  m_nCmdUid       = src.m_nCmdUid;
  m_nFormIndex    = src.m_nFormIndex;
  m_nArgIndex     = src.m_nArgIndex;
  m_nArgInstance  = src.m_nArgInstance;
  m_strArg        = src.m_strArg;
  m_eCvtType      = src.m_eCvtType;
  m_strCvtVal     = src.m_strCvtVal;
  m_bCvtVal       = src.m_bCvtVal;
  m_lCvtVal       = src.m_lCvtVal;
  m_fCvtVal       = src.m_fCvtVal;
}

Member Function Documentation

const std::string& rnr::cmd::CmdExtArg::arg ( ) const

inline

Get raw source argument string (or a pirate grunting).

Returns

String.

Definition at line 194 of file CmdExtArg.h.

References m_strArg.

Referenced by operator!=(), and operator==().

{ return m_strArg; }

void rnr::cmd::CmdExtArg::arg ( const std::string &  strArg )

inlineprotected

Set the argument string value.

Parameters

strArg

Source argument string.

Definition at line 350 of file CmdExtArg.h.

References b(), e(), f(), i(), and s().

      {
        m_strArg = strArg;
      }

int rnr::cmd::CmdExtArg::argIndex ( ) const

inline

Get the argument's associated parsed argument definition index.

Returns

Argument index.

Definition at line 172 of file CmdExtArg.h.

References m_nArgIndex.

Referenced by rnr::cmd::CommandLine::getArgDefType(), and rnr::cmd::CommandLine::getArgName().

{ return m_nArgIndex; }

int rnr::cmd::CmdExtArg::argInstance ( ) const

inline

Get the argument's instance number of (uid, formindex, argindex) parsed argument definition index.

FUTURE

Returns

Argument index.

Definition at line 182 of file CmdExtArg.h.

References m_nArgInstance.

{ return m_nArgInstance; }

bool rnr::cmd::CmdExtArg::b ( ) const

inline

Get the converted boolean value.

Returns

Returns bool.

Definition at line 229 of file CmdExtArg.h.

References m_bCvtVal.

Referenced by arg(), rnr::cmd::CmdArgDef::convert(), and operator==().

{ return m_bCvtVal; }

void CmdExtArg::b ( const bool  bVal )

protected

Set the converted boolean value.

Parameters

bVal	Value to set.

Definition at line 154 of file CmdExtArg.cxx.

{
  m_bCvtVal   = bVal;
  m_eCvtType  = CvtTypeBoolean;
}

long rnr::cmd::CmdExtArg::e ( ) const

inline

Get the converted enumeration index value.

Returns

Returns index.

Definition at line 222 of file CmdExtArg.h.

References m_lCvtVal.

Referenced by arg(), and rnr::cmd::CmdArgDef::convert().

{ return m_lCvtVal; }

void CmdExtArg::e ( const long  eVal )

protected

Set the converted index into literal enum list value.

Note

A literal has both a string and integer enumeration. So any relevant operators and methods supports both interface.

Parameters

eVal	Value to set.

Definition at line 147 of file CmdExtArg.cxx.

{
  m_strCvtVal = m_strArg;
  m_lCvtVal   = eVal;
  m_eCvtType  = CvtTypeEnum;
}

double rnr::cmd::CmdExtArg::f ( ) const

inline

Get the converted floating-point number value.

Returns

Returns double.

Definition at line 243 of file CmdExtArg.h.

References m_fCvtVal, and operator==().

Referenced by arg(), rnr::cmd::CmdArgDef::convert(), and operator==().

{ return m_fCvtVal; }

void CmdExtArg::f ( const double  fVal )

protected

Set the converted floating-point number value.

Parameters

fVal	Value to set.

Definition at line 166 of file CmdExtArg.cxx.

{
  m_fCvtVal   = fVal;
  m_eCvtType  = CvtTypeFpn;
}

int rnr::cmd::CmdExtArg::formIndex ( ) const

inline

Get the argument's associated parsed form definition index.

Returns

Form index.

Definition at line 165 of file CmdExtArg.h.

References m_nFormIndex.

Referenced by rnr::cmd::CommandLine::getArgDefType(), rnr::cmd::CommandLine::getArgName(), rnr::cmd::CommandLine::numOfArgs(), rnr::cmd::CommandLine::numOfOptionalArgs(), and rnr::cmd::CommandLine::numOfRequiredArgs().

{ return m_nFormIndex; }

long rnr::cmd::CmdExtArg::i ( ) const

inline

Get the converted integer value.

Returns

Returns long.

Definition at line 236 of file CmdExtArg.h.

References m_lCvtVal.

Referenced by arg(), rnr::cmd::CmdArgDef::convert(), and operator==().

{ return m_lCvtVal; }

void CmdExtArg::i ( const long  lVal )

protected

Set the converted integer value.

Parameters

lVal	Value to set.

Definition at line 160 of file CmdExtArg.cxx.

{
  m_lCvtVal   = lVal;
  m_eCvtType  = CvtTypeInteger;
}

bool rnr::cmd::CmdExtArg::isValid ( ) const

inline

Check if converted value is valid.

Returns

Returns true or false.

Definition at line 201 of file CmdExtArg.h.

References CvtTypeUndef, and m_eCvtType.

{ return m_eCvtType != CvtTypeUndef; }

bool rnr::cmd::CmdExtArg::operator!= ( const CmdExtArg &  rval ) const

inline

Comparison operator this != rval.

Parameters

rval	Rvalue object.

Returns

Returns true if not equal, false otherwise.

Definition at line 283 of file CmdExtArg.h.

References arg(), and operator<<.

{ return !(*this == rval); }

CmdExtArg & CmdExtArg::operator=

(

const CmdExtArg &

rhs

)

Assignment operator.

Parameters

rhs	Right-hand side object.

Returns

*this

Definition at line 127 of file CmdExtArg.cxx.

References m_bCvtVal, m_eCvtType, m_fCvtVal, m_lCvtVal, m_nArgIndex, m_nArgInstance, m_nCmdUid, m_nFormIndex, m_strArg, and m_strCvtVal.

{
  m_nCmdUid       = rhs.m_nCmdUid;
  m_nFormIndex    = rhs.m_nFormIndex;
  m_nArgIndex     = rhs.m_nArgIndex;
  m_nArgInstance  = rhs.m_nArgInstance;
  m_strArg        = rhs.m_strArg;
  m_eCvtType      = rhs.m_eCvtType;
  m_strCvtVal     = rhs.m_strCvtVal;
  m_bCvtVal       = rhs.m_bCvtVal;
  m_lCvtVal       = rhs.m_lCvtVal;
  m_fCvtVal       = rhs.m_fCvtVal;
}

bool CmdExtArg::operator==

(

const CmdExtArg &

rval

)

const

Comparison operator this == rval.

Parameters

rval	Rvalue object.

Returns

Returns true if equal, false otherwise.

Definition at line 172 of file CmdExtArg.cxx.

References arg(), b(), f(), i(), operator<<(), s(), type(), and rnr::cmd::undefstring.

Referenced by f().

{
  return (type() == rval.type()) && (arg() == rval.arg());
}

const std::string& rnr::cmd::CmdExtArg::s ( ) const

inline

Get the converted string value.

Returns

Returns string.

Definition at line 215 of file CmdExtArg.h.

References m_strCvtVal.

Referenced by arg(), rnr::cmd::CmdArgDef::convert(), and operator==().

{ return m_strCvtVal; }

void rnr::cmd::CmdExtArg::s ( const std::string &  strVal )

protected

Set the converted string value.

Parameters

strVal

Value to set.

CvtType rnr::cmd::CmdExtArg::type ( ) const

inline

Get the converted argument type.

Returns

CmdExtArg::CvtType value.

Definition at line 208 of file CmdExtArg.h.

References m_eCvtType.

Referenced by operator==().

{ return m_eCvtType; }

int rnr::cmd::CmdExtArg::uid ( ) const

inline

Get the argument's associated parsed command unique id.

Returns

Unique id.

Definition at line 158 of file CmdExtArg.h.

References m_nCmdUid.

Referenced by checkCmd(), rnr::cmd::CommandLine::getArgDefType(), rnr::cmd::CommandLine::getArgName(), rnr::cmd::CommandLine::numOfArgs(), rnr::cmd::CommandLine::numOfOptionalArgs(), and rnr::cmd::CommandLine::numOfRequiredArgs().

{ return m_nCmdUid; }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const CmdExtArg &  arg  )

friend

Insert object into output stream.

Parameters

os	Output stream.
arg	Object to insert.

Returns

Reference to output stream.

Referenced by operator!=().

LogBook& operator<< ( LogBook &  log, const CmdExtArg &  arg  )

friend

Insert object into LogBook pending entry.

Parameters

log	LogBook stream.
arg	Object to insert.

Returns

Reference to LogBook.

---

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

• include/rnr/appkit/CmdExtArg.h
• sw/librnr_appkit/CmdExtArg.cxx