FEAT::Parameter< T_ > Class Template Reference

Parameter of an ArgParser. More...

#include <arg_parser.hpp>

Public Member Functions
	Parameter (std::shared_ptr< Intern::ParameterCore > &&core)
	Parameter (std::shared_ptr< Intern::ParameterCore > core)
	operator bool ()
	Check if argument was set by user. More...
const T_ &	operator* () const
	Accessor for parameter value. More...
const T_ *	operator-> () const
	Accessor for parameter value. More...
const T_ &	value () const
	Accessor for parameter value. More...

Private Attributes
std::shared_ptr< Intern::ParameterCore >	_core

Friends
template<typename U_ >
class	ParameterBuilder

Detailed Description

template<typename T_>
class FEAT::Parameter< T_ >

Parameter of an ArgParser.

This class acts like a "smart-pointer" giving access to the parsed value for an parameter.

Definition at line 330 of file arg_parser.hpp.

Constructor & Destructor Documentation

Parameter() [1/2]

template<typename T_ >

FEAT::Parameter< T_ >::Parameter ( std::shared_ptr< Intern::ParameterCore > &&  core )

inlineexplicit

Definition at line 339 of file arg_parser.hpp.

Parameter() [2/2]

template<typename T_ >

FEAT::Parameter< T_ >::Parameter ( std::shared_ptr< Intern::ParameterCore >  core )

inlineexplicit

Definition at line 343 of file arg_parser.hpp.

Member Function Documentation

operator bool()

template<typename T_ >

FEAT::Parameter< T_ >::operator bool ( )

inline

Check if argument was set by user.

Returns

True, if the argument was explicitly set by the user, false otherwise.

Definition at line 352 of file arg_parser.hpp.

operator*()

template<typename T_ >

const T_ & FEAT::Parameter< T_ >::operator* ( ) const

inline

Accessor for parameter value.

Definition at line 364 of file arg_parser.hpp.

operator->()

template<typename T_ >

const T_ * FEAT::Parameter< T_ >::operator-> ( ) const

inline

Accessor for parameter value.

Definition at line 370 of file arg_parser.hpp.

value()

template<typename T_ >

const T_ & FEAT::Parameter< T_ >::value ( ) const

inline

Accessor for parameter value.

Definition at line 358 of file arg_parser.hpp.

Friends And Related Function Documentation

ParameterBuilder

template<typename T_ >

template<typename U_ >

friend class ParameterBuilder

friend

Definition at line 337 of file arg_parser.hpp.

Member Data Documentation

_core

template<typename T_ >

std::shared_ptr<Intern::ParameterCore> FEAT::Parameter< T_ >::_core

private

Definition at line 333 of file arg_parser.hpp.

---

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

• kernel/util/arg_parser.hpp