| main | class hierarchy | alphabetical | list | functions | files | tutorial | programs |

smtk::option_item Class Reference

a class for holding options that are parsed for smtk::parse_arguments More...

List of all members.

Public Member Functions
option_item *	get_child (const char *long_name)
double	get_double (int num=0) const
float	get_float (int num=0) const
int	get_int (int num=0) const
long	get_long (int num=0) const
long double	get_long_double (int num=0) const
option_item *	get_next (const char *long_name)
option_item *	get_next (void)
option_item *	get_next_child (option_item *child)
option_item *	get_next_child (const char *long_name, option_item *child)
char *	get_string (int num=0) const
void	print (void) const

---

Detailed Description

a class for holding options that are parsed for smtk::parse_arguments

---

Member Function Documentation

option_item* smtk::option_item::get_child

(

const char *

long_name

)

[inline]

get an option_item

Parameters:

long_name

is the long name of the option item that you are checking

Returns:

a pointer to the first option item with long name long_name or 0 if none is present

double option_item::get_double

(

int

num = 0

)

const

get a double

Parameters:

num

argument number starting at 0.

Returns:

a double from the users arguments

float option_item::get_float

(

int

num = 0

)

const

get a float

Parameters:

num

argument number starting at 0.

Returns:

a float from the users arguments

int option_item::get_int

(

int

num = 0

)

const

get an int

Parameters:

num

argument number starting at 0.

Returns:

an int from the users arguments

long option_item::get_long

(

int

num = 0

)

const

get an long

Parameters:

num

argument number starting at 0.

Returns:

a long from the users arguments

long double option_item::get_long_double

(

int

num = 0

)

const

get a long double

Parameters:

num

argument number starting at 0.

Returns:

a long double from the users arguments

option_item* smtk::option_item::get_next

(

const char *

long_name

)

[inline]

get the next option_item

Parameters:

long_name

is the long name of the option item that you are checking

Returns:

a pointer to the next option item or 0 if there are no more

option_item* smtk::option_item::get_next

(

void

)

[inline]

get the next option_item

Returns:

a pointer to the next option item or 0 if there are no more

option_item* smtk::option_item::get_next_child

(

option_item *

child

)

[inline]

get the next option_item

Parameters:

child

is the option_item before

Returns:

a pointer to the next option item of 0 if there is none.

option_item* smtk::option_item::get_next_child	(	const char *	long_name,
		option_item *	child
	)			[inline]

get the next child option_item

Parameters:

	long_name	is the long name of the option item that you are checking
	child	is the child before

Returns:

a pointer to the option item with long name long_name or 0 if none is present

char* smtk::option_item::get_string

(

int

num = 0

)

const [inline]

get a string

Returns:

a pointer to memory in this class. If you need to copy it to your own memory.

void smtk::option_item::print

(

void

)

const [inline]

print the option arguments that generated this option_item

---

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

• libsmtk/smtk/parse_arguments.h
• libsmtk/parse_arguments.cpp

---