kaycxx::cli::parameter_handle< T > Class Template Reference

Handle for a registered positional parameter. More...

#include <kaycxx/cli/parameter_handle.hpp>

Public Member Functions
parameter< T > const &	definition () const noexcept
	Returns the underlying parameter definition.
parameter_handle	default_value (T value)
	Sets the default parameter value.

Friends
class	command

Detailed Description

template<parseable_value T>
class kaycxx::cli::parameter_handle< T >

Handle for a registered positional parameter.

The handle does not own the parameter definition. It references data owned by the command that created it.

Template Parameters

T	Parameter value type.

Member Function Documentation

default_value()

template<parseable_value T>

parameter_handle kaycxx::cli::parameter_handle< T >::default_value ( T  value )

inline

Sets the default parameter value.

Parameters

value

Default value used when the positional parameter is not present in parsed arguments.

Returns

This handle for chaining.

definition()

template<parseable_value T>

parameter< T > const & kaycxx::cli::parameter_handle< T >::definition ( ) const

inlinenoexcept

Returns the underlying parameter definition.

Returns

Parameter definition owned by the command.

---

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

• kaycxx/cli/parameter_handle.hpp