PlotBase< TPlot, TCoord > Class Template Reference

#include <Plot.hh>

Inheritance diagram for PlotBase< TPlot, TCoord >:

Collaboration diagram for PlotBase< TPlot, TCoord >:

Public Member Functions
bool	add_sample (uint64_t x, TCoord y) const NOEXCEPT_MAYBE
bool	set_sample (uint64_t x, TCoord y) const NOEXCEPT_MAYBE
bool	sample (uint64_t x, TCoord *y) const NOEXCEPT_MAYBE
Public Member Functions inherited from Root
notcurses *	get_notcurses () const
NotCurses *	get_notcurses_cpp () const

Protected Member Functions
	PlotBase (Plane *plane, const ncplot_options *opts, TCoord miny=0, TCoord maxy=0)
	~PlotBase ()
TPlot *	get_plot () const noexcept
Protected Member Functions inherited from Widget
	Widget (NotCurses *ncinst)
void	ensure_valid_plane (Plane *plane) const
void	ensure_valid_plane (Plane &plane) const
void	take_plane_ownership (Plane *plane) const
void	take_plane_ownership (Plane &plane) const
Protected Member Functions inherited from Root
	Root (NotCurses *ncinst)
bool	is_notcurses_stopped () const noexcept

Additional Inherited Members
Static Protected Member Functions inherited from Root
template<typename TRet = bool, typename TValue = int>
static TRet	error_guard (TValue ret, TValue error_value)
template<typename TRet = bool, typename TValue = int>
static TRet	error_guard_cond (TValue ret, bool error_value)
Static Protected Attributes inherited from Root
static constexpr char	ncpp_invalid_state_message [] = "notcurses++ is in an invalid state (already stopped?)"

Detailed Description

template<typename TPlot, typename TCoord>
class ncpp::PlotBase< TPlot, TCoord >

Definition at line 16 of file Plot.hh.

Constructor & Destructor Documentation

PlotBase()

template<typename TPlot , typename TCoord >

PlotBase ( Plane *  plane, const ncplot_options *  opts, TCoord  miny = 0, TCoord  maxy = 0  )

inlineexplicitprotected

Definition at line 61 of file Plot.hh.

            : Widget (Utilities::get_notcurses_cpp (plane))
        {
            static_assert (is_double || is_uint64, "PlotBase must be parameterized with either 'double' or 'uint64_t' types");
            if constexpr (is_double) {
                static_assert (std::is_same_v<TPlot, ncdplot>, "ncdplot must be used for a plot using double coordinates");
            } else {
                static_assert (std::is_same_v<TPlot, ncuplot>, "ncuplot must be used for a plot using uint64_t coordinates");
            }
 
            ensure_valid_plane (plane);
 
            if (!plane->is_valid ())
                throw invalid_argument ("Invalid Plane object passed in 'plane'. Widgets must not reuse the same plane.");
 
            if (opts == nullptr)
                throw invalid_argument ("'opts' must be a valid pointer");
 
            if constexpr (is_uint64) {
                plot = ncuplot_create (Utilities::to_ncplane (plane), opts, miny, maxy);
            } else {
                plot = ncdplot_create (Utilities::to_ncplane (plane), opts, miny, maxy);
            }
 
            if (plot == nullptr)
                throw init_error ("Notcurses failed to create a new plot");
 
            take_plane_ownership (plane);
        }

Here is the call graph for this function:

~PlotBase()

template<typename TPlot , typename TCoord >

~PlotBase ( )

inlineprotected

Definition at line 91 of file Plot.hh.

        {
            if (!is_notcurses_stopped ()) {
                if constexpr (is_double) {
                    ncdplot_destroy (plot);
                } else {
                    ncuplot_destroy (plot);
                }
            }
        }

Here is the call graph for this function:

Member Function Documentation

add_sample()

template<typename TPlot , typename TCoord >

bool add_sample ( uint64_t  x, TCoord  y  ) const

inline

Definition at line 22 of file Plot.hh.

        {
            int ret;
 
            if constexpr (is_double) {
                ret = ncdplot_add_sample (plot, x, y);
            } else {
                ret = nduplot_add_sample (plot, x, y);
            }
 
            return error_guard (ret, -1);
        }

Here is the call graph for this function:

get_plot()

template<typename TPlot , typename TCoord >

TPlot * get_plot ( ) const

inlineprotectednoexcept

Definition at line 102 of file Plot.hh.

        {
            return plot;
        }

sample()

template<typename TPlot , typename TCoord >

bool sample ( uint64_t  x, TCoord *  y  ) const

inline

Definition at line 47 of file Plot.hh.

        {
            int ret;
 
            if constexpr (is_double) {
                ret = ncdplot_sample (plot, x, y);
            } else {
                ret = ncuplot_sample (plot, x, y);
            }
 
            return error_guard (ret, -1);
        }

Here is the call graph for this function:

set_sample()

template<typename TPlot , typename TCoord >

bool set_sample ( uint64_t  x, TCoord  y  ) const

inline

Definition at line 35 of file Plot.hh.

        {
            int ret;
 
            if constexpr (is_double) {
                ret = ncdplot_set_sample (plot, x, y);
            } else {
                ret = nduplot_set_sample (plot, x, y);
            }
            return error_guard (ret, -1);
        }

Here is the call graph for this function:

---

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

• /home/dank/src/dankamongmen/notcurses/include/ncpp/Plot.hh