NCBI C++ ToolKit
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes

Represents ASN.1 type GBReference defined in file gbseq.asn

Search Toolkit Book for CGBReference_Base

CGBReference_Base --. More...

#include <objects/gbseq/GBReference_.hpp>

+ Inheritance diagram for CGBReference_Base:
+ Collaboration diagram for CGBReference_Base:

List of all members.

Public Types

typedef string TReference
typedef string TPosition
typedef list< CGBAuthorTAuthors
typedef string TConsortium
typedef string TTitle
typedef string TJournal
typedef list< CRef< CGBXref > > TXref
typedef int TPubmed
typedef string TRemark

Public Member Functions

 CGBReference_Base (void)
virtual ~CGBReference_Base (void)
 DECLARE_INTERNAL_TYPE_INFO ()
bool IsSetReference (void) const
 Check if a value has been assigned to Reference data member.
bool CanGetReference (void) const
 Check if it is safe to call GetReference method.
void ResetReference (void)
 Reset Reference data member.
const TReferenceGetReference (void) const
 Get the Reference member data.
void SetReference (const TReference &value)
 Assign a value to Reference data member.
TReferenceSetReference (void)
 Assign a value to Reference data member.
bool IsSetPosition (void) const
 Check if a value has been assigned to Position data member.
bool CanGetPosition (void) const
 Check if it is safe to call GetPosition method.
void ResetPosition (void)
 Reset Position data member.
const TPositionGetPosition (void) const
 Get the Position member data.
void SetPosition (const TPosition &value)
 Assign a value to Position data member.
TPositionSetPosition (void)
 Assign a value to Position data member.
bool IsSetAuthors (void) const
 Check if a value has been assigned to Authors data member.
bool CanGetAuthors (void) const
 Check if it is safe to call GetAuthors method.
void ResetAuthors (void)
 Reset Authors data member.
const TAuthorsGetAuthors (void) const
 Get the Authors member data.
TAuthorsSetAuthors (void)
 Assign a value to Authors data member.
bool IsSetConsortium (void) const
 Check if a value has been assigned to Consortium data member.
bool CanGetConsortium (void) const
 Check if it is safe to call GetConsortium method.
void ResetConsortium (void)
 Reset Consortium data member.
const TConsortiumGetConsortium (void) const
 Get the Consortium member data.
void SetConsortium (const TConsortium &value)
 Assign a value to Consortium data member.
TConsortiumSetConsortium (void)
 Assign a value to Consortium data member.
bool IsSetTitle (void) const
 Check if a value has been assigned to Title data member.
bool CanGetTitle (void) const
 Check if it is safe to call GetTitle method.
void ResetTitle (void)
 Reset Title data member.
const TTitleGetTitle (void) const
 Get the Title member data.
void SetTitle (const TTitle &value)
 Assign a value to Title data member.
TTitleSetTitle (void)
 Assign a value to Title data member.
bool IsSetJournal (void) const
 Check if a value has been assigned to Journal data member.
bool CanGetJournal (void) const
 Check if it is safe to call GetJournal method.
void ResetJournal (void)
 Reset Journal data member.
const TJournalGetJournal (void) const
 Get the Journal member data.
void SetJournal (const TJournal &value)
 Assign a value to Journal data member.
TJournalSetJournal (void)
 Assign a value to Journal data member.
bool IsSetXref (void) const
 Check if a value has been assigned to Xref data member.
bool CanGetXref (void) const
 Check if it is safe to call GetXref method.
void ResetXref (void)
 Reset Xref data member.
const TXrefGetXref (void) const
 Get the Xref member data.
TXrefSetXref (void)
 Assign a value to Xref data member.
bool IsSetPubmed (void) const
 Check if a value has been assigned to Pubmed data member.
bool CanGetPubmed (void) const
 Check if it is safe to call GetPubmed method.
void ResetPubmed (void)
 Reset Pubmed data member.
TPubmed GetPubmed (void) const
 Get the Pubmed member data.
void SetPubmed (TPubmed value)
 Assign a value to Pubmed data member.
TPubmedSetPubmed (void)
 Assign a value to Pubmed data member.
bool IsSetRemark (void) const
 Check if a value has been assigned to Remark data member.
bool CanGetRemark (void) const
 Check if it is safe to call GetRemark method.
void ResetRemark (void)
 Reset Remark data member.
const TRemarkGetRemark (void) const
 Get the Remark member data.
void SetRemark (const TRemark &value)
 Assign a value to Remark data member.
TRemarkSetRemark (void)
 Assign a value to Remark data member.
virtual void Reset (void)
 Reset the whole object.

Private Types

typedef CSerialObject Tparent

Private Member Functions

 CGBReference_Base (const CGBReference_Base &)
CGBReference_Baseoperator= (const CGBReference_Base &)

Private Attributes

Uint4 m_set_State [1]
string m_Reference
string m_Position
list< CGBAuthorm_Authors
string m_Consortium
string m_Title
string m_Journal
list< CRef< CGBXref > > m_Xref
int m_Pubmed
string m_Remark

Detailed Description

CGBReference_Base --.

Definition at line 78 of file GBReference_.hpp.


Member Typedef Documentation

Definition at line 93 of file GBReference_.hpp.

Definition at line 94 of file GBReference_.hpp.

Definition at line 96 of file GBReference_.hpp.

Reimplemented in CGBReference.

Definition at line 80 of file GBReference_.hpp.

Definition at line 92 of file GBReference_.hpp.

Definition at line 98 of file GBReference_.hpp.

Definition at line 91 of file GBReference_.hpp.

Definition at line 99 of file GBReference_.hpp.

Definition at line 95 of file GBReference_.hpp.

Definition at line 97 of file GBReference_.hpp.


Constructor & Destructor Documentation

Definition at line 129 of file GBReference_.cpp.

References m_set_State.

Definition at line 136 of file GBReference_.cpp.


Member Function Documentation

bool CGBReference_Base::CanGetAuthors ( void  ) const [inline]

Check if it is safe to call GetAuthors method.

Returns:
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 543 of file GBReference_.hpp.

bool CGBReference_Base::CanGetConsortium ( void  ) const [inline]

Check if it is safe to call GetConsortium method.

Returns:
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 568 of file GBReference_.hpp.

References IsSetConsortium().

Referenced by GetConsortium().

bool CGBReference_Base::CanGetJournal ( void  ) const [inline]

Check if it is safe to call GetJournal method.

Returns:
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 648 of file GBReference_.hpp.

References IsSetJournal().

Referenced by GetJournal().

bool CGBReference_Base::CanGetPosition ( void  ) const [inline]

Check if it is safe to call GetPosition method.

Returns:
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 503 of file GBReference_.hpp.

References IsSetPosition().

Referenced by GetPosition().

bool CGBReference_Base::CanGetPubmed ( void  ) const [inline]

Check if it is safe to call GetPubmed method.

Returns:
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 713 of file GBReference_.hpp.

References IsSetPubmed().

Referenced by GetPubmed().

bool CGBReference_Base::CanGetReference ( void  ) const [inline]

Check if it is safe to call GetReference method.

Returns:
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 463 of file GBReference_.hpp.

References IsSetReference().

Referenced by GetReference().

bool CGBReference_Base::CanGetRemark ( void  ) const [inline]

Check if it is safe to call GetRemark method.

Returns:
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 760 of file GBReference_.hpp.

References IsSetRemark().

Referenced by GetRemark().

bool CGBReference_Base::CanGetTitle ( void  ) const [inline]

Check if it is safe to call GetTitle method.

Returns:
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 608 of file GBReference_.hpp.

References IsSetTitle().

Referenced by GetTitle().

bool CGBReference_Base::CanGetXref ( void  ) const [inline]

Check if it is safe to call GetXref method.

Returns:
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 688 of file GBReference_.hpp.

Get the Authors member data.

Returns:
Reference to the member data.

Definition at line 549 of file GBReference_.hpp.

References m_Authors.

Get the Consortium member data.

Returns:
Reference to the member data.

Definition at line 574 of file GBReference_.hpp.

References CanGetConsortium(), m_Consortium, and CSerialObject::ThrowUnassigned().

Get the Journal member data.

Returns:
Reference to the member data.

Definition at line 654 of file GBReference_.hpp.

References CanGetJournal(), m_Journal, and CSerialObject::ThrowUnassigned().

Get the Position member data.

Returns:
Reference to the member data.

Definition at line 509 of file GBReference_.hpp.

References CanGetPosition(), m_Position, and CSerialObject::ThrowUnassigned().

Get the Pubmed member data.

Returns:
Copy of the member data.

Definition at line 726 of file GBReference_.hpp.

References CanGetPubmed(), m_Pubmed, and CSerialObject::ThrowUnassigned().

Get the Reference member data.

Returns:
Reference to the member data.

Definition at line 469 of file GBReference_.hpp.

References CanGetReference(), m_Reference, and CSerialObject::ThrowUnassigned().

Get the Remark member data.

Returns:
Reference to the member data.

Definition at line 766 of file GBReference_.hpp.

References CanGetRemark(), m_Remark, and CSerialObject::ThrowUnassigned().

Get the Title member data.

Returns:
Reference to the member data.

Definition at line 614 of file GBReference_.hpp.

References CanGetTitle(), m_Title, and CSerialObject::ThrowUnassigned().

Get the Xref member data.

Returns:
Reference to the member data.

Definition at line 694 of file GBReference_.hpp.

References m_Xref.

bool CGBReference_Base::IsSetAuthors ( void  ) const [inline]

Check if a value has been assigned to Authors data member.

Data member Authors is optional; its type is defined as 'typedef list< CGBAuthor > TAuthors'

Returns:
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 537 of file GBReference_.hpp.

References m_set_State.

bool CGBReference_Base::IsSetConsortium ( void  ) const [inline]

Check if a value has been assigned to Consortium data member.

Data member Consortium is optional; its type is defined as 'typedef string TConsortium'

Returns:
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 562 of file GBReference_.hpp.

References m_set_State.

Referenced by CanGetConsortium(), and SetConsortium().

bool CGBReference_Base::IsSetJournal ( void  ) const [inline]

Check if a value has been assigned to Journal data member.

Data member Journal is mandatory; its type is defined as 'typedef string TJournal'

Returns:
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 642 of file GBReference_.hpp.

References m_set_State.

Referenced by CanGetJournal(), and SetJournal().

bool CGBReference_Base::IsSetPosition ( void  ) const [inline]

Check if a value has been assigned to Position data member.

Data member Position is optional; its type is defined as 'typedef string TPosition'

Returns:
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 497 of file GBReference_.hpp.

References m_set_State.

Referenced by CanGetPosition(), and SetPosition().

bool CGBReference_Base::IsSetPubmed ( void  ) const [inline]

Check if a value has been assigned to Pubmed data member.

Data member Pubmed is optional; its type is defined as 'typedef int TPubmed'

Returns:
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 707 of file GBReference_.hpp.

References m_set_State.

Referenced by CanGetPubmed(), and SetPubmed().

bool CGBReference_Base::IsSetReference ( void  ) const [inline]

Check if a value has been assigned to Reference data member.

Data member Reference is mandatory; its type is defined as 'typedef string TReference'

Returns:
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 457 of file GBReference_.hpp.

References m_set_State.

Referenced by CanGetReference(), and SetReference().

bool CGBReference_Base::IsSetRemark ( void  ) const [inline]

Check if a value has been assigned to Remark data member.

Data member Remark is optional; its type is defined as 'typedef string TRemark'

Returns:
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 754 of file GBReference_.hpp.

References m_set_State.

Referenced by CanGetRemark(), and SetRemark().

bool CGBReference_Base::IsSetTitle ( void  ) const [inline]

Check if a value has been assigned to Title data member.

Data member Title is optional; its type is defined as 'typedef string TTitle'

Returns:
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 602 of file GBReference_.hpp.

References m_set_State.

Referenced by CanGetTitle(), and SetTitle().

bool CGBReference_Base::IsSetXref ( void  ) const [inline]

Check if a value has been assigned to Xref data member.

Data member Xref is optional; its type is defined as 'typedef list< CRef< CGBXref > > TXref'

Returns:
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 682 of file GBReference_.hpp.

References m_set_State.

CGBReference_Base& CGBReference_Base::operator= ( const CGBReference_Base ) [private]
void CGBReference_Base::Reset ( void  ) [virtual]

Reset Authors data member.

Definition at line 63 of file GBReference_.cpp.

References m_Authors, and m_set_State.

Referenced by Reset().

Reset Consortium data member.

Definition at line 69 of file GBReference_.cpp.

References m_Consortium, and m_set_State.

Referenced by Reset().

Reset Journal data member.

Definition at line 81 of file GBReference_.cpp.

References m_Journal, and m_set_State.

Referenced by Reset().

Reset Position data member.

Definition at line 57 of file GBReference_.cpp.

References m_Position, and m_set_State.

Referenced by Reset().

void CGBReference_Base::ResetPubmed ( void  ) [inline]

Reset Pubmed data member.

Definition at line 719 of file GBReference_.hpp.

References m_Pubmed, and m_set_State.

Referenced by Reset().

Reset Reference data member.

Definition at line 51 of file GBReference_.cpp.

References m_Reference, and m_set_State.

Referenced by Reset().

Reset Remark data member.

Definition at line 93 of file GBReference_.cpp.

References m_Remark, and m_set_State.

Referenced by Reset().

Reset Title data member.

Definition at line 75 of file GBReference_.cpp.

References m_set_State, and m_Title.

Referenced by Reset().

Reset Xref data member.

Definition at line 87 of file GBReference_.cpp.

References m_set_State, and m_Xref.

Referenced by Reset().

Assign a value to Authors data member.

Returns:
Reference to the data value.

Definition at line 555 of file GBReference_.hpp.

References m_Authors, and m_set_State.

Referenced by CGBSeqFormatter::FormatReference().

Assign a value to Consortium data member.

Parameters:
valueValue to assign

Definition at line 583 of file GBReference_.hpp.

References m_Consortium, and m_set_State.

Referenced by CGBSeqFormatter::FormatReference().

Assign a value to Consortium data member.

Returns:
Reference to the data value.

Definition at line 590 of file GBReference_.hpp.

References IsSetConsortium(), m_Consortium, m_set_State, and CSerialObject::UnassignedString().

void CGBReference_Base::SetJournal ( const TJournal value) [inline]

Assign a value to Journal data member.

Parameters:
valueValue to assign

Definition at line 663 of file GBReference_.hpp.

References m_Journal, and m_set_State.

Referenced by CGBSeqFormatter::FormatReference().

Assign a value to Journal data member.

Returns:
Reference to the data value.

Definition at line 670 of file GBReference_.hpp.

References IsSetJournal(), m_Journal, m_set_State, and CSerialObject::UnassignedString().

void CGBReference_Base::SetPosition ( const TPosition value) [inline]

Assign a value to Position data member.

Parameters:
valueValue to assign

Definition at line 518 of file GBReference_.hpp.

References m_Position, and m_set_State.

Referenced by CGBSeqFormatter::FormatReference().

Assign a value to Position data member.

Returns:
Reference to the data value.

Definition at line 525 of file GBReference_.hpp.

References IsSetPosition(), m_Position, m_set_State, and CSerialObject::UnassignedString().

Assign a value to Pubmed data member.

Parameters:
valueValue to assign

Definition at line 735 of file GBReference_.hpp.

References m_Pubmed, and m_set_State.

Referenced by CGBSeqFormatter::FormatReference().

Assign a value to Pubmed data member.

Returns:
Reference to the data value.

Definition at line 742 of file GBReference_.hpp.

References IsSetPubmed(), m_Pubmed, m_set_State, and CSerialObject::UnassignedByte().

void CGBReference_Base::SetReference ( const TReference value) [inline]

Assign a value to Reference data member.

Parameters:
valueValue to assign

Definition at line 478 of file GBReference_.hpp.

References m_Reference, and m_set_State.

Referenced by CGBSeqFormatter::FormatReference().

Assign a value to Reference data member.

Returns:
Reference to the data value.

Definition at line 485 of file GBReference_.hpp.

References IsSetReference(), m_Reference, m_set_State, and CSerialObject::UnassignedString().

void CGBReference_Base::SetRemark ( const TRemark value) [inline]

Assign a value to Remark data member.

Parameters:
valueValue to assign

Definition at line 775 of file GBReference_.hpp.

References m_Remark, and m_set_State.

Referenced by CGBSeqFormatter::FormatReference().

Assign a value to Remark data member.

Returns:
Reference to the data value.

Definition at line 782 of file GBReference_.hpp.

References IsSetRemark(), m_Remark, m_set_State, and CSerialObject::UnassignedString().

void CGBReference_Base::SetTitle ( const TTitle value) [inline]

Assign a value to Title data member.

Parameters:
valueValue to assign

Definition at line 623 of file GBReference_.hpp.

References m_set_State, and m_Title.

Referenced by CGBSeqFormatter::FormatReference().

Assign a value to Title data member.

Returns:
Reference to the data value.

Definition at line 630 of file GBReference_.hpp.

References IsSetTitle(), m_set_State, m_Title, and CSerialObject::UnassignedString().

Assign a value to Xref data member.

Returns:
Reference to the data value.

Definition at line 700 of file GBReference_.hpp.

References m_set_State, and m_Xref.


Member Data Documentation

Definition at line 438 of file GBReference_.hpp.

Referenced by GetAuthors(), ResetAuthors(), and SetAuthors().

Definition at line 439 of file GBReference_.hpp.

Referenced by GetConsortium(), ResetConsortium(), and SetConsortium().

Definition at line 441 of file GBReference_.hpp.

Referenced by GetJournal(), ResetJournal(), and SetJournal().

Definition at line 437 of file GBReference_.hpp.

Referenced by GetPosition(), ResetPosition(), and SetPosition().

Definition at line 443 of file GBReference_.hpp.

Referenced by GetPubmed(), ResetPubmed(), and SetPubmed().

Definition at line 436 of file GBReference_.hpp.

Referenced by GetReference(), ResetReference(), and SetReference().

Definition at line 444 of file GBReference_.hpp.

Referenced by GetRemark(), ResetRemark(), and SetRemark().

Definition at line 440 of file GBReference_.hpp.

Referenced by GetTitle(), ResetTitle(), and SetTitle().

list< CRef< CGBXref > > CGBReference_Base::m_Xref [private]

Definition at line 442 of file GBReference_.hpp.

Referenced by GetXref(), ResetXref(), and SetXref().


The documentation for this class was generated from the following files:
Modified on Fri Sep 19 19:27:27 2014 by modify_doxy.py rev. 426318