Skip to content

shapeworks::Parameters

Parameter settings. More...

#include <Parameters.h>

Public Functions

Name
Parameters()
default constructor
Parameters(StringMap map)
construct from map
Variant get(std::string key, Variant default_value)
get a parameter based on a key, return default if it doesn't exist
bool key_exists(std::string key)
return if a key exists or not
void set(std::string key, Variant value)
set a parameter based on a key
void remove_entry(std::string key)
remove an entry
void set_map(StringMap map)
set underlying map
StringMap get_map() const
get underlying map
void reset_parameters()
reset parameters to blank

Public Attributes

Name
constexpr const char * ANALYSIS_PARAMS
constexpr const char * GROOM_PARAMS
constexpr const char * OPTIMIZE_PARAMS
constexpr const char * STUDIO_PARAMS
constexpr const char * PROJECT_PARAMS
constexpr const char * DEEPSSM_PARAMS

Detailed Description

class shapeworks::Parameters;

Parameter settings.

Store key/variant combinations Used to store parameters for various tools

Public Functions Documentation

function Parameters

Parameters()

default constructor

function Parameters

explicit Parameters(
    StringMap map
)

construct from map

function get

Variant get(
    std::string key,
    Variant default_value
)

get a parameter based on a key, return default if it doesn't exist

function key_exists

bool key_exists(
    std::string key
)

return if a key exists or not

function set

void set(
    std::string key,
    Variant value
)

set a parameter based on a key

function remove_entry

void remove_entry(
    std::string key
)

remove an entry

function set_map

void set_map(
    StringMap map
)

set underlying map

function get_map

StringMap get_map() const

get underlying map

function reset_parameters

void reset_parameters()

reset parameters to blank

Public Attributes Documentation

variable ANALYSIS_PARAMS

static constexpr const char * ANALYSIS_PARAMS = "analysis";

variable GROOM_PARAMS

static constexpr const char * GROOM_PARAMS = "groom";

variable OPTIMIZE_PARAMS

static constexpr const char * OPTIMIZE_PARAMS = "optimize";

variable STUDIO_PARAMS

static constexpr const char * STUDIO_PARAMS = "studio";

variable PROJECT_PARAMS

static constexpr const char * PROJECT_PARAMS = "project";

variable DEEPSSM_PARAMS

static constexpr const char * DEEPSSM_PARAMS = "deepssm";

Updated on 2024-07-14 at 17:07:24 +0000