R3B::ParView< ParType > Class Template Reference

#include <R3BParView.h>

Public Types
using	Type = ParType

Public Member Functions
	ParView (std::string_view par_name)
	Constructor.
auto	get () const -> Type *
	Get the parameter pointer.
auto	get_name () const -> std::string_view
	Get the name of the paramter.
auto	set (Type *par) -> Type *
	Set the pointer of the parameter.
auto	operator-> () -> Type *
auto	operator* () -> Type &

Private Attributes
std::string	name_
ParType *	parameter_ = nullptr

Detailed Description

template<typename ParType>
class R3B::ParView< ParType >

Definition at line 10 of file R3BParView.h.

Member Typedef Documentation

Type

template<typename ParType>

using R3B::ParView< ParType >::Type = ParType

Definition at line 13 of file R3BParView.h.

Constructor & Destructor Documentation

ParView()

template<typename ParType>

R3B::ParView< ParType >::ParView ( std::string_view par_name )

inlineexplicit

Parameters

par_name

Paramter name

Definition at line 20 of file R3BParView.h.

Member Function Documentation

get()

template<typename ParType>

auto R3B::ParView< ParType >::get ( ) const -> Type*

inline

Returns

A pointer to the underlying parameter.

See also

ref

Definition at line 31 of file R3BParView.h.

get_name()

template<typename ParType>

auto R3B::ParView< ParType >::get_name ( ) const -> std::string_view

inlinenodiscard

Returns

Parameter name

Definition at line 38 of file R3BParView.h.

operator*()

template<typename ParType>

auto R3B::ParView< ParType >::operator* ( ) -> Type&

inline

Definition at line 49 of file R3BParView.h.

operator->()

template<typename ParType>

auto R3B::ParView< ParType >::operator-> ( ) -> Type*

inline

Definition at line 47 of file R3BParView.h.

set()

template<typename ParType>

auto R3B::ParView< ParType >::set ( Type * par ) -> Type*

inline

Parameters

par	Parameter pointer

Definition at line 45 of file R3BParView.h.

Member Data Documentation

name_

template<typename ParType>

std::string R3B::ParView< ParType >::name_

private

Definition at line 52 of file R3BParView.h.

parameter_

template<typename ParType>

ParType* R3B::ParView< ParType >::parameter_ = nullptr

private

Definition at line 53 of file R3BParView.h.

---

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

• r3bbase/R3BParView.h