mds::mod::CArgv Class Reference

Application command line arguments parser. More...

#include <mdsArgv.h>

Inheritance diagram for mds::mod::CArgv:

List of all members.

Public Types
enum	{ CLASS_OBJECT }
	Templates that require members of the CObject class can use this enum to check the existence. More...
enum	{ HEAP_OBJECT = 0x70616568 }
	Signature used to recognize objects on the heap. More...
Public Member Functions
	CArgv ()
	Default constructor.
	CArgv (int argc, char *argv[])
	Constructor that parses a given command line.
bool	check (const std::string &sArgs) const
	Checks if only specified labelled arguments were given on the command line.
void	clear ()
	Clears parsed command line.
bool	exists (const std::string &sLabel) const
	Returns true if a labelled argument exists.
int	getNumOfSimpleValues () const
	Returns the number of string arguments at the end of the command line.
int	getNumOfValues () const
	Returns the number of labelled arguments.
int	getReferencesCount () const
	Returns the number of references.
bool	isOnHeap () const
	Returns true if the object is allocated on the heap.
	MDS_SHAREDPTR (CArgv)
	Smart pointer type.
bool	parse (int argc, char *argv[])
	Parses a given command line.
bool	simpleValue (int i, std::string &sValue) const
	Reads the string value of a simple argument.
bool	value (const std::string &sLabel, std::string &sValue) const
	Reads the value of a labeled argument of appropriate type.
bool	value (const std::string &sLabel, char &cValue) const
bool	value (const std::string &sLabel, unsigned &uValue) const
bool	value (const std::string &sLabel, int &iValue) const
bool	value (const std::string &sLabel, double &dValue) const
virtual	~CArgv ()
	Default destructor.
Static Public Member Functions
static void *	operator new (std::size_t Size)
	Allocates a new object on the heap.
Protected Member Functions
void	addReference () const
	Increase the reference counter.
bool	delReference () const
	Decrease the reference counter.
Protected Attributes
int	m_iHeapObject
	Flag initialized if the object is on the heap.
int	m_iReferences
	The number of references to the object.

---

Detailed Description

Application command line arguments parser.

• Command line has the form [ -label value | -label | value ]*

---

Member Enumeration Documentation

anonymous enum [inherited]

Templates that require members of the CObject class can use this enum to check the existence.

Enumerator:

CLASS_OBJECT

anonymous enum [inherited]

Signature used to recognize objects on the heap.

Enumerator:

HEAP_OBJECT

---

Constructor & Destructor Documentation

mds::mod::CArgv::CArgv

(

)

Default constructor.

• Method parse() must be called to parse command line arguments.

mds::mod::CArgv::CArgv	(	int	argc,
		char *	argv[]
	)

Constructor that parses a given command line.

• Program command line (argc, argv).
• Throws warning in case of failure.

mds::mod::CArgv::~CArgv

(

)

[virtual]

Default destructor.

---

Member Function Documentation

void mds::base::CObject::addReference

(

)

const [protected, inherited]

Increase the reference counter.

bool mds::mod::CArgv::check

(

const std::string &

sArgs

)

const

Checks if only specified labelled arguments were given on the command line.

• Names of allowed arguments are given in 'sArgs' string.
• 'sArgs' contains names separated by character ':' (colon).

void mds::mod::CArgv::clear

(

)

Clears parsed command line.

bool mds::base::CObject::delReference

(

)

const [protected, inherited]

Decrease the reference counter.

• Returns true if the decremented number of references is lower or equal to zero and object must be deleted.

bool mds::mod::CArgv::exists

(

const std::string &

sLabel

)

const

Returns true if a labelled argument exists.

int mds::mod::CArgv::getNumOfSimpleValues

(

)

const

Returns the number of string arguments at the end of the command line.

int mds::mod::CArgv::getNumOfValues

(

)

const

Returns the number of labelled arguments.

int mds::base::CObject::getReferencesCount

(

)

const [inherited]

Returns the number of references.

bool mds::base::CObject::isOnHeap

(

)

const [inherited]

Returns true if the object is allocated on the heap.

mds::mod::CArgv::MDS_SHAREDPTR

(

CArgv

)

Smart pointer type.

• Declares type tSmartPtr.

static void* mds::base::CObject::operator new

(

std::size_t

Size

)

[static, inherited]

Allocates a new object on the heap.

bool mds::mod::CArgv::parse	(	int	argc,
		char *	argv[]
	)

Parses a given command line.

• Returns false on failure.

bool mds::mod::CArgv::simpleValue	(	int	i,
		std::string &	sValue
	)		const

Reads the string value of a simple argument.

bool mds::mod::CArgv::value	(	const std::string &	sLabel,
		std::string &	sValue
	)		const

Reads the value of a labeled argument of appropriate type.

• If the argument is unknown false will be returned.

bool mds::mod::CArgv::value	(	const std::string &	sLabel,
		char &	cValue
	)		const

bool mds::mod::CArgv::value	(	const std::string &	sLabel,
		unsigned &	uValue
	)		const

bool mds::mod::CArgv::value	(	const std::string &	sLabel,
		int &	iValue
	)		const

bool mds::mod::CArgv::value	(	const std::string &	sLabel,
		double &	dValue
	)		const

---

Member Data Documentation

int mds::base::CObject::m_iHeapObject [mutable, protected, inherited]

Flag initialized if the object is on the heap.

int mds::base::CObject::m_iReferences [mutable, protected, inherited]

The number of references to the object.

• Zero if there is no reference.

---

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

• mdsArgv.h
• mdsArgv.cpp