Param

class pyopenms.Param

Bases: object

Cython implementation of _Param

Documentation is available at http://www.openms.de/current_doxygen/html/classOpenMS_1_1Param.html

__init__()

  • Cython signature: void Param()

  • Cython signature: void Param(Param &)

Methods

__init__

  • Cython signature: void Param()

addSection

Cython signature: void addSection(libcpp_utf8_string key, libcpp_utf8_string desc)

addTag

Cython signature: void addTag(libcpp_utf8_string key, libcpp_utf8_string tag)

addTags

Cython signature: void addTags(libcpp_utf8_string key, libcpp_vector[libcpp_utf8_string] tags)

asDict

checkDefaults

  • Cython signature: void checkDefaults(libcpp_utf8_string name, Param defaults, libcpp_utf8_string prefix)

clear

Cython signature: void clear()

clearTags

Cython signature: void clearTags(libcpp_utf8_string key)

copy

  • Cython signature: Param copy(libcpp_utf8_string prefix, bool)

descriptions

empty

Cython signature: bool empty()

exists

Cython signature: bool exists(libcpp_utf8_string key)

get

getDescription

Cython signature: libcpp_utf8_output_string getDescription(libcpp_utf8_string key)

getEntry

Cython signature: ParamEntry getEntry(libcpp_utf8_string)

getSectionDescription

Cython signature: libcpp_utf8_output_string getSectionDescription(libcpp_utf8_string key)

getTags

Cython signature: libcpp_vector[libcpp_utf8_string] getTags(libcpp_utf8_string key)

getValue

Cython signature: ParamValue getValue(libcpp_utf8_string key)

getValueType

Cython signature: ValueType getValueType(libcpp_utf8_string key)

hasTag

Cython signature: int hasTag(libcpp_utf8_string key, libcpp_utf8_string tag)

initPluginParam

insert

Cython signature: void insert(libcpp_utf8_string prefix, Param param)

items

keys

merge

Cython signature: void merge(Param toMerge)

remove

Cython signature: void remove(libcpp_utf8_string key)

removeAll

Cython signature: void removeAll(libcpp_utf8_string prefix)

setDefaults

  • Cython signature: void setDefaults(Param defaults, libcpp_utf8_string prefix, bool showMessage)

setMaxFloat

Cython signature: void setMaxFloat(libcpp_utf8_string key, double max)

setMaxInt

Cython signature: void setMaxInt(libcpp_utf8_string key, int max)

setMinFloat

Cython signature: void setMinFloat(libcpp_utf8_string key, double min)

setMinInt

Cython signature: void setMinInt(libcpp_utf8_string key, int min)

setSectionDescription

Cython signature: void setSectionDescription(libcpp_utf8_string key, libcpp_utf8_string desc)

setValidStrings

Cython signature: void setValidStrings(libcpp_utf8_string key, libcpp_vector[libcpp_utf8_string] strings)

setValue

  • Cython signature: void setValue(libcpp_utf8_string key, ParamValue val, libcpp_utf8_string desc, libcpp_vector[libcpp_utf8_string] tags)

size

Cython signature: size_t size()

update

use cases:

values

addSection()

Cython signature: void addSection(libcpp_utf8_string key, libcpp_utf8_string desc)

addTag()

Cython signature: void addTag(libcpp_utf8_string key, libcpp_utf8_string tag)

addTags()

Cython signature: void addTags(libcpp_utf8_string key, libcpp_vector[libcpp_utf8_string] tags)

asDict()
checkDefaults()

  • Cython signature: void checkDefaults(libcpp_utf8_string name, Param defaults, libcpp_utf8_string prefix)

  • Cython signature: void checkDefaults(libcpp_utf8_string name, Param defaults)

clear()

Cython signature: void clear()

clearTags()

Cython signature: void clearTags(libcpp_utf8_string key)

copy()

  • Cython signature: Param copy(libcpp_utf8_string prefix, bool)

  • Cython signature: Param copy(libcpp_utf8_string prefix)

descriptions()
empty()

Cython signature: bool empty()

exists()

Cython signature: bool exists(libcpp_utf8_string key)

get()
getDescription()

Cython signature: libcpp_utf8_output_string getDescription(libcpp_utf8_string key)

getEntry()

Cython signature: ParamEntry getEntry(libcpp_utf8_string)

getSectionDescription()

Cython signature: libcpp_utf8_output_string getSectionDescription(libcpp_utf8_string key)

getTags()

Cython signature: libcpp_vector[libcpp_utf8_string] getTags(libcpp_utf8_string key)

getValue()

Cython signature: ParamValue getValue(libcpp_utf8_string key)

getValueType()

Cython signature: ValueType getValueType(libcpp_utf8_string key)

hasTag()

Cython signature: int hasTag(libcpp_utf8_string key, libcpp_utf8_string tag)

initPluginParam()
insert()

Cython signature: void insert(libcpp_utf8_string prefix, Param param)

items()
keys()
merge()

Cython signature: void merge(Param toMerge)

remove()

Cython signature: void remove(libcpp_utf8_string key)

removeAll()

Cython signature: void removeAll(libcpp_utf8_string prefix)

setDefaults()

  • Cython signature: void setDefaults(Param defaults, libcpp_utf8_string prefix, bool showMessage)

  • Cython signature: void setDefaults(Param defaults, libcpp_utf8_string prefix)

  • Cython signature: void setDefaults(Param defaults)

setMaxFloat()

Cython signature: void setMaxFloat(libcpp_utf8_string key, double max)

setMaxInt()

Cython signature: void setMaxInt(libcpp_utf8_string key, int max)

setMinFloat()

Cython signature: void setMinFloat(libcpp_utf8_string key, double min)

setMinInt()

Cython signature: void setMinInt(libcpp_utf8_string key, int min)

setSectionDescription()

Cython signature: void setSectionDescription(libcpp_utf8_string key, libcpp_utf8_string desc)

setValidStrings()

Cython signature: void setValidStrings(libcpp_utf8_string key, libcpp_vector[libcpp_utf8_string] strings)

setValue()

  • Cython signature: void setValue(libcpp_utf8_string key, ParamValue val, libcpp_utf8_string desc, libcpp_vector[libcpp_utf8_string] tags)

  • Cython signature: void setValue(libcpp_utf8_string key, ParamValue val, libcpp_utf8_string desc)

  • Cython signature: void setValue(libcpp_utf8_string key, ParamValue val)

size()

Cython signature: size_t size()

update()

use cases:

p.update(dict d) p.update(Param p) p.update(Param p, int flag)

values()