DocumentIdentifier

class pyopenms.DocumentIdentifier

Bases: object

Cython implementation of _DocumentIdentifier

Original C++ documentation is available here

__init__()

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: DocumentIdentifier) → None

Methods

__init__	Overload:
getIdentifier(self)	Retrieve document identifier (e.g.
getLoadedFilePath(self)	Returns the file_name which is the absolute path to the file loaded
getLoadedFileType(self)	Returns the file_type (e.g.
setIdentifier(self, id)	Sets document identifier (e.g.
setLoadedFilePath(self, file_name)	Sets the file_name according to absolute path of the file loaded, preferably done whilst loading
setLoadedFileType(self, file_name)	Sets the file_type according to the type of the file loaded from, preferably done whilst loading

getIdentifier(self) → bytes | str | String

Retrieve document identifier (e.g. an LSID)

getLoadedFilePath(self) → bytes | str | String

Returns the file_name which is the absolute path to the file loaded

getLoadedFileType(self) → int

Returns the file_type (e.g. featureXML, consensusXML, mzData, mzXML, mzML, …) of the file loaded

setIdentifier(self, id: bytes | str | String) → None

Sets document identifier (e.g. an LSID)

setLoadedFilePath(self, file_name: bytes | str | String) → None

Sets the file_name according to absolute path of the file loaded, preferably done whilst loading

setLoadedFileType(self, file_name: bytes | str | String) → None

Sets the file_type according to the type of the file loaded from, preferably done whilst loading