OpenStructure
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions
MMCifInfoCitation Class Reference

#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

Enumerator
JOURNAL 
BOOK 
UNKNOWN 
JOURNAL 
BOOK 
UNKNOWN 

Definition at line 396 of file mmcif_info.hh.

Enumerator
JOURNAL 
BOOK 
UNKNOWN 
JOURNAL 
BOOK 
UNKNOWN 

Definition at line 396 of file mmcif_info.hh.

Constructor & Destructor Documentation

MMCifInfoCitation ( )
inline

Create a citation.

Definition at line 403 of file mmcif_info.hh.

MMCifInfoCitation ( )
inline

Create a citation.

Definition at line 403 of file mmcif_info.hh.

Member Function Documentation

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

Get the list of authors.

Returns
list

Definition at line 596 of file mmcif_info.hh.

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

Get the list of authors.

Returns
list

Definition at line 596 of file mmcif_info.hh.

String GetBookPublisher ( ) const
inline

Get the publisher of a book.

Returns
publisher

Definition at line 482 of file mmcif_info.hh.

String GetBookPublisher ( ) const
inline

Get the publisher of a book.

Returns
publisher

Definition at line 482 of file mmcif_info.hh.

String GetBookPublisherCity ( ) const
inline

Get the publisher city of a book.

Returns
publisher_city

Definition at line 494 of file mmcif_info.hh.

String GetBookPublisherCity ( ) const
inline

Get the publisher city of a book.

Returns
publisher_city

Definition at line 494 of file mmcif_info.hh.

String GetCAS ( ) const
inline

Get a CAS identifier.

Returns
CAS identifier

Definition at line 422 of file mmcif_info.hh.

String GetCAS ( ) const
inline

Get a CAS identifier.

Returns
CAS identifier

Definition at line 422 of file mmcif_info.hh.

MMCifInfoCType GetCitationType ( ) const
inline

Get the type of a publication.

Returns
citation type

Definition at line 565 of file mmcif_info.hh.

MMCifInfoCType GetCitationType ( ) const
inline

Get the type of a publication.

Returns
citation type

Definition at line 565 of file mmcif_info.hh.

String GetDOI ( ) const
inline

Get the DOI of a document.

Returns
DOI

Definition at line 506 of file mmcif_info.hh.

String GetDOI ( ) const
inline

Get the DOI of a document.

Returns
DOI

Definition at line 506 of file mmcif_info.hh.

String GetID ( ) const
inline

Get ID.

Returns
ID

Definition at line 413 of file mmcif_info.hh.

String GetID ( ) const
inline

Get ID.

Returns
ID

Definition at line 413 of file mmcif_info.hh.

String GetISBN ( ) const
inline

Get an ISBN code.

Returns
ISBN code

Definition at line 432 of file mmcif_info.hh.

String GetISBN ( ) const
inline

Get an ISBN code.

Returns
ISBN code

Definition at line 432 of file mmcif_info.hh.

String GetPageFirst ( ) const
inline

Get the start page of a publication.

Returns
first page

Definition at line 462 of file mmcif_info.hh.

String GetPageFirst ( ) const
inline

Get the start page of a publication.

Returns
first page

Definition at line 462 of file mmcif_info.hh.

String GetPageLast ( ) const
inline

Get the last page of a publication.

Returns
last page

Definition at line 472 of file mmcif_info.hh.

String GetPageLast ( ) const
inline

Get the last page of a publication.

Returns
last page

Definition at line 472 of file mmcif_info.hh.

String GetPublishedIn ( ) const
inline

Get a book title or journal name.

Returns
title

Definition at line 442 of file mmcif_info.hh.

String GetPublishedIn ( ) const
inline

Get a book title or journal name.

Returns
title

Definition at line 442 of file mmcif_info.hh.

int GetPubMed ( ) const
inline

Get the PubMed accession number.

Returns
PubMed accession

Definition at line 516 of file mmcif_info.hh.

int GetPubMed ( ) const
inline

Get the PubMed accession number.

Returns
PubMed accession

Definition at line 516 of file mmcif_info.hh.

String GetTitle ( ) const
inline

Get the title of a publication.

Returns
title

Definition at line 538 of file mmcif_info.hh.

String GetTitle ( ) const
inline

Get the title of a publication.

Returns
title

Definition at line 538 of file mmcif_info.hh.

String GetVolume ( ) const
inline

Get a journal volume.

Returns
volume

Definition at line 452 of file mmcif_info.hh.

String GetVolume ( ) const
inline

Get a journal volume.

Returns
volume

Definition at line 452 of file mmcif_info.hh.

int GetYear ( ) const
inline

Get the year of a publication.

Returns
year

Definition at line 527 of file mmcif_info.hh.

int GetYear ( ) const
inline

Get the year of a publication.

Returns
year

Definition at line 527 of file mmcif_info.hh.

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.

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.

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.

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.

bool IsCitationTypeUnknown ( ) const
inline

Check if the citation type is unknow.

Returns
true or false

Definition at line 584 of file mmcif_info.hh.

bool IsCitationTypeUnknown ( ) const
inline

Check if the citation type is unknow.

Returns
true or false

Definition at line 584 of file mmcif_info.hh.

bool operator!= ( const MMCifInfoCitation cit) const
inline

Definition at line 663 of file mmcif_info.hh.

bool operator!= ( const MMCifInfoCitation cit) const
inline

Definition at line 663 of file mmcif_info.hh.

bool operator== ( const MMCifInfoCitation cit) const
inline

Definition at line 598 of file mmcif_info.hh.

bool operator== ( const MMCifInfoCitation cit) const
inline

Definition at line 598 of file mmcif_info.hh.

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

Set the list of authors.

Parameters
list

Definition at line 591 of file mmcif_info.hh.

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

Set the list of authors.

Parameters
list

Definition at line 591 of file mmcif_info.hh.

void SetBookPublisher ( String  publisher)
inline

Set the publisher for a book.

Parameters
publisher

Definition at line 477 of file mmcif_info.hh.

void SetBookPublisher ( String  publisher)
inline

Set the publisher for a book.

Parameters
publisher

Definition at line 477 of file mmcif_info.hh.

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.

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.

void SetCAS ( String  id)
inline

Set a CAS identifier.

Parameters
idCAS identifier

Definition at line 418 of file mmcif_info.hh.

void SetCAS ( String  id)
inline

Set a CAS identifier.

Parameters
idCAS identifier

Definition at line 418 of file mmcif_info.hh.

void SetCitationType ( MMCifInfoCType  publication_type)
inline

Set the type of a publication.

Parameters
publication_type

Definition at line 543 of file mmcif_info.hh.

void SetCitationType ( MMCifInfoCType  publication_type)
inline

Set the type of a publication.

Parameters
publication_type

Definition at line 543 of file mmcif_info.hh.

void SetCitationTypeBook ( )
inline

Set the type of a publication to book.

Definition at line 553 of file mmcif_info.hh.

void SetCitationTypeBook ( )
inline

Set the type of a publication to book.

Definition at line 553 of file mmcif_info.hh.

void SetCitationTypeJournal ( )
inline

Set the type of a publication to journal.

Definition at line 548 of file mmcif_info.hh.

void SetCitationTypeJournal ( )
inline

Set the type of a publication to journal.

Definition at line 548 of file mmcif_info.hh.

void SetCitationTypeUnknown ( )
inline

Set the type of a publication to unknown.

Definition at line 558 of file mmcif_info.hh.

void SetCitationTypeUnknown ( )
inline

Set the type of a publication to unknown.

Definition at line 558 of file mmcif_info.hh.

void SetDOI ( String  doi)
inline

Set the DOI of a document.

Parameters
doi

Definition at line 501 of file mmcif_info.hh.

void SetDOI ( String  doi)
inline

Set the DOI of a document.

Parameters
doi

Definition at line 501 of file mmcif_info.hh.

void SetID ( String  id)
inline

Set ID.

Parameters
idID

Definition at line 409 of file mmcif_info.hh.

void SetID ( String  id)
inline

Set ID.

Parameters
idID

Definition at line 409 of file mmcif_info.hh.

void SetISBN ( String  code)
inline

Set an ISBN code.

Parameters
codeISBN code

Definition at line 427 of file mmcif_info.hh.

void SetISBN ( String  code)
inline

Set an ISBN code.

Parameters
codeISBN code

Definition at line 427 of file mmcif_info.hh.

void SetPageFirst ( String  first)
inline

Set the start page for a publication.

Parameters
first

Definition at line 457 of file mmcif_info.hh.

void SetPageFirst ( String  first)
inline

Set the start page for a publication.

Parameters
first

Definition at line 457 of file mmcif_info.hh.

void SetPageLast ( String  last)
inline

Set the end page for a publication.

Parameters
last

Definition at line 467 of file mmcif_info.hh.

void SetPageLast ( String  last)
inline

Set the end page for a publication.

Parameters
last

Definition at line 467 of file mmcif_info.hh.

void SetPublishedIn ( String  title)
inline

Set a book title or journal name.

Parameters
titlewhere published

Definition at line 437 of file mmcif_info.hh.

void SetPublishedIn ( String  title)
inline

Set a book title or journal name.

Parameters
titlewhere published

Definition at line 437 of file mmcif_info.hh.

void SetPubMed ( int  no)
inline

Set the PubMed accession number.

Parameters
no

Definition at line 511 of file mmcif_info.hh.

void SetPubMed ( int  no)
inline

Set the PubMed accession number.

Parameters
no

Definition at line 511 of file mmcif_info.hh.

void SetTitle ( String  title)
inline

Set the title of a publication.

Parameters
title

Definition at line 533 of file mmcif_info.hh.

void SetTitle ( String  title)
inline

Set the title of a publication.

Parameters
title

Definition at line 533 of file mmcif_info.hh.

void SetVolume ( String  volume)
inline

Set a journal volume.

Parameters
volume

Definition at line 447 of file mmcif_info.hh.

void SetVolume ( String  volume)
inline

Set a journal volume.

Parameters
volume

Definition at line 447 of file mmcif_info.hh.

void SetYear ( int  year)
inline

Set the year of a publication.

Parameters
year

Definition at line 521 of file mmcif_info.hh.

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 files: