OpenMS
Public Member Functions | Protected Attributes | List of all members
ContactPerson Class Reference
Metadata

Contact person information. More...

#include <OpenMS/METADATA/ContactPerson.h>

Inheritance diagram for ContactPerson:
[legend]
Collaboration diagram for ContactPerson:
[legend]

Public Member Functions

 ContactPerson ()=default
 Constructor. More...
 
 ContactPerson (const ContactPerson &)=default
 Copy constructor. More...
 
 ContactPerson (ContactPerson &&)=default
 Move constructor. More...
 
 ~ContactPerson ()=default
 Destructor. More...
 
ContactPerson & operator= (const ContactPerson &)=default
 Assignment operator. More...
 
ContactPerson & operator= (ContactPerson &&) &=default
 Move assignment operator. More...
 
bool operator== (const ContactPerson &rhs) const
 Equality operator. More...
 
bool operator!= (const ContactPerson &rhs) const
 Equality operator. More...
 
const String & getFirstName () const
 returns the first name of the person More...
 
void setFirstName (const String &name)
 sets the first name of the person More...
 
const String & getLastName () const
 returns the last name of the person More...
 
void setLastName (const String &name)
 sets the last name of the person More...
 
void setName (const String &name)
 sets the full name of the person (gets split into first and last name internally) More...
 
const String & getInstitution () const
 returns the affiliation More...
 
void setInstitution (const String &institution)
 sets the affiliation More...
 
const String & getEmail () const
 returns the email address More...
 
void setEmail (const String &email)
 sets the email address More...
 
const String & getURL () const
 returns the email address More...
 
void setURL (const String &email)
 sets the email address More...
 
const String & getAddress () const
 returns the address More...
 
void setAddress (const String &email)
 sets the address More...
 
const String & getContactInfo () const
 returns miscellaneous info about the contact person More...
 
void setContactInfo (const String &contact_info)
 sets miscellaneous info about the contact person More...
 
- Public Member Functions inherited from MetaInfoInterface
 MetaInfoInterface ()
 Constructor. More...
 
 MetaInfoInterface (const MetaInfoInterface &rhs)
 Copy constructor. More...
 
 MetaInfoInterface (MetaInfoInterface &&) noexcept
 Move constructor. More...
 
 ~MetaInfoInterface ()
 Destructor. More...
 
MetaInfoInterface & operator= (const MetaInfoInterface &rhs)
 Assignment operator. More...
 
MetaInfoInterface & operator= (MetaInfoInterface &&) noexcept
 Move assignment operator. More...
 
void swap (MetaInfoInterface &rhs)
 Swap contents. More...
 
bool operator== (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
bool operator!= (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
const DataValue & getMetaValue (const String &name) const
 Returns the value corresponding to a string, or DataValue::EMPTY if not found. More...
 
DataValue getMetaValue (const String &name, const DataValue &default_value) const
 Returns the value corresponding to a string, or a default value (e.g.: DataValue::EMPTY) if not found
More...
 
const DataValue & getMetaValue (UInt index) const
 Returns the value corresponding to the index, or DataValue::EMPTY if not found. More...
 
DataValue getMetaValue (UInt index, const DataValue &default_value) const
 Returns the value corresponding to the index, or a default value (e.g.: DataValue::EMPTY) if not found
More...
 
bool metaValueExists (const String &name) const
 Returns whether an entry with the given name exists. More...
 
bool metaValueExists (UInt index) const
 Returns whether an entry with the given index exists. More...
 
void setMetaValue (const String &name, const DataValue &value)
 Sets the DataValue corresponding to a name. More...
 
void setMetaValue (UInt index, const DataValue &value)
 Sets the DataValue corresponding to an index. More...
 
void removeMetaValue (const String &name)
 Removes the DataValue corresponding to name if it exists. More...
 
void removeMetaValue (UInt index)
 Removes the DataValue corresponding to index if it exists. More...
 
void addMetaValues (const MetaInfoInterface &from)
 function to copy all meta values from one object to this one More...
 
void getKeys (std::vector< String > &keys) const
 Fills the given vector with a list of all keys for which a value is set. More...
 
void getKeys (std::vector< UInt > &keys) const
 Fills the given vector with a list of all keys for which a value is set. More...
 
bool isMetaEmpty () const
 Returns if the MetaInfo is empty. More...
 
void clearMetaInfo ()
 Removes all meta values. More...
 

Protected Attributes

String first_name_
 
String last_name_
 
String institution_
 
String email_
 
String contact_info_
 
String url_
 
String address_
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfo * meta_
 Pointer to the MetaInfo object (0 by default) More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistry & metaRegistry ()
 Returns a reference to the MetaInfoRegistry. More...
 
- Protected Member Functions inherited from MetaInfoInterface
void createIfNotExists_ ()
 Creates the MetaInfo object if it does not exist. More...
 

Detailed Description

Contact person information.

Constructor & Destructor Documentation

◆ ContactPerson() [1/3]

ContactPerson ( )
default

Constructor.

◆ ContactPerson() [2/3]

ContactPerson ( const ContactPerson &  )
default

Copy constructor.

◆ ContactPerson() [3/3]

ContactPerson ( ContactPerson &&  )
default

Move constructor.

◆ ~ContactPerson()

~ContactPerson ( )
default

Destructor.

Member Function Documentation

◆ getAddress()

const String& getAddress ( ) const

returns the address

◆ getContactInfo()

const String& getContactInfo ( ) const

returns miscellaneous info about the contact person

◆ getEmail()

const String& getEmail ( ) const

returns the email address

◆ getFirstName()

const String& getFirstName ( ) const

returns the first name of the person

◆ getInstitution()

const String& getInstitution ( ) const

returns the affiliation

◆ getLastName()

const String& getLastName ( ) const

returns the last name of the person

◆ getURL()

const String& getURL ( ) const

returns the email address

◆ operator!=()

bool operator!= ( const ContactPerson &  rhs) const

Equality operator.

◆ operator=() [1/2]

ContactPerson& operator= ( const ContactPerson &  )
default

Assignment operator.

◆ operator=() [2/2]

ContactPerson& operator= ( ContactPerson &&  ) &
default

Move assignment operator.

◆ operator==()

bool operator== ( const ContactPerson &  rhs) const

Equality operator.

◆ setAddress()

void setAddress ( const String &  email)

sets the address

◆ setContactInfo()

void setContactInfo ( const String &  contact_info)

sets miscellaneous info about the contact person

◆ setEmail()

void setEmail ( const String &  email)

sets the email address

◆ setFirstName()

void setFirstName ( const String &  name)

sets the first name of the person

◆ setInstitution()

void setInstitution ( const String &  institution)

sets the affiliation

◆ setLastName()

void setLastName ( const String &  name)

sets the last name of the person

◆ setName()

void setName ( const String &  name)

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

◆ setURL()

void setURL ( const String &  email)

sets the email address

Member Data Documentation

◆ address_

String address_
protected

◆ contact_info_

String contact_info_
protected

◆ email_

String email_
protected

◆ first_name_

String first_name_
protected

◆ institution_

String institution_
protected

◆ last_name_

String last_name_
protected

◆ url_

String url_
protected