#include <mmcif_info.hh>

Public Types
enum	MMCifInfoCType { JOURNAL , BOOK , UNKNOWN , JOURNAL , BOOK , UNKNOWN }

enum	MMCifInfoCType { JOURNAL , BOOK , UNKNOWN , JOURNAL , BOOK , UNKNOWN }

Public Member Functions
	MMCifInfoCitation ()

void	SetID (String id)

String	GetID () const

void	SetCAS (String id)

String	GetCAS () const

void	SetISBN (String code)

String	GetISBN () const

void	SetPublishedIn (String title)

String	GetPublishedIn () const

void	SetVolume (String volume)

String	GetVolume () const

void	SetPageFirst (String first)

String	GetPageFirst () const

void	SetPageLast (String last)

String	GetPageLast () const

void	SetBookPublisher (String publisher)

String	GetBookPublisher () const

void	SetBookPublisherCity (String publisher_city)

String	GetBookPublisherCity () const

void	SetDOI (String doi)

String	GetDOI () const

void	SetPubMed (int no)

int	GetPubMed () const

void	SetYear (int year)

int	GetYear () const

void	SetTitle (String title)

String	GetTitle () const

void	SetCitationType (MMCifInfoCType publication_type)

void	SetCitationTypeJournal ()

void	SetCitationTypeBook ()

void	SetCitationTypeUnknown ()

MMCifInfoCType	GetCitationType () const

bool	IsCitationTypeJournal () const

bool	IsCitationTypeBook () const

bool	IsCitationTypeUnknown () const

void	SetAuthorList (std::vector< String > list)

const std::vector< String > &	GetAuthorList () const

bool	operator== (const MMCifInfoCitation &cit) const

bool	operator!= (const MMCifInfoCitation &cit) const

	MMCifInfoCitation ()

void	SetID (String id)

String	GetID () const

void	SetCAS (String id)

String	GetCAS () const

void	SetISBN (String code)

String	GetISBN () const

void	SetPublishedIn (String title)

String	GetPublishedIn () const

void	SetVolume (String volume)

String	GetVolume () const

void	SetPageFirst (String first)

String	GetPageFirst () const

void	SetPageLast (String last)

String	GetPageLast () const

void	SetBookPublisher (String publisher)

String	GetBookPublisher () const

void	SetBookPublisherCity (String publisher_city)

String	GetBookPublisherCity () const

void	SetDOI (String doi)

String	GetDOI () const

void	SetPubMed (int no)

int	GetPubMed () const

void	SetYear (int year)

int	GetYear () const

void	SetTitle (String title)

String	GetTitle () const

void	SetCitationType (MMCifInfoCType publication_type)

void	SetCitationTypeJournal ()

void	SetCitationTypeBook ()

void	SetCitationTypeUnknown ()

MMCifInfoCType	GetCitationType () const

bool	IsCitationTypeJournal () const

bool	IsCitationTypeBook () const

bool	IsCitationTypeUnknown () const

void	SetAuthorList (std::vector< String > list)

const std::vector< String > &	GetAuthorList () const

bool	operator== (const MMCifInfoCitation &cit) const

bool	operator!= (const MMCifInfoCitation &cit) const

Detailed Description

Definition at line 393 of file mmcif_info.hh.

Member Enumeration Documentation

◆ MMCifInfoCType [1/2]

enum MMCifInfoCType

Enumerator
JOURNAL
BOOK
UNKNOWN
JOURNAL
BOOK
UNKNOWN

Definition at line 396 of file mmcif_info.hh.

◆ MMCifInfoCType [2/2]

enum MMCifInfoCType

Enumerator
JOURNAL
BOOK
UNKNOWN
JOURNAL
BOOK
UNKNOWN

Definition at line 396 of file mmcif_info.hh.

Constructor & Destructor Documentation

◆ MMCifInfoCitation() [1/2]

MMCifInfoCitation ( )

inline

Create a citation.

Definition at line 403 of file mmcif_info.hh.

◆ MMCifInfoCitation() [2/2]

MMCifInfoCitation ( )

inline

Create a citation.

Definition at line 403 of file mmcif_info.hh.

Member Function Documentation

◆ GetAuthorList() [1/2]

const std::vector<String>& GetAuthorList ( ) const

inline

Get the list of authors.

Returns: list

Definition at line 596 of file mmcif_info.hh.

◆ GetAuthorList() [2/2]

const std::vector<String>& GetAuthorList ( ) const

inline

Get the list of authors.

Returns: list

Definition at line 596 of file mmcif_info.hh.

◆ GetBookPublisher() [1/2]

String GetBookPublisher ( ) const

inline

Get the publisher of a book.

Returns: publisher

Definition at line 482 of file mmcif_info.hh.

◆ GetBookPublisher() [2/2]

String GetBookPublisher ( ) const

inline

Get the publisher of a book.

Returns: publisher

Definition at line 482 of file mmcif_info.hh.

◆ GetBookPublisherCity() [1/2]

String GetBookPublisherCity ( ) const

inline

Get the publisher city of a book.

Returns: publisher_city

Definition at line 494 of file mmcif_info.hh.

◆ GetBookPublisherCity() [2/2]

String GetBookPublisherCity ( ) const

inline

Get the publisher city of a book.

Returns: publisher_city

Definition at line 494 of file mmcif_info.hh.

◆ GetCAS() [1/2]

String GetCAS ( ) const

inline

Get a CAS identifier.

Returns: CAS identifier

Definition at line 422 of file mmcif_info.hh.

◆ GetCAS() [2/2]

String GetCAS ( ) const

inline

Get a CAS identifier.

Returns: CAS identifier

Definition at line 422 of file mmcif_info.hh.

◆ GetCitationType() [1/2]

MMCifInfoCType GetCitationType ( ) const

inline

Get the type of a publication.

Returns: citation type

Definition at line 565 of file mmcif_info.hh.

◆ GetCitationType() [2/2]

MMCifInfoCType GetCitationType ( ) const

inline

Get the type of a publication.

Returns: citation type

Definition at line 565 of file mmcif_info.hh.

◆ GetDOI() [1/2]

String GetDOI ( ) const

inline

Get the DOI of a document.

Returns: DOI

Definition at line 506 of file mmcif_info.hh.

◆ GetDOI() [2/2]

String GetDOI ( ) const

inline

Get the DOI of a document.

Returns: DOI

Definition at line 506 of file mmcif_info.hh.

◆ GetID() [1/2]

String GetID ( ) const

inline

Get ID.

Returns: ID

Definition at line 413 of file mmcif_info.hh.

◆ GetID() [2/2]

String GetID ( ) const

inline

Get ID.

Returns: ID

Definition at line 413 of file mmcif_info.hh.

◆ GetISBN() [1/2]

String GetISBN ( ) const

inline

Get an ISBN code.

Returns: ISBN code

Definition at line 432 of file mmcif_info.hh.

◆ GetISBN() [2/2]

String GetISBN ( ) const

inline

Get an ISBN code.

Returns: ISBN code

Definition at line 432 of file mmcif_info.hh.

◆ GetPageFirst() [1/2]

String GetPageFirst ( ) const

inline

Get the start page of a publication.

Returns: first page

Definition at line 462 of file mmcif_info.hh.

◆ GetPageFirst() [2/2]

String GetPageFirst ( ) const

inline

Get the start page of a publication.

Returns: first page

Definition at line 462 of file mmcif_info.hh.

◆ GetPageLast() [1/2]

String GetPageLast ( ) const

inline

Get the last page of a publication.

Returns: last page

Definition at line 472 of file mmcif_info.hh.

◆ GetPageLast() [2/2]

String GetPageLast ( ) const

inline

Get the last page of a publication.

Returns: last page

Definition at line 472 of file mmcif_info.hh.

◆ GetPublishedIn() [1/2]

String GetPublishedIn ( ) const

inline

Get a book title or journal name.

Returns: title

Definition at line 442 of file mmcif_info.hh.

◆ GetPublishedIn() [2/2]

String GetPublishedIn ( ) const

inline

Get a book title or journal name.

Returns: title

Definition at line 442 of file mmcif_info.hh.

◆ GetPubMed() [1/2]

int GetPubMed ( ) const

inline

Get the PubMed accession number.

Returns: PubMed accession

Definition at line 516 of file mmcif_info.hh.

◆ GetPubMed() [2/2]

int GetPubMed ( ) const

inline

Get the PubMed accession number.

Returns: PubMed accession

Definition at line 516 of file mmcif_info.hh.

◆ GetTitle() [1/2]

String GetTitle ( ) const

inline

Get the title of a publication.

Returns: title

Definition at line 538 of file mmcif_info.hh.

◆ GetTitle() [2/2]

String GetTitle ( ) const

inline

Get the title of a publication.

Returns: title

Definition at line 538 of file mmcif_info.hh.

◆ GetVolume() [1/2]

String GetVolume ( ) const

inline

Get a journal volume.

Returns: volume

Definition at line 452 of file mmcif_info.hh.

◆ GetVolume() [2/2]

String GetVolume ( ) const

inline

Get a journal volume.

Returns: volume

Definition at line 452 of file mmcif_info.hh.

◆ GetYear() [1/2]

int GetYear ( ) const

inline

Get the year of a publication.

Returns: year

Definition at line 527 of file mmcif_info.hh.

◆ GetYear() [2/2]

int GetYear ( ) const

inline

Get the year of a publication.

Returns: year

Definition at line 527 of file mmcif_info.hh.

◆ IsCitationTypeBook() [1/2]

bool IsCitationTypeBook ( ) const

inline

Check a citation to be published in a book.

Returns: true or false

Definition at line 577 of file mmcif_info.hh.

◆ IsCitationTypeBook() [2/2]

bool IsCitationTypeBook ( ) const

inline

Check a citation to be published in a book.

Returns: true or false

Definition at line 577 of file mmcif_info.hh.

◆ IsCitationTypeJournal() [1/2]

bool IsCitationTypeJournal ( ) const

inline

Check a citation to be published in a journal.

Returns: true or false

Definition at line 570 of file mmcif_info.hh.

◆ IsCitationTypeJournal() [2/2]

bool IsCitationTypeJournal ( ) const

inline

Check a citation to be published in a journal.

Returns: true or false

Definition at line 570 of file mmcif_info.hh.

◆ IsCitationTypeUnknown() [1/2]

bool IsCitationTypeUnknown ( ) const

inline

Check if the citation type is unknow.

Returns: true or false

Definition at line 584 of file mmcif_info.hh.

◆ IsCitationTypeUnknown() [2/2]

bool IsCitationTypeUnknown ( ) const

inline

Check if the citation type is unknow.

Returns: true or false

Definition at line 584 of file mmcif_info.hh.

◆ operator!=() [1/2]

bool operator!= ( const MMCifInfoCitation & cit ) const

inline

Definition at line 663 of file mmcif_info.hh.

◆ operator!=() [2/2]

bool operator!= ( const MMCifInfoCitation & cit ) const

inline

Definition at line 663 of file mmcif_info.hh.

◆ operator==() [1/2]

bool operator== ( const MMCifInfoCitation & cit ) const

inline

Definition at line 598 of file mmcif_info.hh.

◆ operator==() [2/2]

bool operator== ( const MMCifInfoCitation & cit ) const

inline

Definition at line 598 of file mmcif_info.hh.

◆ SetAuthorList() [1/2]

void SetAuthorList ( std::vector< String > list )

inline

Set the list of authors.

Parameters

list

Definition at line 591 of file mmcif_info.hh.

◆ SetAuthorList() [2/2]

void SetAuthorList ( std::vector< String > list )

inline

Set the list of authors.

Parameters

list

Definition at line 591 of file mmcif_info.hh.

◆ SetBookPublisher() [1/2]

void SetBookPublisher ( String publisher )

inline

Set the publisher for a book.

Parameters

publisher

Definition at line 477 of file mmcif_info.hh.

◆ SetBookPublisher() [2/2]

void SetBookPublisher ( String publisher )

inline

Set the publisher for a book.

Parameters

publisher

Definition at line 477 of file mmcif_info.hh.

◆ SetBookPublisherCity() [1/2]

void SetBookPublisherCity ( String publisher_city )

inline

Set the publisher city for a book.

Parameters

publisher_city

Definition at line 487 of file mmcif_info.hh.

◆ SetBookPublisherCity() [2/2]

void SetBookPublisherCity ( String publisher_city )

inline

Set the publisher city for a book.

Parameters

publisher_city

Definition at line 487 of file mmcif_info.hh.

◆ SetCAS() [1/2]

void SetCAS ( String id )

inline

Set a CAS identifier.

Parameters

id	CAS identifier

Definition at line 418 of file mmcif_info.hh.

◆ SetCAS() [2/2]

void SetCAS ( String id )

inline

Set a CAS identifier.

Parameters

id	CAS identifier

Definition at line 418 of file mmcif_info.hh.

◆ SetCitationType() [1/2]

void SetCitationType ( MMCifInfoCType publication_type )

inline

Set the type of a publication.

Parameters

publication_type

Definition at line 543 of file mmcif_info.hh.

◆ SetCitationType() [2/2]

void SetCitationType ( MMCifInfoCType publication_type )

inline

Set the type of a publication.

Parameters

publication_type

Definition at line 543 of file mmcif_info.hh.

◆ SetCitationTypeBook() [1/2]

void SetCitationTypeBook ( )

inline

Set the type of a publication to book.

Definition at line 553 of file mmcif_info.hh.

◆ SetCitationTypeBook() [2/2]

void SetCitationTypeBook ( )

inline

Set the type of a publication to book.

Definition at line 553 of file mmcif_info.hh.

◆ SetCitationTypeJournal() [1/2]

void SetCitationTypeJournal ( )

inline

Set the type of a publication to journal.

Definition at line 548 of file mmcif_info.hh.

◆ SetCitationTypeJournal() [2/2]

void SetCitationTypeJournal ( )

inline

Set the type of a publication to journal.

Definition at line 548 of file mmcif_info.hh.

◆ SetCitationTypeUnknown() [1/2]

void SetCitationTypeUnknown ( )

inline

Set the type of a publication to unknown.

Definition at line 558 of file mmcif_info.hh.

◆ SetCitationTypeUnknown() [2/2]

void SetCitationTypeUnknown ( )

inline

Set the type of a publication to unknown.

Definition at line 558 of file mmcif_info.hh.

◆ SetDOI() [1/2]

void SetDOI ( String doi )

inline

Set the DOI of a document.

Parameters

doi

Definition at line 501 of file mmcif_info.hh.

◆ SetDOI() [2/2]

void SetDOI ( String doi )

inline

Set the DOI of a document.

Parameters

doi

Definition at line 501 of file mmcif_info.hh.

◆ SetID() [1/2]

void SetID ( String id )

inline

Set ID.

Parameters

id ID

Definition at line 409 of file mmcif_info.hh.

◆ SetID() [2/2]

void SetID ( String id )

inline

Set ID.

Parameters

id ID

Definition at line 409 of file mmcif_info.hh.

◆ SetISBN() [1/2]

void SetISBN ( String code )

inline

Set an ISBN code.

Parameters

code ISBN code

Definition at line 427 of file mmcif_info.hh.

◆ SetISBN() [2/2]

void SetISBN ( String code )

inline

Set an ISBN code.

Parameters

code ISBN code

Definition at line 427 of file mmcif_info.hh.

◆ SetPageFirst() [1/2]

void SetPageFirst ( String first )

inline

Set the start page for a publication.

Parameters

first

Definition at line 457 of file mmcif_info.hh.

◆ SetPageFirst() [2/2]

void SetPageFirst ( String first )

inline

Set the start page for a publication.

Parameters

first

Definition at line 457 of file mmcif_info.hh.

◆ SetPageLast() [1/2]

void SetPageLast ( String last )

inline

Set the end page for a publication.

Parameters

last

Definition at line 467 of file mmcif_info.hh.

◆ SetPageLast() [2/2]

void SetPageLast ( String last )

inline

Set the end page for a publication.

Parameters

last

Definition at line 467 of file mmcif_info.hh.

◆ SetPublishedIn() [1/2]

void SetPublishedIn ( String title )

inline

Set a book title or journal name.

Parameters

title where published

Definition at line 437 of file mmcif_info.hh.

◆ SetPublishedIn() [2/2]

void SetPublishedIn ( String title )

inline

Set a book title or journal name.

Parameters

title where published

Definition at line 437 of file mmcif_info.hh.

◆ SetPubMed() [1/2]

void SetPubMed ( int no )

inline

Set the PubMed accession number.

Parameters

no

Definition at line 511 of file mmcif_info.hh.

◆ SetPubMed() [2/2]

void SetPubMed ( int no )

inline

Set the PubMed accession number.

Parameters

no

Definition at line 511 of file mmcif_info.hh.

◆ SetTitle() [1/2]

void SetTitle ( String title )

inline

Set the title of a publication.

Parameters

title

Definition at line 533 of file mmcif_info.hh.

◆ SetTitle() [2/2]

void SetTitle ( String title )

inline

Set the title of a publication.

Parameters

title

Definition at line 533 of file mmcif_info.hh.

◆ SetVolume() [1/2]

void SetVolume ( String volume )

inline

Set a journal volume.

Parameters

volume

Definition at line 447 of file mmcif_info.hh.

◆ SetVolume() [2/2]

void SetVolume ( String volume )

inline

Set a journal volume.

Parameters

volume

Definition at line 447 of file mmcif_info.hh.

◆ SetYear() [1/2]

void SetYear ( int year )

inline

Set the year of a publication.

Parameters

year

Definition at line 521 of file mmcif_info.hh.

◆ SetYear() [2/2]

void SetYear ( int year )

inline

Set the year of a publication.

Parameters

year

Definition at line 521 of file mmcif_info.hh.

The documentation for this class was generated from the following file:

build-dev-doc/stage/include/ost/io/mmcif_info.hh

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ MMCifInfoCType [1/2]

◆ MMCifInfoCType [2/2]

Constructor & Destructor Documentation

◆ MMCifInfoCitation() [1/2]

◆ MMCifInfoCitation() [2/2]

Member Function Documentation

◆ GetAuthorList() [1/2]

◆ GetAuthorList() [2/2]

◆ GetBookPublisher() [1/2]

◆ GetBookPublisher() [2/2]

◆ GetBookPublisherCity() [1/2]

◆ GetBookPublisherCity() [2/2]

◆ GetCAS() [1/2]

◆ GetCAS() [2/2]

◆ GetCitationType() [1/2]

◆ GetCitationType() [2/2]

◆ GetDOI() [1/2]

◆ GetDOI() [2/2]

◆ GetID() [1/2]

◆ GetID() [2/2]

◆ GetISBN() [1/2]

◆ GetISBN() [2/2]

◆ GetPageFirst() [1/2]

◆ GetPageFirst() [2/2]

◆ GetPageLast() [1/2]

◆ GetPageLast() [2/2]

◆ GetPublishedIn() [1/2]

◆ GetPublishedIn() [2/2]

◆ GetPubMed() [1/2]

◆ GetPubMed() [2/2]

◆ GetTitle() [1/2]

◆ GetTitle() [2/2]

◆ GetVolume() [1/2]

◆ GetVolume() [2/2]

◆ GetYear() [1/2]

◆ GetYear() [2/2]

◆ IsCitationTypeBook() [1/2]

◆ IsCitationTypeBook() [2/2]

◆ IsCitationTypeJournal() [1/2]

◆ IsCitationTypeJournal() [2/2]

◆ IsCitationTypeUnknown() [1/2]

◆ IsCitationTypeUnknown() [2/2]

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ SetAuthorList() [1/2]

◆ SetAuthorList() [2/2]

◆ SetBookPublisher() [1/2]

◆ SetBookPublisher() [2/2]

◆ SetBookPublisherCity() [1/2]

◆ SetBookPublisherCity() [2/2]

◆ SetCAS() [1/2]

◆ SetCAS() [2/2]

◆ SetCitationType() [1/2]

◆ SetCitationType() [2/2]

◆ SetCitationTypeBook() [1/2]

◆ SetCitationTypeBook() [2/2]

◆ SetCitationTypeJournal() [1/2]

◆ SetCitationTypeJournal() [2/2]

◆ SetCitationTypeUnknown() [1/2]

◆ SetCitationTypeUnknown() [2/2]

◆ SetDOI() [1/2]

◆ SetDOI() [2/2]

◆ SetID() [1/2]

◆ SetID() [2/2]

◆ SetISBN() [1/2]

◆ SetISBN() [2/2]

◆ SetPageFirst() [1/2]

◆ SetPageFirst() [2/2]

◆ SetPageLast() [1/2]

◆ SetPageLast() [2/2]

◆ SetPublishedIn() [1/2]

◆ SetPublishedIn() [2/2]

◆ SetPubMed() [1/2]

◆ SetPubMed() [2/2]