Param#

class pyopenms.Param#

Bases: object

Cython implementation of _Param

Original C++ documentation is available here

__init__()#

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: Param) → None

Methods

__init__

Overload:

addSection(self, key, desc)

addTag(self, key, tag)

addTags(self, key, tags)

asDict

checkDefaults

Overload:

clear(self)

clearTags(self, key)

copy

Overload:

descriptions

empty(self)

exists(self, key)

get

getDescription(self, key)

getEntry(self, in_0)

getSectionDescription(self, key)

getTags(self, key)

getValue(self, key)

getValueType(self, key)

hasTag(self, key, tag)

initPluginParam

insert(self, prefix, param)

items

keys

merge(self, toMerge)

remove(self, key)

removeAll(self, prefix)

setDefaults

Overload:

setMaxFloat(self, key, max)

setMaxInt(self, key, max)

setMinFloat(self, key, min)

setMinInt(self, key, min)

setSectionDescription(self, key, desc)

setValidStrings(self, key, strings)

setValue

Overload:

size(self)

update

use cases:

values

addSection(self, key: bytes | str, desc: bytes | str) → None#
addTag(self, key: bytes | str, tag: bytes | str) → None#
addTags(self, key: bytes | str, tags: List[bytes | str]) → None#
asDict()#
checkDefaults()#

Overload:

checkDefaults(self, name: bytes | str, defaults: Param, prefix: bytes | str) → None

Overload:

checkDefaults(self, name: bytes | str, defaults: Param) → None
clear(self) → None#
clearTags(self, key: bytes | str) → None#
copy()#

Overload:

copy(self, prefix: bytes | str, in_1: bool) → Param

Overload:

copy(self, prefix: bytes | str) → Param
descriptions()#
empty(self) → bool#
exists(self, key: bytes | str) → bool#
get()#
getDescription(self, key: bytes | str) → str#
getEntry(self, in_0: bytes | str) → ParamEntry#
getSectionDescription(self, key: bytes | str) → str#
getTags(self, key: bytes | str) → List[bytes]#
getValue(self, key: bytes | str) → int | float | bytes | str | List[int] | List[float] | List[bytes]#
getValueType(self, key: bytes | str) → int#
hasTag(self, key: bytes | str, tag: bytes | str) → int#
initPluginParam()#
insert(self, prefix: bytes | str, param: Param) → None#
items()#
keys()#
merge(self, toMerge: Param) → None#
remove(self, key: bytes | str) → None#
removeAll(self, prefix: bytes | str) → None#
setDefaults()#

Overload:

setDefaults(self, defaults: Param, prefix: bytes | str, showMessage: bool) → None

Overload:

setDefaults(self, defaults: Param, prefix: bytes | str) → None

Overload:

setDefaults(self, defaults: Param) → None
setMaxFloat(self, key: bytes | str, max: float) → None#
setMaxInt(self, key: bytes | str, max: int) → None#
setMinFloat(self, key: bytes | str, min: float) → None#
setMinInt(self, key: bytes | str, min: int) → None#
setSectionDescription(self, key: bytes | str, desc: bytes | str) → None#
setValidStrings(self, key: bytes | str, strings: List[bytes | str]) → None#
setValue()#

Overload:

setValue(self, key: bytes | str, val: int | float | bytes | str | List[int] | List[float] | List[bytes], desc: bytes | str, tags: List[bytes | str]) → None

Overload:

setValue(self, key: bytes | str, val: int | float | bytes | str | List[int] | List[float] | List[bytes], desc: bytes | str) → None

Overload:

setValue(self, key: bytes | str, val: int | float | bytes | str | List[int] | List[float] | List[bytes]) → None
size(self) → int#
update()#

use cases:

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

values()#