Jamba  3.1.0
pongasoft::VST::Debug::ParamLine Class Reference

#include <ParamLine.h>

Public Member Functions

ParamLinefirstSeparator (std::string iString)
 
ParamLineid (ParamID iParamID)
 
ParamLineids (std::vector< ParamID > const &iParamIDs)
 
ParamLinekey (ParamDisplay::Key iKey)
 
ParamLinekeys (std::vector< ParamDisplay::Key > const &iKeys)
 
ParamLinenextSeparator (std::string iString)
 
 ParamLine (ParamDisplay iParamDisplay)
 
ParamLineparamSeparator (std::string iString)
 
ParamLineprecision (int32 iPrecision)
 
ParamLineskipEmptyEntry (bool iFlag=true)
 
std::string toString () const
 
std::string toString (NormalizedState const &iNormalizedState) const
 

Static Public Member Functions

static ParamLine from (Parameters const &iParams)
 
static ParamLine from (RT::RTState const *iState, bool iSaveStateOnly=false)
 
static ParamLine from (GUI::GUIState const *iState, bool iSaveStateOnly=false)
 

Protected Member Functions

std::string toString (ParamDisplay::ParamMap const &iParamMap) const
 

Private Attributes

std::string fFirstSeparator {"="}
 
std::string fNextSeparator {"/"}
 
ParamDisplay fParamDisplay
 
std::string fParamSeparator {", "}
 
bool fSkipEmptyEntry {true}
 

Detailed Description

This helper class is used to display the parameters (vst/jmb) in a line WARNING: this class is allocating memory and as a result should be used in RT only during development!

Constructor & Destructor Documentation

◆ ParamLine()

pongasoft::VST::Debug::ParamLine::ParamLine ( ParamDisplay  iParamDisplay)
inlineexplicit

Member Function Documentation

◆ firstSeparator()

ParamLine& pongasoft::VST::Debug::ParamLine::firstSeparator ( std::string  iString)
inline

◆ from() [1/3]

ParamLine pongasoft::VST::Debug::ParamLine::from ( Parameters const &  iParams)
static

Shortcut to create a table for all registered parameter (definition not current value)

◆ from() [2/3]

ParamLine pongasoft::VST::Debug::ParamLine::from ( RT::RTState const *  iState,
bool  iSaveStateOnly = false 
)
static

Shortcut to create a table for the RTState (current values)

◆ from() [3/3]

ParamLine pongasoft::VST::Debug::ParamLine::from ( GUI::GUIState const *  iState,
bool  iSaveStateOnly = false 
)
static

Shortcut to create a table for the GUIState (current values)

◆ id()

ParamLine& pongasoft::VST::Debug::ParamLine::id ( ParamID  iParamID)
inline

◆ ids()

ParamLine& pongasoft::VST::Debug::ParamLine::ids ( std::vector< ParamID > const &  iParamIDs)
inline

◆ key()

ParamLine& pongasoft::VST::Debug::ParamLine::key ( ParamDisplay::Key  iKey)
inline

◆ keys()

ParamLine& pongasoft::VST::Debug::ParamLine::keys ( std::vector< ParamDisplay::Key > const &  iKeys)
inline

◆ nextSeparator()

ParamLine& pongasoft::VST::Debug::ParamLine::nextSeparator ( std::string  iString)
inline

◆ paramSeparator()

ParamLine& pongasoft::VST::Debug::ParamLine::paramSeparator ( std::string  iString)
inline

◆ precision()

ParamLine& pongasoft::VST::Debug::ParamLine::precision ( int32  iPrecision)
inline

◆ skipEmptyEntry()

ParamLine& pongasoft::VST::Debug::ParamLine::skipEmptyEntry ( bool  iFlag = true)
inline

◆ toString() [1/3]

std::string pongasoft::VST::Debug::ParamLine::toString ( ) const

◆ toString() [2/3]

std::string pongasoft::VST::Debug::ParamLine::toString ( NormalizedState const &  iNormalizedState) const

◆ toString() [3/3]

std::string pongasoft::VST::Debug::ParamLine::toString ( ParamDisplay::ParamMap const &  iParamMap) const
protected

Member Data Documentation

◆ fFirstSeparator

std::string pongasoft::VST::Debug::ParamLine::fFirstSeparator {"="}
private

◆ fNextSeparator

std::string pongasoft::VST::Debug::ParamLine::fNextSeparator {"/"}
private

◆ fParamDisplay

ParamDisplay pongasoft::VST::Debug::ParamLine::fParamDisplay
private

◆ fParamSeparator

std::string pongasoft::VST::Debug::ParamLine::fParamSeparator {", "}
private

◆ fSkipEmptyEntry

bool pongasoft::VST::Debug::ParamLine::fSkipEmptyEntry {true}
private

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