ape  0.5.0
Audio Programming Environment
Public Types | Public Member Functions | List of all members
ape::Plot< Size > Class Template Reference

Fixed buffer of Plot::value_type elements that is plotted in the UI. More...

#include <plot.h>

Inheritance diagram for ape::Plot< Size >:
ape::UIObject

Public Types

typedef double value_type
 The type of value being plotted More...
 
typedef value_type Proxy
 Assignable value to update the plot More...
 

Public Member Functions

 Plot (std::string name)
 Create a plot with a name . More...
 
 ~Plot ()
 Destroys a plot. More...
 
Proxyoperator[] (std::size_t index)
 Writable access to an element in the plot. More...
 
const value_typeoperator[] (std::size_t index) const
 Read-only access to an element More...
 
const value_typedata () const noexcept
 Read-only access to the underlying buffer More...
 
constexpr std::size_t size () const noexcept
 Returns the Size More...
 

Detailed Description

template<std::size_t Size>
class ape::Plot< Size >

Fixed buffer of Plot::value_type elements that is plotted in the UI.

Member Typedef Documentation

◆ Proxy

template<std::size_t Size>
typedef value_type ape::Plot< Size >::Proxy

Assignable value to update the plot

◆ value_type

template<std::size_t Size>
typedef double ape::Plot< Size >::value_type

The type of value being plotted

Constructor & Destructor Documentation

◆ Plot()

template<std::size_t Size>
ape::Plot< Size >::Plot ( std::string  name)
inline

Create a plot with a name .

Parameters
name

◆ ~Plot()

template<std::size_t Size>
ape::Plot< Size >::~Plot ( )
inline

Destroys a plot.

Member Function Documentation

◆ data()

template<std::size_t Size>
const value_type* ape::Plot< Size >::data ( ) const
inlinenoexcept

Read-only access to the underlying buffer

◆ operator[]() [1/2]

template<std::size_t Size>
Proxy& ape::Plot< Size >::operator[] ( std::size_t  index)
inline

Writable access to an element in the plot.

◆ operator[]() [2/2]

template<std::size_t Size>
const value_type& ape::Plot< Size >::operator[] ( std::size_t  index) const
inline

Read-only access to an element

◆ size()

template<std::size_t Size>
constexpr std::size_t ape::Plot< Size >::size ( ) const
inlineconstexprnoexcept

Returns the Size


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