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: Union[bytes, str], desc: Union[bytes, str]) → None

addTag(self, key: Union[bytes, str], tag: Union[bytes, str]) → None

addTags(self, key: Union[bytes, str], tags: List[Union[bytes, str]]) → None

asDict()

checkDefaults()

Overload:

checkDefaults(self, name: Union[bytes, str], defaults: Param, prefix: Union[bytes, str]) → None

Overload:

checkDefaults(self, name: Union[bytes, str], defaults: Param) → None

clear(self) → None

clearTags(self, key: Union[bytes, str]) → None

copy()

Overload:

copy(self, prefix: Union[bytes, str], in_1: bool) → Param

Overload:

copy(self, prefix: Union[bytes, str]) → Param

descriptions()

empty(self) → bool

exists(self, key: Union[bytes, str]) → bool

get()

getDescription(self, key: Union[bytes, str]) → str

getEntry(self, in_0: Union[bytes, str]) → ParamEntry

getSectionDescription(self, key: Union[bytes, str]) → str

getTags(self, key: Union[bytes, str]) → List[bytes]

getValue(self, key: Union[bytes, str]) → Union[int, float, bytes, str, List[int], List[float], List[bytes]]

getValueType(self, key: Union[bytes, str]) → int

hasTag(self, key: Union[bytes, str], tag: Union[bytes, str]) → int

initPluginParam()

insert(self, prefix: Union[bytes, str], param: Param) → None

items()

keys()

merge(self, toMerge: Param) → None

remove(self, key: Union[bytes, str]) → None

removeAll(self, prefix: Union[bytes, str]) → None

setDefaults()

Overload:

setDefaults(self, defaults: Param, prefix: Union[bytes, str], showMessage: bool) → None

Overload:

setDefaults(self, defaults: Param, prefix: Union[bytes, str]) → None

Overload:

setDefaults(self, defaults: Param) → None

setMaxFloat(self, key: Union[bytes, str], max: float) → None

setMaxInt(self, key: Union[bytes, str], max: int) → None

setMinFloat(self, key: Union[bytes, str], min: float) → None

setMinInt(self, key: Union[bytes, str], min: int) → None

setSectionDescription(self, key: Union[bytes, str], desc: Union[bytes, str]) → None

setValidStrings(self, key: Union[bytes, str], strings: List[Union[bytes, str]]) → None

setValue()

Overload:

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

Overload:

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

Overload:

setValue(self, key: Union[bytes, str], val: Union[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()