ParamLine Class Reference

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! More...

#include <ParamLine.h>

Public Member Functions
ParamLine &	firstSeparator (std::string iString)
ParamLine &	id (ParamID iParamID)
ParamLine &	ids (std::vector< ParamID > const &iParamIDs)
ParamLine &	key (ParamDisplay::Key iKey)
ParamLine &	keys (std::vector< ParamDisplay::Key > const &iKeys)
ParamLine &	nextSeparator (std::string iString)
	ParamLine (ParamDisplay iParamDisplay)
ParamLine &	paramSeparator (std::string iString)
ParamLine &	precision (int32 iPrecision)
ParamLine &	skipEmptyEntry (bool iFlag=true)
std::string	toString () const
std::string	toString (NormalizedState const &iNormalizedState) const

Static Public Member Functions
static ParamLine	from (GUI::GUIState const *iState, bool iSaveStateOnly=false)
	Shortcut to create a table for the GUIState (current values).
static ParamLine	from (Parameters const &iParams)
	Shortcut to create a table for all registered parameter (definition not current value).
static ParamLine	from (RT::RTState const *iState, bool iSaveStateOnly=false)
	Shortcut to create a table for the RTState (current values).

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()

ParamLine ( ParamDisplay iParamDisplay )

inlineexplicit

Member Function Documentation

firstSeparator()

ParamLine & firstSeparator ( std::string iString )

inline

from() [1/3]

ParamLine from ( GUI::GUIState const * iState, bool iSaveStateOnly = false )

static

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

from() [2/3]

ParamLine from ( Parameters const & iParams )

static

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

from() [3/3]

ParamLine from ( RT::RTState const * iState, bool iSaveStateOnly = false )

static

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

id()

ParamLine & id ( ParamID iParamID )

inline

ids()

ParamLine & ids ( std::vector< ParamID > const & iParamIDs )

inline

key()

ParamLine & key ( ParamDisplay::Key iKey )

inline

keys()

ParamLine & keys ( std::vector< ParamDisplay::Key > const & iKeys )

inline

nextSeparator()

ParamLine & nextSeparator ( std::string iString )

inline

paramSeparator()

ParamLine & paramSeparator ( std::string iString )

inline

precision()

ParamLine & precision ( int32 iPrecision )

inline

skipEmptyEntry()

ParamLine & skipEmptyEntry ( bool iFlag = true )

inline

toString() [1/3]

std::string toString

(

)

const

toString() [2/3]

std::string toString

(

NormalizedState const &

iNormalizedState

)

const

toString() [3/3]

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

protected

Member Data Documentation

fFirstSeparator

std::string fFirstSeparator {"="}

private

fNextSeparator

std::string fNextSeparator {"/"}

private

fParamDisplay

ParamDisplay fParamDisplay

private

fParamSeparator

std::string fParamSeparator {", "}

private

fSkipEmptyEntry

bool fSkipEmptyEntry {true}

private

---

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

• pongasoft/VST/Debug/ParamLine.h
• pongasoft/VST/Debug/ParamLine.cpp