Jamba C++ API 7.5.0
Loading...
Searching...
No Matches
ParamTable Class Reference

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

#include <ParamTable.h>

Public Member Functions

ParamTable & cellSeparation (bool iDisplayCellSeparation=true)
ParamTable & compact ()
ParamTable & full ()
ParamTable & header (bool iDisplayHeader=true)
ParamTable & headerSeparation (bool iDisplayHeaderSeparation=true)
ParamTable & hideCellSeparation ()
ParamTable & hideHeader ()
ParamTable & hideHeaderSeparation ()
ParamTable & hideLineSeparation ()
ParamTable & id (ParamID iParamID)
ParamTable & ids (std::vector< ParamID > const &iParamIDs)
ParamTable & key (ParamDisplay::Key iKey)
ParamTable & keys (std::vector< ParamDisplay::Key > const &iKeys)
ParamTable & lineSeparation (bool iDisplayLineSeparation=true)
 ParamTable (ParamDisplay iParamDisplay)
ParamTable & precision (int32 iPrecision)
void print (NormalizedState const &iNormalizedState, std::string const &iFirstLine="") const
void print (std::string const &iFirstLine="") const
std::vector< std::string > rows () const
std::vector< std::string > rows (NormalizedState const &iNormalizedState) const
ParamTable & showCellSeparation ()
ParamTable & showHeader ()
ParamTable & showHeaderSeparation ()
ParamTable & showLineSeparation ()
std::string toString () const
std::string toString (NormalizedState const &iNormalizedState) const

Static Public Member Functions

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

Protected Member Functions

ParamDisplay::ValueMap computeHeader () const
std::string::size_type computeSizes (ParamDisplay::ValueMap const &iHeader, ParamDisplay::ParamMap const &iParams, std::map< ParamDisplay::Key, std::string::size_type > &oSizes) const
std::vector< std::string > rows (ParamDisplay::ParamMap const &iParamMap) const

Private Attributes

bool fDisplayCellSeparation {false}
bool fDisplayHeader {true}
bool fDisplayHeaderSeparation {false}
bool fDisplayLineSeparation {false}
ParamDisplay fParamDisplay

Detailed Description

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

Constructor & Destructor Documentation

◆ ParamTable()

ParamTable ( ParamDisplay iParamDisplay)
inlineexplicit

Member Function Documentation

◆ cellSeparation()

ParamTable & cellSeparation ( bool iDisplayCellSeparation = true)
inline

◆ compact()

ParamTable & compact ( )
inline

◆ computeHeader()

ParamDisplay::ValueMap computeHeader ( ) const
protected

◆ computeSizes()

std::string::size_type computeSizes ( ParamDisplay::ValueMap const & iHeader,
ParamDisplay::ParamMap const & iParams,
std::map< ParamDisplay::Key, std::string::size_type > & oSizes ) const
protected

◆ from() [1/3]

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

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

◆ from() [2/3]

ParamTable from ( Parameters const & iParams)
static

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

◆ from() [3/3]

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

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

◆ full()

ParamTable & full ( )
inline

◆ header()

ParamTable & header ( bool iDisplayHeader = true)
inline

◆ headerSeparation()

ParamTable & headerSeparation ( bool iDisplayHeaderSeparation = true)
inline

◆ hideCellSeparation()

ParamTable & hideCellSeparation ( )
inline

◆ hideHeader()

ParamTable & hideHeader ( )
inline

◆ hideHeaderSeparation()

ParamTable & hideHeaderSeparation ( )
inline

◆ hideLineSeparation()

ParamTable & hideLineSeparation ( )
inline

◆ id()

ParamTable & id ( ParamID iParamID)
inline

◆ ids()

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

◆ key()

ParamTable & key ( ParamDisplay::Key iKey)
inline

◆ keys()

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

◆ lineSeparation()

ParamTable & lineSeparation ( bool iDisplayLineSeparation = true)
inline

◆ precision()

ParamTable & precision ( int32 iPrecision)
inline

◆ print() [1/2]

void print ( NormalizedState const & iNormalizedState,
std::string const & iFirstLine = "" ) const

◆ print() [2/2]

void print ( std::string const & iFirstLine = "") const

◆ rows() [1/3]

std::vector< std::string > rows ( ) const

◆ rows() [2/3]

std::vector< std::string > rows ( NormalizedState const & iNormalizedState) const

◆ rows() [3/3]

std::vector< std::string > rows ( ParamDisplay::ParamMap const & iParamMap) const
protected

◆ showCellSeparation()

ParamTable & showCellSeparation ( )
inline

◆ showHeader()

ParamTable & showHeader ( )
inline

◆ showHeaderSeparation()

ParamTable & showHeaderSeparation ( )
inline

◆ showLineSeparation()

ParamTable & showLineSeparation ( )
inline

◆ toString() [1/2]

std::string toString ( ) const

◆ toString() [2/2]

std::string toString ( NormalizedState const & iNormalizedState) const

Member Data Documentation

◆ fDisplayCellSeparation

bool fDisplayCellSeparation {false}
private

◆ fDisplayHeader

bool fDisplayHeader {true}
private

◆ fDisplayHeaderSeparation

bool fDisplayHeaderSeparation {false}
private

◆ fDisplayLineSeparation

bool fDisplayLineSeparation {false}
private

◆ fParamDisplay

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