oa::CmdCli

CmdCli class in the OA Core public surface.

ClC++ public headers

Public Methods

OptCli * oa::CmdCli::addFlag(oa::StringView inNames, bool & outTarget, oa::StringView inDescription)

OptCli * oa::CmdCli::addMultiOption(oa::StringView inNames, oa::Vector<oa::String> & outTarget, oa::StringView inDescription)

OptCli * oa::CmdCli::addOption(oa::StringView inNames, T & outTarget, oa::StringView inDescription)

OptCli * oa::CmdCli::addPositional(oa::StringView inName, T & outTarget, oa::StringView inDescription, bool inRequired = false)

const oa::String & oa::CmdCli::getName()

bool oa::CmdCli::parsed()

Constructor & Destructor Documentation

oa::CmdCli::CmdCli()

No public source comment is attached to this declaration.

oa::CmdCli::CmdCli(
	oa::String inName,
	oa::String inDescription
)

No public source comment is attached to this declaration.

Parameters

inName

oa::String

—

inDescription

oa::String

—

Public Method Documentation

OptCli * oa::CmdCli::addFlag(
	oa::StringView inNames,
	bool & outTarget,
	oa::StringView inDescription
)

No public source comment is attached to this declaration.

Parameters

inNames

oa::StringView

—

outTarget

bool &

—

inDescription

oa::StringView

—

Returns

OptCli *

The declared return value.

OptCli * oa::CmdCli::addMultiOption(
	oa::StringView inNames,
	oa::Vector<oa::String> & outTarget,
	oa::StringView inDescription
)

No public source comment is attached to this declaration.

Parameters

inNames

oa::StringView

—

outTarget

oa::Vector<oa::String> &

—

inDescription

oa::StringView

—

Returns

OptCli *

The declared return value.

OptCli * oa::CmdCli::addOption(
	oa::StringView inNames,
	T & outTarget,
	oa::StringView inDescription
)

No public source comment is attached to this declaration.

Parameters

inNames

oa::StringView

—

outTarget

T &

—

inDescription

oa::StringView

—

Returns

OptCli *

The declared return value.

OptCli * oa::CmdCli::addPositional(
	oa::StringView inName,
	T & outTarget,
	oa::StringView inDescription,
	bool inRequired = false
)

No public source comment is attached to this declaration.

Parameters

inName

oa::StringView

—

outTarget

T &

—

inDescription

oa::StringView

—

inRequired

bool

Default: false

Returns

OptCli *

The declared return value.

const oa::String & oa::CmdCli::getName()

No public source comment is attached to this declaration.

Returns

const oa::String &

The declared return value.

bool oa::CmdCli::parsed()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.