AJACommandLineOption Class Reference

#include <commandline.h>

Public Member Functions
	AJACommandLineOption ()
	AJACommandLineOption (const std::string &name)
	AJACommandLineOption (const std::string &name, const std::string &desc)
	AJACommandLineOption (const std::string &name, const std::string &desc, const std::string &defaultValue)
	AJACommandLineOption (const AJAStringList &names)
	AJACommandLineOption (const AJAStringList &names, const std::string &desc)
	AJACommandLineOption (const AJAStringList &names, const std::string &desc, const std::string &defaultValue)
virtual	~AJACommandLineOption ()
bool	AddName (const std::string &name)
AJAStringList	GetNames () const
std::string	GetDesc () const
void	SetDesc (const std::string &desc)
std::string	GetExtraDesc () const
void	SetExtraDesc (const std::string &desc)
void	SetDefaultValue (const std::string &value)
std::string	GetDefaultValue () const
void	AddValue (const std::string &value)
std::string	GetValue (size_t index=0) const
AJAStringList	GetValues () const

Detailed Description

Class that represents a command line option.

Definition at line 30 of file commandline.h.

Constructor & Destructor Documentation

AJACommandLineOption() [1/7]

AJACommandLineOption::AJACommandLineOption

(

)

Definition at line 18 of file commandline.cpp.

AJACommandLineOption() [2/7]

AJACommandLineOption::AJACommandLineOption

(

const std::string &

name

)

Definition at line 22 of file commandline.cpp.

AJACommandLineOption() [3/7]

AJACommandLineOption::AJACommandLineOption	(	const std::string &	name,
		const std::string &	desc
	)

Definition at line 28 of file commandline.cpp.

AJACommandLineOption() [4/7]

AJACommandLineOption::AJACommandLineOption	(	const std::string &	name,
		const std::string &	desc,
		const std::string &	defaultValue
	)

Definition at line 35 of file commandline.cpp.

AJACommandLineOption() [5/7]

AJACommandLineOption::AJACommandLineOption

(

const AJAStringList &

names

)

Definition at line 43 of file commandline.cpp.

AJACommandLineOption() [6/7]

AJACommandLineOption::AJACommandLineOption	(	const AJAStringList &	names,
		const std::string &	desc
	)

Definition at line 51 of file commandline.cpp.

AJACommandLineOption() [7/7]

AJACommandLineOption::AJACommandLineOption	(	const AJAStringList &	names,
		const std::string &	desc,
		const std::string &	defaultValue
	)

Definition at line 60 of file commandline.cpp.

~AJACommandLineOption()

AJACommandLineOption::~AJACommandLineOption ( )

virtual

Definition at line 71 of file commandline.cpp.

Member Function Documentation

AddName()

bool AJACommandLineOption::AddName

(

const std::string &

name

)

Add an arg name to this command line option.

Parameters

[in]

name

The arg name to add.

Definition at line 75 of file commandline.cpp.

AddValue()

void AJACommandLineOption::AddValue

(

const std::string &

value

)

Definition at line 127 of file commandline.cpp.

GetDefaultValue()

std::string AJACommandLineOption::GetDefaultValue

(

)

const

Get the default value string for this command line option.

Returns

The default value string.

Definition at line 122 of file commandline.cpp.

GetDesc()

std::string AJACommandLineOption::GetDesc

(

)

const

Get the description string for this command line option.

Returns

The description string.

Definition at line 96 of file commandline.cpp.

GetExtraDesc()

std::string AJACommandLineOption::GetExtraDesc

(

)

const

Get the extra description string for this command line option.

Returns

The extra description string.

Definition at line 106 of file commandline.cpp.

GetNames()

AJAStringList AJACommandLineOption::GetNames

(

)

const

Get list of arg names attached to this command line option.

Returns

The list of names.

Definition at line 91 of file commandline.cpp.

GetValue()

std::string AJACommandLineOption::GetValue

(

size_t

index = 0

)

const

Definition at line 132 of file commandline.cpp.

GetValues()

AJAStringList AJACommandLineOption::GetValues

(

)

const

Definition at line 139 of file commandline.cpp.

SetDefaultValue()

void AJACommandLineOption::SetDefaultValue

(

const std::string &

value

)

Set the default value string for this command line option.

Parameters

[in]

desc

The default value string.

Definition at line 117 of file commandline.cpp.

SetDesc()

void AJACommandLineOption::SetDesc

(

const std::string &

desc

)

Set the description string for this command line option.

Parameters

[in]

desc

The description string.

Definition at line 101 of file commandline.cpp.

SetExtraDesc()

void AJACommandLineOption::SetExtraDesc

(

const std::string &

desc

)

Set the extra description string for this command line option.

Parameters

[in]

desc

The extra description string.

Definition at line 111 of file commandline.cpp.

---

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

• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajabase/common/commandline.h
• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajabase/common/commandline.cpp