ParamValue

class pyopenms.ParamValue

Bases: object

Cython implementation of _ParamValue

Original C++ documentation is available here

Class to hold strings, numeric values, vectors of strings and vectors of numeric values using the stl types

• To choose one of these types, just use the appropriate constructor

• Automatic conversion is supported and throws Exceptions in case of invalid conversions

• An empty object is created with the default constructor

__init__()

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: ParamValue) → None

Overload:

__init__(self, in_0: bytes) → None

Overload:

__init__(self, in_0: bytes | str) → None

Overload:

__init__(self, in_0: int) → None

Overload:

__init__(self, in_0: float) → None

Overload:

__init__(self, in_0: List[bytes | str]) → None

Overload:

__init__(self, in_0: List[int]) → None

Overload:

__init__(self, in_0: List[float]) → None

Methods

__init__
isEmpty(self)	Test if the value is empty
toBool(self)	Converts the strings 'true' and 'false' to a bool
toDouble
toDoubleVector(self)	Explicitly convert ParamValue to DoubleList
toInt
toIntVector(self)	Explicitly convert ParamValue to IntList
toString
toStringVector(self)	Explicitly convert ParamValue to string vector
valueType(self)

isEmpty(self) → int

Test if the value is empty

toBool(self) → bool

Converts the strings ‘true’ and ‘false’ to a bool

toDouble()

toDoubleVector(self) → List[float]

Explicitly convert ParamValue to DoubleList

toInt()

toIntVector(self) → List[int]

Explicitly convert ParamValue to IntList

toString()

toStringVector(self) → List[bytes]

Explicitly convert ParamValue to string vector

valueType(self) → int