buffer node More...

#include <qx.h>

Inheritance diagram for qx::buffer< value_t >:

Collaboration diagram for qx::buffer< value_t >:

Public Types
typedef std::deque< std::shared_ptr< node > >	container

typedef promoted< std::string >	promoted

Public Member Functions
	buffer (const buffer &buffer, node *parent)

	buffer (const std::string &key, value_t value)

	buffer (const std::string &key, value_t value, const char *init)

void	clear () noexcept

virtual std::shared_ptr< node >	clone (node *parent) const =0

virtual const char *	id () const noexcept

void	ignore (promoted *value) noexcept

virtual bool	inherits (const char *type) const noexcept

void	obey (const std::initializer_list< promoted * > &values, bool initial_update=true) noexcept

void	obey (promoted *value, bool initial_update=true) noexcept

template<typename node_t , typename petty_t = node_t, typename = enable_if_base_of <node, node_t>>
	operator const node_t & () const

template<typename value_t , typename = enable_if_value<value_t>>
	operator const value_t & () const

	operator const value_t & () const noexcept

template<typename node_t , typename petty_t = node_t, typename = enable_if_base_of <node, node_t>>
	operator node_t & ()
	node derivate linkage explicit assignment (i.e. node= &out) More...

template<typename value_t , typename = enable_if_value<value_t>>
	operator value_t & ()

	operator value_t & () noexcept

template<typename value_t , typename = enable_if_value<value_t>>
std::decay_t< value_t > &	operator* ()

template<typename value_t , typename = enable_if_value<value_t>>
const std::decay_t< value_t > &	operator* () const

const value_t &	operator* () const noexcept

value_t &	operator* () noexcept

void	operator+= (const value_t &value) noexcept

const value_t &	operator-> () const noexcept

value_t &	operator-> () noexcept

template<typename petty_t = value_t, typename = typename std::enable_if_t<std::is_same_v <container, petty_t>>>
node &	operator<< (const node &node)

template<typename value_t , typename = enable_if_value<value_t>>
bool	operator== (const std::decay_t< value_t > &value) const

bool	operator== (const value_t &value) const noexcept

node &	operator[] (const std::string &path) const override

node &	operator[] (size_t pos) const override

	qx_factory (quarx< value_t >) quarx(const quarx &copy

void	remove ()

virtual void	remove (const promoted &) noexcept
	indicate promoted end-of-lifetime More...

void	remove_all_listener () noexcept

virtual node &	resize (size_t)

void	trigger () noexcept

template<typename petty_t = value_t, typename = typename std::enable_if_t<std::is_same_v <container, petty_t>>>
std::string	unique (const std::string &key) const noexcept

else	value::operator= (copy)

	~buffer ()

Static Public Member Functions
static bool	static_inherits (const char *type) noexcept

Public Attributes
node copy	attributes

promoted	key
	name of node More...

std::set< listen< value_t > * >	listeners

qx_factory(buffer< value_t >) class init promoted< size_t >	offset

node *	parent: super (*copy.key

node	parent

promoted	path
	entire path of node in process network More...

std::set< promoted * >	values

Static Public Attributes
static const char *	type
	quarx node type ID More...

Protected Types
template<typename base_t , typename derrived_t >
using	enable_if_base_of = std::enable_if_t< std::is_base_of_v< std::decay_t< base_t >, std::decay_t< derrived_t > >>

template<typename value_t >
using	enable_if_value = std::enable_if_t< std::is_same_v< std::decay_t< value_t >, int32_t >\|\|std::is_same_v< std::decay_t< value_t >, double >\|\|std::is_same_v< std::decay_t< value_t >, node * > >

typedef qx::promoted< value_t >	value
	value of this node More...

Detailed Description

template<typename value_t>
class qx::buffer< value_t >

buffer node

A buffer holds a block of processing data. This can be static (i.e. a sine wave for a generator), or process buffer memory (i.e. a delay line).

A buffer node can be local to its parant, so only the parent can access it. This is used i.e. for delay line buffers inside a delay module. Or it could be global, so all modules can access it. I.e. the global routing table is a global buffer.

Member Typedef Documentation

◆ container

typedef std::deque<std::shared_ptr<node> > qx::node::container

inherited

◆ enable_if_base_of

template<typename base_t , typename derrived_t >

using qx::node::enable_if_base_of = std::enable_if_t<std::is_base_of_v <std::decay_t<base_t>, std::decay_t<derrived_t> >>

protectedinherited

◆ enable_if_value

template<typename value_t >

using qx::node::enable_if_value = std::enable_if_t< std::is_same_v<std::decay_t<value_t>, int32_t> || std::is_same_v<std::decay_t<value_t>, double> || std::is_same_v<std::decay_t<value_t>, node*> >

protectedinherited

◆ promoted

typedef promoted<std::string > qx::listen< std::string >::promoted

inherited

◆ value

template<typename value_t >

typedef qx::promoted<value_t> qx::quarx< value_t >::value

protectedinherited

value of this node

Constructor & Destructor Documentation

◆ buffer() [1/3]

template<typename value_t >

qx::buffer< value_t >::buffer	(	const std::string &	key,
		value_t	value
	)

inline

◆ buffer() [2/3]

template<typename value_t >

qx::buffer< value_t >::buffer	(	const std::string &	key,
		value_t	value,
		const char *	init
	)

inline

Here is the call graph for this function:

◆ buffer() [3/3]

template<typename value_t >

qx::buffer< value_t >::buffer	(	const buffer< value_t > &	buffer,
		node *	parent
	)

inline

◆ ~buffer()

template<typename value_t >

qx::buffer< value_t >::~buffer ( )

inline

Member Function Documentation

◆ clear()

void qx::listen< std::string >::clear ( )

inlinenoexceptinherited

◆ clone()

virtual std::shared_ptr<node> qx::node::clone ( node * parent ) const

pure virtualinherited

◆ id()

virtual const char* qx::node::id ( ) const

inlinevirtualnoexceptinherited

◆ ignore()

void qx::listen< std::string >::ignore ( promoted * value )

inlinenoexceptinherited

◆ inherits()

virtual bool qx::node::inherits ( const char * type ) const

inlinevirtualnoexceptinherited

◆ obey() [1/2]

void qx::listen< std::string >::obey	(	const std::initializer_list< promoted * > &	values,
		bool	initial_update = `true`
	)

inlinenoexceptinherited

◆ obey() [2/2]

void qx::listen< std::string >::obey	(	promoted *	value,
		bool	initial_update = `true`
	)

inlinenoexceptinherited

◆ operator const node_t &()

template<typename node_t , typename petty_t = node_t, typename = enable_if_base_of <node, node_t>>

qx::node::operator const node_t & ( ) const

inlineinherited

◆ operator const value_t &() [1/2]

template<typename value_t , typename = enable_if_value<value_t>>

qx::node::operator const value_t & ( ) const

inlineinherited

◆ operator const value_t &() [2/2]

template<class value_t >

qx::promoted< value_t >::operator const value_t & ( ) const

inlinenoexceptinherited

◆ operator node_t &()

template<typename node_t , typename petty_t = node_t, typename = enable_if_base_of <node, node_t>>

template<typename value_t >

template<typename petty_t = value_t, typename = typename std::enable_if_t<std::is_same_v <container, petty_t>>>

node& qx::quarx< value_t >::operator<< ( const node & node )

inlineinherited

◆ operator==() [1/2]

template<typename value_t , typename = enable_if_value<value_t>>

bool qx::node::operator== ( const std::decay_t< value_t > & value ) const

inlineinherited

◆ operator==() [2/2]

template<class value_t >

bool qx::promoted< value_t >::operator== ( const value_t & value ) const

inlinenoexceptinherited

◆ operator[]() [1/2]

template<typename value_t >

node& qx::quarx< value_t >::operator[] ( const std::string & path ) const

inlineoverridevirtualinherited

Implements qx::node.

◆ operator[]() [2/2]

template<typename value_t >

node& qx::quarx< value_t >::operator[] ( size_t pos ) const

inlineoverridevirtualinherited

Implements qx::node.

◆ qx_factory()

template<typename value_t >

qx::quarx< value_t >::qx_factory ( quarx< value_t > ) const &

inherited

◆ remove() [1/2]

void qx::node::remove ( )

inherited

◆ remove() [2/2]

virtual void qx::listen< std::string >::remove ( const promoted & )

inlinevirtualnoexceptinherited

indicate promoted end-of-lifetime

◆ remove_all_listener()

template<class value_t >

void qx::promoted< value_t >::remove_all_listener ( )

inlinenoexceptinherited

Here is the caller graph for this function:

◆ resize()

virtual node& qx::node::resize ( size_t )

inlinevirtualinherited

Reimplemented in qx::monitor, qx::mix, qx::mix::bus, qx::generator, qx::generator::voice, qx::delay, qx::delay::in, qx::container, and qx::container.

◆ static_inherits()

static bool qx::node::static_inherits ( const char * type )

inlinestaticnoexceptinherited

◆ trigger()

void qx::listen< std::string >::trigger ( )

inlinenoexceptinherited

◆ unique()

template<typename value_t >

template<typename petty_t = value_t, typename = typename std::enable_if_t<std::is_same_v <container, petty_t>>>

std::string qx::quarx< value_t >::unique ( const std::string & key ) const

inlinenoexceptinherited

◆ value::operator=()

template<typename value_t >

else qx::quarx< value_t >::value::operator= ( copy )

inherited

Member Data Documentation

◆ attributes

template<typename value_t >

node copy qx::quarx< value_t >::attributes

inherited

Initial value:

{
        if constexpr (std::is_same_v<container, value_t>)
            for(auto& child: static_cast<const container&>(copy))
                emplace_back(static_cast<const node&>(*child).clone(this))

◆ key

promoted qx::node::key

inherited

name of node

◆ listeners

template<class value_t >

std::set<listen <value_t>*> qx::promoted< value_t >::listeners

inherited

◆ offset

template<typename value_t >

qx_factory (buffer<value_t>) class init promoted<size_t> qx::buffer< value_t >::offset

◆ parent [1/2]

template<typename value_t >

node* qx::quarx< value_t >::parent

inherited

◆ parent [2/2]

template<typename value_t >

node qx::quarx< value_t >::parent

inherited

◆ path

promoted qx::node::path

inherited

entire path of node in process network

◆ type

template<typename value_t >

const char* qx::buffer< value_t >::type

static

quarx node type ID

◆ values

std::set<promoted*> qx::listen< std::string >::values

inherited

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

qx.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Detailed Description

template<typename value_t> class qx::buffer< value_t >

Member Typedef Documentation

◆ container

◆ enable_if_base_of

◆ enable_if_value

◆ promoted

◆ value

Constructor & Destructor Documentation

◆ buffer() [1/3]

◆ buffer() [2/3]

◆ buffer() [3/3]

◆ ~buffer()

Member Function Documentation

◆ clear()

◆ clone()

◆ id()

◆ ignore()

◆ inherits()

◆ obey() [1/2]

◆ obey() [2/2]

◆ operator const node_t &()

◆ operator const value_t &() [1/2]

◆ operator const value_t &() [2/2]

◆ operator node_t &()

◆ operator value_t &() [1/2]

◆ operator value_t &() [2/2]

◆ operator*() [1/4]

◆ operator*() [2/4]

◆ operator*() [3/4]

◆ operator*() [4/4]

◆ operator+=()

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator<<()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ qx_factory()

◆ remove() [1/2]

◆ remove() [2/2]

◆ remove_all_listener()

◆ resize()

◆ static_inherits()

◆ trigger()

◆ unique()

◆ value::operator=()

Member Data Documentation

◆ attributes

◆ key

◆ listeners

◆ offset

◆ parent [1/2]

◆ parent [2/2]

◆ path

◆ type

◆ values

template<typename value_t>
class qx::buffer< value_t >