MetaInfoInterface#

class pyopenms.MetaInfoInterface#

Bases: object

Cython implementation of _MetaInfoInterface

Original C++ documentation is available here

Interface for classes that can store arbitrary meta information (Type-Name-Value tuples).

MetaInfoInterface is a base class for all classes that use one MetaInfo object as member. If you want to add meta information to a class, let it publicly inherit the MetaInfoInterface. Meta information is an array of Type-Name-Value tuples.

Usage:

__init__()#

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: MetaInfoInterface) → None

Methods

`__init__`	Overload:
`clearMetaInfo`(self)	Removes all meta values
`getKeys`(self, keys)	Fills the given vector with a list of all keys for which a value is set
`getMetaValue`(self, in_0)	Returns the value corresponding to a string, or
`getMetaValues`	Cython signature: dict getMetaValues()
`isMetaEmpty`(self)	Returns if the MetaInfo is empty
`metaRegistry`(self)	Returns a reference to the MetaInfoRegistry
`metaValueExists`(self, in_0)	Returns whether an entry with the given name exists
`removeMetaValue`(self, in_0)	Removes the DataValue corresponding to name if it exists
`setMetaValue`(self, in_0, in_1)	Sets the DataValue corresponding to a name
`setMetaValues`	Cython signature: setMetaValues(dict values)

clearMetaInfo(self) → None#: Removes all meta values

getKeys(self, keys: List[bytes]) → None#: Fills the given vector with a list of all keys for which a value is set

getMetaValue(self, in_0: bytes | str | String) → int | float | bytes | str | List[int] | List[float] | List[bytes]#: Returns the value corresponding to a string, or

getMetaValues()#

Cython signature: dict getMetaValues()

Returns all meta values in a Python dictionary.

isMetaEmpty(self) → bool#: Returns if the MetaInfo is empty

metaRegistry(self) → MetaInfoRegistry#: Returns a reference to the MetaInfoRegistry

metaValueExists(self, in_0: bytes | str | String) → bool#: Returns whether an entry with the given name exists

removeMetaValue(self, in_0: bytes | str | String) → None#: Removes the DataValue corresponding to name if it exists

setMetaValue(self, in_0: bytes | str | String, in_1: int | float | bytes | str | List[int] | List[float] | List[bytes]) → None#: Sets the DataValue corresponding to a name

setMetaValues()#

Cython signature: setMetaValues(dict values)

Sets the meta values given in the Python dictionary.