cosmos::FormattedNumber< NUM > Struct Template Reference

Base class for HexNum and OctNum format output helpers. More...

#include <formatting.hxx>

Inheritance diagram for cosmos::FormattedNumber< NUM >:

Public Member Functions
const FormattedNumber &	showBase (bool yes_no)
	If a prefix identifier for the number's base should be shown (e.g. 0x for hex, default: yes).
size_t	width () const
bool	showBase () const
auto	num () const
const std::string &	basePrefix () const
SetBaseFN	baseFN () const
	operator std::string () const

Protected Types
using	SetBaseFN = std::function<void(std::ostream&)>
	This function is supposed to apply the desired number base to the stream.

Protected Member Functions
	FormattedNumber (const NUM num, size_t width, SetBaseFN fn, std::string base_prefix)

Protected Attributes
NUM	m_num
size_t	m_width = 0
SetBaseFN	m_setbase_fn
std::string	m_base_prefix
bool	m_show_base = true

Detailed Description

template<typename NUM>
struct cosmos::FormattedNumber< NUM >

Base class for HexNum and OctNum format output helpers.

Definition at line 80 of file formatting.hxx.

Member Typedef Documentation

SetBaseFN

template<typename NUM >

using cosmos::FormattedNumber< NUM >::SetBaseFN = std::function<void(std::ostream&)>

protected

This function is supposed to apply the desired number base to the stream.

Definition at line 84 of file formatting.hxx.

Constructor & Destructor Documentation

FormattedNumber()

template<typename NUM >

cosmos::FormattedNumber< NUM >::FormattedNumber ( const NUM num, size_t width, SetBaseFN fn, std::string base_prefix )

inlineprotected

Definition at line 88 of file formatting.hxx.

                                                                                          :
                m_num{num}, m_width{width}, m_setbase_fn{fn}, m_base_prefix{base_prefix} {}

Member Function Documentation

baseFN()

template<typename NUM >

SetBaseFN cosmos::FormattedNumber< NUM >::baseFN ( ) const

inline

Definition at line 100 of file formatting.hxx.

{ return m_setbase_fn; }

basePrefix()

template<typename NUM >

const std::string & cosmos::FormattedNumber< NUM >::basePrefix ( ) const

inline

Definition at line 99 of file formatting.hxx.

{ return m_base_prefix; }

num()

template<typename NUM >

auto cosmos::FormattedNumber< NUM >::num ( ) const

inline

Definition at line 98 of file formatting.hxx.

{ return m_num; }

operator std::string()

template<typename NUM >

cosmos::FormattedNumber< NUM >::operator std::string ( ) const

inlineexplicit

Definition at line 102 of file formatting.hxx.

                                            {
                std::stringstream ss;
                ss << *this;
                return ss.str();
        }

showBase() [1/2]

template<typename NUM >

bool cosmos::FormattedNumber< NUM >::showBase ( ) const

inline

Definition at line 97 of file formatting.hxx.

{ return m_show_base; }

showBase() [2/2]

template<typename NUM >

const FormattedNumber & cosmos::FormattedNumber< NUM >::showBase ( bool yes_no )

inline

If a prefix identifier for the number's base should be shown (e.g. 0x for hex, default: yes).

Definition at line 94 of file formatting.hxx.

{ m_show_base = yes_no; return *this; }

width()

template<typename NUM >

size_t cosmos::FormattedNumber< NUM >::width ( ) const

inline

Definition at line 96 of file formatting.hxx.

{ return m_width; }

Member Data Documentation

m_base_prefix

template<typename NUM >

std::string cosmos::FormattedNumber< NUM >::m_base_prefix

protected

Definition at line 113 of file formatting.hxx.

m_num

template<typename NUM >

NUM cosmos::FormattedNumber< NUM >::m_num

protected

Definition at line 110 of file formatting.hxx.

m_setbase_fn

template<typename NUM >

SetBaseFN cosmos::FormattedNumber< NUM >::m_setbase_fn

protected

Definition at line 112 of file formatting.hxx.

m_show_base

template<typename NUM >

bool cosmos::FormattedNumber< NUM >::m_show_base = true

protected

Definition at line 114 of file formatting.hxx.

m_width

template<typename NUM >

size_t cosmos::FormattedNumber< NUM >::m_width = 0

protected

Definition at line 111 of file formatting.hxx.

---

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

• include/formatting.hxx