UniqueIdInterface#

class pyopenms.UniqueIdInterface(*args, **kwargs)#

Bases: object

A base class defining a common interface for all classes having a unique id

__init__(self) → None#
__init__(self, arg: pyopenms._pyopenms_kernel.UniqueIdInterface, /) → None

Attributes

clearUniqueId

Clear the unique id.

ensureUniqueId

Assigns a valid unique id, but only if the present one is invalid.

getUniqueId

Returns the unique id

hasInvalidUniqueId

Returns whether the unique id is invalid.

hasValidUniqueId

Returns whether the unique id is valid.

isValid

setUniqueId

Assigns a new, valid unique id.

clearUniqueId#

Clear the unique id. The new unique id will be invalid. Returns 1 if the unique id was changed, 0 otherwise

ensureUniqueId#

Assigns a valid unique id, but only if the present one is invalid. Returns 1 if the unique id was changed, 0 otherwise

getUniqueId#

Returns the unique id

hasInvalidUniqueId#

Returns whether the unique id is invalid. Returns 1 if the unique id is invalid, 0 otherwise

hasValidUniqueId#

Returns whether the unique id is valid. Returns 1 if the unique id is valid, 0 otherwise

isValid = <nanobind.nb_func object>#
setUniqueId#

Assigns a new, valid unique id. Always returns 1