ContactPerson

class pyopenms.ContactPerson

Bases: object

Cython implementation of _ContactPerson

Original C++ documentation is available here

– Inherits from [‘MetaInfoInterface’]

__init__()

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: ContactPerson) → None

Methods

__init__	Overload:
clearMetaInfo(self)	Removes all meta values
getAddress(self)	Returns the address
getContactInfo(self)	Returns miscellaneous info about the contact person
getEmail(self)	Returns the email address
getFirstName(self)	Returns the first name of the person
getInstitution(self)	Returns the affiliation
getKeys(self, keys)	Fills the given vector with a list of all keys for which a value is set
getLastName(self)	Returns the last name of the person
getMetaValue(self, in_0)	Returns the value corresponding to a string, or
getURL(self)	Returns the URL associated with the contact person (e.g., the institute webpage
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
setAddress(self, email)	Sets the address
setContactInfo(self, contact_info)	Sets miscellaneous info about the contact person
setEmail(self, email)	Sets the email address
setFirstName(self, name)	Sets the first name of the person
setInstitution(self, institution)	Sets the affiliation
setLastName(self, name)	Sets the last name of the person
setMetaValue(self, in_0, in_1)	Sets the DataValue corresponding to a name
setName(self, name)	Sets the full name of the person (gets split into first and last name internally)
setURL(self, email)	Sets the URL associated with the contact person (e.g., the institute webpage

clearMetaInfo(self) → None

Removes all meta values

getAddress(self) → bytes | str | String

Returns the address

getContactInfo(self) → bytes | str | String

Returns miscellaneous info about the contact person

getEmail(self) → bytes | str | String

Returns the email address

getFirstName(self) → bytes | str | String

Returns the first name of the person

getInstitution(self) → bytes | str | String

Returns the affiliation

getKeys(self, keys: List[bytes]) → None

Fills the given vector with a list of all keys for which a value is set

getLastName(self) → bytes | str | String

Returns the last name of the person

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

getURL(self) → bytes | str | String

Returns the URL associated with the contact person (e.g., the institute webpage

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

setAddress(self, email: bytes | str | String) → None

Sets the address

setContactInfo(self, contact_info: bytes | str | String) → None

Sets miscellaneous info about the contact person

setEmail(self, email: bytes | str | String) → None

Sets the email address

setFirstName(self, name: bytes | str | String) → None

Sets the first name of the person

setInstitution(self, institution: bytes | str | String) → None

Sets the affiliation

setLastName(self, name: bytes | str | String) → None

Sets the last name of the person

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

setName(self, name: bytes | str | String) → None

Sets the full name of the person (gets split into first and last name internally)

setURL(self, email: bytes | str | String) → None

Sets the URL associated with the contact person (e.g., the institute webpage