C++ API Reference RNBO: RNBO::ValueHolder Class Reference

RNBO: RNBO::ValueHolder Class Reference

A class to hold a RNBO value (e.g. number, list, etc.) More...

#include <RNBO_PatcherState.h>

Public Types

enum  Type {
  NONE, FLOAT, DOUBLE , SUBSTATE,
  SUBSTATEMAP , LIST , BUFFER
}
 A RNBO value type variant. More...
 

Public Member Functions

 ValueHolder (float val)
 Construct a ValueHolder from a float.
 
 ValueHolder (double val)
 Construct a ValueHolder from a float.
 
 ValueHolder (Int val)
 Construct a ValueHolder from an integer.
 
 ValueHolder (UInt32 val)
 Construct a ValueHolder from an Index.
 
 ValueHolder (UInt64 val)
 Construct a ValueHolder from an Index.
 
 ValueHolder (bool val)
 Construct a ValueHolder from a bool.
 
 ValueHolder (StateMapPtr substate)
 Construct a ValueHolder from a PatcherState. More...
 
 ValueHolder (const list &theList)
 Construct a ValueHolder from a list.
 
 ValueHolder ()
 Construct a value without a type.
 
 ValueHolder (const ValueHolder &)=delete
 
ValueHolderoperator= (ValueHolder &)=delete
 
 ValueHolder (ValueHolder &&)=default
 
ValueHolderoperator= (ValueHolder &&)=delete
 
 operator float () const
 
 operator double () const
 
 operator Int () const
 
 operator UInt32 () const
 
 operator UInt64 () const
 
 operator bool () const
 
 operator PatcherEventTarget * ()
 
 operator signal ()
 
 operator ExternalPtr ()
 
 operator const list & () const
 
 operator DataRef & ()
 
 operator MultiDataRef & ()
 
 operator const char * () const
 
 operator SerializedBuffer & ()
 
 operator PatcherState & ()
 
PatcherStateoperator[] (Index i)
 
 operator const PatcherState & () const
 
const PatcherStateoperator[] (Index i) const
 
Index getSubStateMapSize () const
 Get the number of substates in the map.
 
Type getType () const
 Get the type of the value variant.
 

Detailed Description

A class to hold a RNBO value (e.g. number, list, etc.)

Member Enumeration Documentation

◆ Type

A RNBO value type variant.

Enumerator
NONE 

no value

FLOAT 

floating point number

DOUBLE 

double precision floating point number

SUBSTATE 

subpatcher state

SUBSTATEMAP 

subpatcher state map

LIST 

list of numbers

BUFFER 

serialized content of a data buffer

Constructor & Destructor Documentation

◆ ValueHolder()

RNBO::ValueHolder::ValueHolder ( StateMapPtr  substate)

Construct a ValueHolder from a PatcherState.

Parameters
substatea std::shared_pointer<PatcherState>

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