CMla_request_Base Class Reference
[Code generated by DATATOOL from 'mla.asn' (module 'NCBI-MedArchive')]

Represents ASN.1 type Mla-request defined in file mla.asn

Search Toolkit Book for CMla_request_Base

#include <Mla_request_.hpp>

Inheritance diagram for CMla_request_Base:

Inheritance graph
[legend]
Collaboration diagram for CMla_request_Base:

Collaboration graph
[legend]
List of all members.

Detailed Description

requests

CMla_request_Base --

Definition at line 81 of file Mla_request_.hpp.

Public Types

typedef int TGetmle
typedef int TGetpub
typedef CTitle_msg TGettitle
typedef CPub TCitmatch
typedef int TGetmriuids
typedef CMedline_si TGetaccuids
typedef int TUidtopmid
typedef CPubMedId TPmidtouid
typedef CPubMedId TGetmlepmid
typedef CPubMedId TGetpubpmid
typedef CPub TCitmatchpmid
typedef int TGetmripmids
typedef CMedline_si TGetaccpmids
typedef CPub TCitlstpmids
typedef int TGetmleuid
typedef CPubMedId TGetmlrpmid
typedef int TGetmlruid
enum  E_Choice {
  e_not_set = 0, e_Init, e_Getmle, e_Getpub,
  e_Gettitle, e_Citmatch, e_Fini, e_Getmriuids,
  e_Getaccuids, e_Uidtopmid, e_Pmidtouid, e_Getmlepmid,
  e_Getpubpmid, e_Citmatchpmid, e_Getmripmids, e_Getaccpmids,
  e_Citlstpmids, e_Getmleuid, e_Getmlrpmid, e_Getmlruid
}
 Choice variants. More...
enum  E_ChoiceStopper { e_MaxChoice = 20 }
 Maximum+1 value of the choice variant enumerator. More...

Public Member Functions

 CMla_request_Base (void)
virtual ~CMla_request_Base (void)
 DECLARE_INTERNAL_TYPE_INFO ()
virtual void Reset (void)
 Reset the selection (set it to e_not_set).
E_Choice Which (void) const
 Which variant is currently selected.
void CheckSelected (E_Choice index) const
 Verify selection, throw exception if it differs from the expected.
void ThrowInvalidSelection (E_Choice index) const
 Throw 'InvalidSelection' exception.
void Select (E_Choice index, EResetVariant reset=eDoResetVariant)
 Select the requested variant if needed.
void Select (E_Choice index, EResetVariant reset, CObjectMemoryPool *pool)
 Select the requested variant if needed, allocating CObject variants from memory pool.
bool IsInit (void) const
 Check if variant Init is selected.
void SetInit (void)
 Select the variant.
bool IsGetmle (void) const
 Check if variant Getmle is selected.
TGetmle GetGetmle (void) const
 Get the variant data.
TGetmle & SetGetmle (void)
 Select the variant.
void SetGetmle (TGetmle value)
 Select the variant and set its data.
bool IsGetpub (void) const
 Check if variant Getpub is selected.
TGetpub GetGetpub (void) const
 Get the variant data.
TGetpub & SetGetpub (void)
 Select the variant.
void SetGetpub (TGetpub value)
 Select the variant and set its data.
bool IsGettitle (void) const
 Check if variant Gettitle is selected.
const TGettitle & GetGettitle (void) const
 Get the variant data.
TGettitle & SetGettitle (void)
 Select the variant.
void SetGettitle (TGettitle &value)
 Select the variant and set its data.
bool IsCitmatch (void) const
 Check if variant Citmatch is selected.
const TCitmatch & GetCitmatch (void) const
 Get the variant data.
TCitmatch & SetCitmatch (void)
 Select the variant.
void SetCitmatch (TCitmatch &value)
 Select the variant and set its data.
bool IsFini (void) const
 Check if variant Fini is selected.
void SetFini (void)
 Select the variant.
bool IsGetmriuids (void) const
 Check if variant Getmriuids is selected.
TGetmriuids GetGetmriuids (void) const
 Get the variant data.
TGetmriuids & SetGetmriuids (void)
 Select the variant.
void SetGetmriuids (TGetmriuids value)
 Select the variant and set its data.
bool IsGetaccuids (void) const
 Check if variant Getaccuids is selected.
const TGetaccuids & GetGetaccuids (void) const
 Get the variant data.
TGetaccuids & SetGetaccuids (void)
 Select the variant.
void SetGetaccuids (TGetaccuids &value)
 Select the variant and set its data.
bool IsUidtopmid (void) const
 Check if variant Uidtopmid is selected.
TUidtopmid GetUidtopmid (void) const
 Get the variant data.
TUidtopmid & SetUidtopmid (void)
 Select the variant.
void SetUidtopmid (TUidtopmid value)
 Select the variant and set its data.
bool IsPmidtouid (void) const
 Check if variant Pmidtouid is selected.
const TPmidtouid & GetPmidtouid (void) const
 Get the variant data.
TPmidtouid & SetPmidtouid (void)
 Select the variant.
void SetPmidtouid (const TPmidtouid &value)
 Select the variant and set its data.
bool IsGetmlepmid (void) const
 Check if variant Getmlepmid is selected.
const TGetmlepmid & GetGetmlepmid (void) const
 Get the variant data.
TGetmlepmid & SetGetmlepmid (void)
 Select the variant.
void SetGetmlepmid (const TGetmlepmid &value)
 Select the variant and set its data.
bool IsGetpubpmid (void) const
 Check if variant Getpubpmid is selected.
const TGetpubpmid & GetGetpubpmid (void) const
 Get the variant data.
TGetpubpmid & SetGetpubpmid (void)
 Select the variant.
void SetGetpubpmid (const TGetpubpmid &value)
 Select the variant and set its data.
bool IsCitmatchpmid (void) const
 Check if variant Citmatchpmid is selected.
const TCitmatchpmid & GetCitmatchpmid (void) const
 Get the variant data.
TCitmatchpmid & SetCitmatchpmid (void)
 Select the variant.
void SetCitmatchpmid (TCitmatchpmid &value)
 Select the variant and set its data.
bool IsGetmripmids (void) const
 Check if variant Getmripmids is selected.
TGetmripmids GetGetmripmids (void) const
 Get the variant data.
TGetmripmids & SetGetmripmids (void)
 Select the variant.
void SetGetmripmids (TGetmripmids value)
 Select the variant and set its data.
bool IsGetaccpmids (void) const
 Check if variant Getaccpmids is selected.
const TGetaccpmids & GetGetaccpmids (void) const
 Get the variant data.
TGetaccpmids & SetGetaccpmids (void)
 Select the variant.
void SetGetaccpmids (TGetaccpmids &value)
 Select the variant and set its data.
bool IsCitlstpmids (void) const
 Check if variant Citlstpmids is selected.
const TCitlstpmids & GetCitlstpmids (void) const
 Get the variant data.
TCitlstpmids & SetCitlstpmids (void)
 Select the variant.
void SetCitlstpmids (TCitlstpmids &value)
 Select the variant and set its data.
bool IsGetmleuid (void) const
 Check if variant Getmleuid is selected.
TGetmleuid GetGetmleuid (void) const
 Get the variant data.
TGetmleuid & SetGetmleuid (void)
 Select the variant.
void SetGetmleuid (TGetmleuid value)
 Select the variant and set its data.
bool IsGetmlrpmid (void) const
 Check if variant Getmlrpmid is selected.
const TGetmlrpmid & GetGetmlrpmid (void) const
 Get the variant data.
TGetmlrpmid & SetGetmlrpmid (void)
 Select the variant.
void SetGetmlrpmid (const TGetmlrpmid &value)
 Select the variant and set its data.
bool IsGetmlruid (void) const
 Check if variant Getmlruid is selected.
TGetmlruid GetGetmlruid (void) const
 Get the variant data.
TGetmlruid & SetGetmlruid (void)
 Select the variant.
void SetGetmlruid (TGetmlruid value)
 Select the variant and set its data.

Static Public Member Functions

static string SelectionName (E_Choice index)
 Retrieve selection name (for diagnostic purposes).

Private Types

typedef CSerialObject Tparent

Private Member Functions

 CMla_request_Base (const CMla_request_Base &)
CMla_request_Base & operator= (const CMla_request_Base &)
void DoSelect (E_Choice index, CObjectMemoryPool *pool=0)

Private Attributes

E_Choice m_choice
TGetmle m_Getmle
TGetpub m_Getpub
TGetmriuids m_Getmriuids
TUidtopmid m_Uidtopmid
NCBI_NS_NCBI::CUnionBuffer<
TPmidtouid > 		m_Pmidtouid
NCBI_NS_NCBI::CUnionBuffer<
TGetmlepmid > 		m_Getmlepmid
NCBI_NS_NCBI::CUnionBuffer<
TGetpubpmid > 		m_Getpubpmid
TGetmripmids m_Getmripmids
TGetmleuid m_Getmleuid
NCBI_NS_NCBI::CUnionBuffer<
TGetmlrpmid > 		m_Getmlrpmid
TGetmlruid m_Getmlruid
NCBI_NS_NCBI::CSerialObject * m_object

Static Private Attributes

static const char *const sm_SelectionNames []

Member Typedef Documentation

typedef CPub CMla_request_Base::TCitlstpmids
 

Definition at line 180 of file Mla_request_.hpp.

typedef CPub CMla_request_Base::TCitmatch
 

Definition at line 170 of file Mla_request_.hpp.

typedef CPub CMla_request_Base::TCitmatchpmid
 

Definition at line 177 of file Mla_request_.hpp.

typedef CMedline_si CMla_request_Base::TGetaccpmids
 

Definition at line 179 of file Mla_request_.hpp.

typedef CMedline_si CMla_request_Base::TGetaccuids
 

Definition at line 172 of file Mla_request_.hpp.

typedef int CMla_request_Base::TGetmle
 

Definition at line 167 of file Mla_request_.hpp.

typedef CPubMedId CMla_request_Base::TGetmlepmid
 

Definition at line 175 of file Mla_request_.hpp.

typedef int CMla_request_Base::TGetmleuid
 

Definition at line 181 of file Mla_request_.hpp.

typedef CPubMedId CMla_request_Base::TGetmlrpmid
 

Definition at line 182 of file Mla_request_.hpp.

typedef int CMla_request_Base::TGetmlruid
 

Definition at line 183 of file Mla_request_.hpp.

typedef int CMla_request_Base::TGetmripmids
 

Definition at line 178 of file Mla_request_.hpp.

typedef int CMla_request_Base::TGetmriuids
 

Definition at line 171 of file Mla_request_.hpp.

typedef int CMla_request_Base::TGetpub
 

Definition at line 168 of file Mla_request_.hpp.

typedef CPubMedId CMla_request_Base::TGetpubpmid
 

Definition at line 176 of file Mla_request_.hpp.

typedef CTitle_msg CMla_request_Base::TGettitle
 

Definition at line 169 of file Mla_request_.hpp.

typedef CSerialObject CMla_request_Base::Tparent [private]
 

Reimplemented in CMla_request.

Definition at line 83 of file Mla_request_.hpp.

typedef CPubMedId CMla_request_Base::TPmidtouid
 

Definition at line 174 of file Mla_request_.hpp.

typedef int CMla_request_Base::TUidtopmid
 

Definition at line 173 of file Mla_request_.hpp.

Member Enumeration Documentation

enum CMla_request_Base::E_Choice
 

Choice variants.

Enumerator:
e_not_set  No variant selected.
e_Init  DlInit.
e_Getmle  get MedlineEntry
e_Getpub  get citation by muid
e_Gettitle  match titles
e_Citmatch 
e_Fini  DlFini.
e_Getmriuids  Get MUIDs for an MRI.
e_Getaccuids  Get MUIDs for an Accessions.
e_Uidtopmid  get PMID for MUID
e_Pmidtouid  get MUID for PMID
e_Getmlepmid  get MedlineEntry by PubMed id
e_Getpubpmid  get citation by PubMed id
e_Citmatchpmid  citation match, PMID on out
e_Getmripmids  get PMIDs for an MRI
e_Getaccpmids  get PMIDs for an Accessions
e_Citlstpmids  generate list of PMID for Pub
e_Getmleuid  get MedlineEntry by Medline id
e_Getmlrpmid  get MedlarsEntry by PubMed id
e_Getmlruid  get MedlarsEntry by Medline id

Definition at line 95 of file Mla_request_.hpp.

enum CMla_request_Base::E_ChoiceStopper
 

Maximum+1 value of the choice variant enumerator.

Enumerator:
e_MaxChoice  == e_Getmlruid+1

Definition at line 118 of file Mla_request_.hpp.

Constructor & Destructor Documentation

END_CHOICE_INFO CMla_request_Base::CMla_request_Base (  void   ) 
 

Definition at line 360 of file Mla_request_.cpp.

CMla_request_Base::~CMla_request_Base (  void   )  [virtual]
 

Definition at line 366 of file Mla_request_.cpp.

References e_not_set, m_choice, and Reset().

CMla_request_Base::CMla_request_Base (  const CMla_request_Base &   )  [private]
 

Member Function Documentation

void CMla_request_Base::CheckSelected (  E_Choice  index  )  const [inline]
 

Verify selection, throw exception if it differs from the expected.

Parameters:
index Expected selection.

Definition at line 707 of file Mla_request_.hpp.

References m_choice, and ThrowInvalidSelection().

Referenced by GetCitlstpmids(), GetCitmatch(), GetCitmatchpmid(), GetGetaccpmids(), GetGetaccuids(), GetGetmle(), GetGetmlepmid(), GetGetmleuid(), GetGetmlrpmid(), GetGetmlruid(), GetGetmripmids(), GetGetmriuids(), GetGetpub(), GetGetpubpmid(), GetGettitle(), GetPmidtouid(), and GetUidtopmid().

CMla_request_Base::DECLARE_INTERNAL_TYPE_INFO (   ) 
 

void CMla_request_Base::DoSelect (  E_Choice  index,
CObjectMemoryPool *  pool = 0
)  [private]
 

const CMla_request_Base::TCitlstpmids & CMla_request_Base::GetCitlstpmids (  void   )  const
 

Get the variant data.

Returns:
Reference to the data.

Definition at line 303 of file Mla_request_.cpp.

References CheckSelected(), e_Citlstpmids, and m_object.

const CMla_request_Base::TCitmatch & CMla_request_Base::GetCitmatch (  void   )  const
 

Get the variant data.

Returns:
Reference to the data.

Definition at line 197 of file Mla_request_.cpp.

References CheckSelected(), e_Citmatch, and m_object.

const CMla_request_Base::TCitmatchpmid & CMla_request_Base::GetCitmatchpmid (  void   )  const
 

Get the variant data.

Returns:
Reference to the data.

Definition at line 259 of file Mla_request_.cpp.

References CheckSelected(), e_Citmatchpmid, and m_object.

const CMla_request_Base::TGetaccpmids & CMla_request_Base::GetGetaccpmids (  void   )  const
 

Get the variant data.

Returns:
Reference to the data.

Definition at line 281 of file Mla_request_.cpp.

References CheckSelected(), e_Getaccpmids, and m_object.

const CMla_request_Base::TGetaccuids & CMla_request_Base::GetGetaccuids (  void   )  const
 

Get the variant data.

Returns:
Reference to the data.

Definition at line 219 of file Mla_request_.cpp.

References CheckSelected(), e_Getaccuids, and m_object.

CMla_request_Base::TGetmle CMla_request_Base::GetGetmle (  void   )  const [inline]
 

Get the variant data.

Returns:
Copy of the variant data.

Definition at line 748 of file Mla_request_.hpp.

References CheckSelected(), e_Getmle, and m_Getmle.

const CMla_request_Base::TGetmlepmid & CMla_request_Base::GetGetmlepmid (  void   )  const [inline]
 

Get the variant data.

Returns:
Reference to the data.

Definition at line 906 of file Mla_request_.hpp.

References CheckSelected(), e_Getmlepmid, and m_Getmlepmid.

CMla_request_Base::TGetmleuid CMla_request_Base::GetGetmleuid (  void   )  const [inline]
 

Get the variant data.

Returns:
Copy of the variant data.

Definition at line 991 of file Mla_request_.hpp.

References CheckSelected(), e_Getmleuid, and m_Getmleuid.

const CMla_request_Base::TGetmlrpmid & CMla_request_Base::GetGetmlrpmid (  void   )  const [inline]
 

Get the variant data.

Returns:
Reference to the data.

Definition at line 1018 of file Mla_request_.hpp.

References CheckSelected(), e_Getmlrpmid, and m_Getmlrpmid.

CMla_request_Base::TGetmlruid CMla_request_Base::GetGetmlruid (  void   )  const [inline]
 

Get the variant data.

Returns:
Copy of the variant data.

Definition at line 1038 of file Mla_request_.hpp.

References CheckSelected(), e_Getmlruid, and m_Getmlruid.

CMla_request_Base::TGetmripmids CMla_request_Base::GetGetmripmids (  void   )  const [inline]
 

Get the variant data.

Returns:
Copy of the variant data.

Definition at line 952 of file Mla_request_.hpp.

References CheckSelected(), e_Getmripmids, and m_Getmripmids.

CMla_request_Base::TGetmriuids CMla_request_Base::GetGetmriuids (  void   )  const [inline]
 

Get the variant data.

Returns:
Copy of the variant data.

Definition at line 826 of file Mla_request_.hpp.

References CheckSelected(), e_Getmriuids, and m_Getmriuids.

CMla_request_Base::TGetpub CMla_request_Base::GetGetpub (  void   )  const [inline]
 

Get the variant data.

Returns:
Copy of the variant data.

Definition at line 775 of file Mla_request_.hpp.

References CheckSelected(), e_Getpub, and m_Getpub.

const CMla_request_Base::TGetpubpmid & CMla_request_Base::GetGetpubpmid (  void   )  const [inline]
 

Get the variant data.

Returns:
Reference to the data.

Definition at line 926 of file Mla_request_.hpp.

References CheckSelected(), e_Getpubpmid, and m_Getpubpmid.

const CMla_request_Base::TGettitle & CMla_request_Base::GetGettitle (  void   )  const
 

Get the variant data.

Returns:
Reference to the data.

Definition at line 175 of file Mla_request_.cpp.

References CheckSelected(), e_Gettitle, and m_object.

const CMla_request_Base::TPmidtouid & CMla_request_Base::GetPmidtouid (  void   )  const [inline]
 

Get the variant data.

Returns:
Reference to the data.

Definition at line 886 of file Mla_request_.hpp.

References CheckSelected(), e_Pmidtouid, and m_Pmidtouid.

CMla_request_Base::TUidtopmid CMla_request_Base::GetUidtopmid (  void   )  const [inline]
 

Get the variant data.

Returns:
Copy of the variant data.

Definition at line 859 of file Mla_request_.hpp.

References CheckSelected(), e_Uidtopmid, and m_Uidtopmid.

bool CMla_request_Base::IsCitlstpmids (  void   )  const [inline]
 

Check if variant Citlstpmids is selected.

Citlstpmids type is defined as 'typedef CPub TCitlstpmids'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 979 of file Mla_request_.hpp.

References e_Citlstpmids, and m_choice.

bool CMla_request_Base::IsCitmatch (  void   )  const [inline]
 

Check if variant Citmatch is selected.

Citmatch type is defined as 'typedef CPub TCitmatch'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 802 of file Mla_request_.hpp.

References e_Citmatch, and m_choice.

bool CMla_request_Base::IsCitmatchpmid (  void   )  const [inline]
 

Check if variant Citmatchpmid is selected.

Citmatchpmid type is defined as 'typedef CPub TCitmatchpmid'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 940 of file Mla_request_.hpp.

References e_Citmatchpmid, and m_choice.

bool CMla_request_Base::IsFini (  void   )  const [inline]
 

Check if variant Fini is selected.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 808 of file Mla_request_.hpp.

References e_Fini, and m_choice.

bool CMla_request_Base::IsGetaccpmids (  void   )  const [inline]
 

Check if variant Getaccpmids is selected.

Getaccpmids type is defined as 'typedef CMedline_si TGetaccpmids'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 973 of file Mla_request_.hpp.

References e_Getaccpmids, and m_choice.

bool CMla_request_Base::IsGetaccuids (  void   )  const [inline]
 

Check if variant Getaccuids is selected.

Getaccuids type is defined as 'typedef CMedline_si TGetaccuids'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 847 of file Mla_request_.hpp.

References e_Getaccuids, and m_choice.

bool CMla_request_Base::IsGetmle (  void   )  const [inline]
 

Check if variant Getmle is selected.

Getmle type is defined as 'typedef int TGetmle'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 742 of file Mla_request_.hpp.

References e_Getmle, and m_choice.

bool CMla_request_Base::IsGetmlepmid (  void   )  const [inline]
 

Check if variant Getmlepmid is selected.

Getmlepmid type is defined as 'typedef CPubMedId TGetmlepmid'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 900 of file Mla_request_.hpp.

References e_Getmlepmid, and m_choice.

bool CMla_request_Base::IsGetmleuid (  void   )  const [inline]
 

Check if variant Getmleuid is selected.

Getmleuid type is defined as 'typedef int TGetmleuid'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 985 of file Mla_request_.hpp.

References e_Getmleuid, and m_choice.

bool CMla_request_Base::IsGetmlrpmid (  void   )  const [inline]
 

Check if variant Getmlrpmid is selected.

Getmlrpmid type is defined as 'typedef CPubMedId TGetmlrpmid'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 1012 of file Mla_request_.hpp.

References e_Getmlrpmid, and m_choice.

bool CMla_request_Base::IsGetmlruid (  void   )  const [inline]
 

Check if variant Getmlruid is selected.

Getmlruid type is defined as 'typedef int TGetmlruid'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 1032 of file Mla_request_.hpp.

References e_Getmlruid, and m_choice.

bool CMla_request_Base::IsGetmripmids (  void   )  const [inline]
 

Check if variant Getmripmids is selected.

Getmripmids type is defined as 'typedef int TGetmripmids'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 946 of file Mla_request_.hpp.

References e_Getmripmids, and m_choice.

bool CMla_request_Base::IsGetmriuids (  void   )  const [inline]
 

Check if variant Getmriuids is selected.

Getmriuids type is defined as 'typedef int TGetmriuids'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 820 of file Mla_request_.hpp.

References e_Getmriuids, and m_choice.

bool CMla_request_Base::IsGetpub (  void   )  const [inline]
 

Check if variant Getpub is selected.

Getpub type is defined as 'typedef int TGetpub'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 769 of file Mla_request_.hpp.

References e_Getpub, and m_choice.

bool CMla_request_Base::IsGetpubpmid (  void   )  const [inline]
 

Check if variant Getpubpmid is selected.

Getpubpmid type is defined as 'typedef CPubMedId TGetpubpmid'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 920 of file Mla_request_.hpp.

References e_Getpubpmid, and m_choice.

bool CMla_request_Base::IsGettitle (  void   )  const [inline]
 

Check if variant Gettitle is selected.

Gettitle type is defined as 'typedef CTitle_msg TGettitle'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 796 of file Mla_request_.hpp.

References e_Gettitle, and m_choice.

bool CMla_request_Base::IsInit (  void   )  const [inline]
 

Check if variant Init is selected.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 730 of file Mla_request_.hpp.

References e_Init, and m_choice.

bool CMla_request_Base::IsPmidtouid (  void   )  const [inline]
 

Check if variant Pmidtouid is selected.

Pmidtouid type is defined as 'typedef CPubMedId TPmidtouid'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 880 of file Mla_request_.hpp.

References e_Pmidtouid, and m_choice.

bool CMla_request_Base::IsUidtopmid (  void   )  const [inline]
 

Check if variant Uidtopmid is selected.

Uidtopmid type is defined as 'typedef int TUidtopmid'.

Returns:
  • true, if the variant is selected.
  • false, otherwise.

Definition at line 853 of file Mla_request_.hpp.

References e_Uidtopmid, and m_choice.

CMla_request_Base& CMla_request_Base::operator= (  const CMla_request_Base &   )  [private]
 

void CMla_request_Base::Reset (  void   )  [virtual]
 

Reset the selection (set it to e_not_set).

Definition at line 53 of file Mla_request_.cpp.

References e_Citlstpmids, e_Citmatch, e_Citmatchpmid, e_Getaccpmids, e_Getaccuids, e_Getmlepmid, e_Getmlrpmid, e_Getpubpmid, e_Gettitle, e_not_set, e_Pmidtouid, m_choice, m_Getmlepmid, m_Getmlrpmid, m_Getpubpmid, m_object, and m_Pmidtouid.

Referenced by SetCitlstpmids(), SetCitmatch(), SetCitmatchpmid(), SetGetaccpmids(), SetGetaccuids(), SetGettitle(), and ~CMla_request_Base().

void CMla_request_Base::Select (  E_Choice  index,
EResetVariant  reset,
CObjectMemoryPool *  pool
) 
 

Select the requested variant if needed, allocating CObject variants from memory pool.

void CMla_request_Base::Select (  E_Choice  index,
EResetVariant  reset = eDoResetVariant
) 
 

Select the requested variant if needed.

Parameters:
index New selection state.
reset Flag that defines the resetting of the variant data. The data will be reset if either the current selection differs from the new one, or the flag is set to eDoResetVariant.

Referenced by SetCitlstpmids(), SetCitmatch(), SetCitmatchpmid(), SetFini(), SetGetaccpmids(), SetGetaccuids(), SetGetmle(), SetGetmlepmid(), SetGetmleuid(), SetGetmlrpmid(), SetGetmlruid(), SetGetmripmids(), SetGetmriuids(), SetGetpub(), SetGetpubpmid(), SetGettitle(), SetInit(), SetPmidtouid(), and SetUidtopmid().

NCBI_NS_STD::string CMla_request_Base::SelectionName (  E_Choice  index  )  [static]
 

Retrieve selection name (for diagnostic purposes).

Parameters:
index One of possible selection states.
Returns:
Name string.

Definition at line 165 of file Mla_request_.cpp.

References sm_SelectionNames.

void CMla_request_Base::SetCitlstpmids (  TCitlstpmids &  value  ) 
 

Select the variant and set its data.

Parameters:
value Reference to the data.

Definition at line 315 of file Mla_request_.cpp.

References CObject::AddReference(), e_Citlstpmids, m_choice, m_object, and Reset().

CMla_request_Base::TCitlstpmids & CMla_request_Base::SetCitlstpmids (  void   ) 
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 309 of file Mla_request_.cpp.

References e_Citlstpmids, eDoNotResetVariant, m_object, and Select().

Referenced by CMLAClient_Base::AskCitlstpmids().

void CMla_request_Base::SetCitmatch (  TCitmatch &  value  ) 
 

Select the variant and set its data.

Parameters:
value Reference to the data.

Definition at line 209 of file Mla_request_.cpp.

References CObject::AddReference(), e_Citmatch, m_choice, m_object, and Reset().

CMla_request_Base::TCitmatch & CMla_request_Base::SetCitmatch (  void   ) 
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 203 of file Mla_request_.cpp.

References e_Citmatch, eDoNotResetVariant, m_object, and Select().

Referenced by CMLAClient_Base::AskCitmatch().

void CMla_request_Base::SetCitmatchpmid (  TCitmatchpmid &  value  ) 
 

Select the variant and set its data.

Parameters:
value Reference to the data.

Definition at line 271 of file Mla_request_.cpp.

References CObject::AddReference(), e_Citmatchpmid, m_choice, m_object, and Reset().

CMla_request_Base::TCitmatchpmid & CMla_request_Base::SetCitmatchpmid (  void   ) 
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 265 of file Mla_request_.cpp.

References e_Citmatchpmid, eDoNotResetVariant, m_object, and Select().

Referenced by CMLAClient_Base::AskCitmatchpmid().

void CMla_request_Base::SetFini (  void   )  [inline]
 

Select the variant.

Definition at line 814 of file Mla_request_.hpp.

References e_Fini, eDoNotResetVariant, and Select().

Referenced by CMLAClient_Base::AskFini().

void CMla_request_Base::SetGetaccpmids (  TGetaccpmids &  value  ) 
 

Select the variant and set its data.

Parameters:
value Reference to the data.

Definition at line 293 of file Mla_request_.cpp.

References CObject::AddReference(), e_Getaccpmids, m_choice, m_object, and Reset().

CMla_request_Base::TGetaccpmids & CMla_request_Base::SetGetaccpmids (  void   ) 
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 287 of file Mla_request_.cpp.

References e_Getaccpmids, eDoNotResetVariant, m_object, and Select().

Referenced by CMLAClient_Base::AskGetaccpmids().

void CMla_request_Base::SetGetaccuids (  TGetaccuids &  value  ) 
 

Select the variant and set its data.

Parameters:
value Reference to the data.

Definition at line 231 of file Mla_request_.cpp.

References CObject::AddReference(), e_Getaccuids, m_choice, m_object, and Reset().

CMla_request_Base::TGetaccuids & CMla_request_Base::SetGetaccuids (  void   ) 
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 225 of file Mla_request_.cpp.

References e_Getaccuids, eDoNotResetVariant, m_object, and Select().

Referenced by CMLAClient_Base::AskGetaccuids().

void CMla_request_Base::SetGetmle (  TGetmle  value  )  [inline]
 

Select the variant and set its data.

Parameters:
value Variant data.

Definition at line 762 of file Mla_request_.hpp.

References e_Getmle, eDoNotResetVariant, m_Getmle, and Select().

CMla_request_Base::TGetmle & CMla_request_Base::SetGetmle (  void   )  [inline]
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 755 of file Mla_request_.hpp.

References e_Getmle, eDoNotResetVariant, m_Getmle, and Select().

Referenced by CMLAClient_Base::AskGetmle().

void CMla_request_Base::SetGetmlepmid (  const TGetmlepmid &  value  ) 
 

Select the variant and set its data.

Parameters:
value Variant data.

Definition at line 247 of file Mla_request_.cpp.

References e_Getmlepmid, eDoNotResetVariant, m_Getmlepmid, and Select().

CMla_request_Base::TGetmlepmid & CMla_request_Base::SetGetmlepmid (  void   )  [inline]
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 913 of file Mla_request_.hpp.

References e_Getmlepmid, eDoNotResetVariant, m_Getmlepmid, and Select().

Referenced by CMLAClient_Base::AskGetmlepmid().

void CMla_request_Base::SetGetmleuid (  TGetmleuid  value  )  [inline]
 

Select the variant and set its data.

Parameters:
value Variant data.

Definition at line 1005 of file Mla_request_.hpp.

References e_Getmleuid, eDoNotResetVariant, m_Getmleuid, and Select().

CMla_request_Base::TGetmleuid & CMla_request_Base::SetGetmleuid (  void   )  [inline]
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 998 of file Mla_request_.hpp.

References e_Getmleuid, eDoNotResetVariant, m_Getmleuid, and Select().

Referenced by CMLAClient_Base::AskGetmleuid().

void CMla_request_Base::SetGetmlrpmid (  const TGetmlrpmid &  value  ) 
 

Select the variant and set its data.

Parameters:
value Variant data.

Definition at line 325 of file Mla_request_.cpp.

References e_Getmlrpmid, eDoNotResetVariant, m_Getmlrpmid, and Select().

CMla_request_Base::TGetmlrpmid & CMla_request_Base::SetGetmlrpmid (  void   )  [inline]
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 1025 of file Mla_request_.hpp.

References e_Getmlrpmid, eDoNotResetVariant, m_Getmlrpmid, and Select().

Referenced by CMLAClient_Base::AskGetmlrpmid().

void CMla_request_Base::SetGetmlruid (  TGetmlruid  value  )  [inline]
 

Select the variant and set its data.

Parameters:
value Variant data.

Definition at line 1052 of file Mla_request_.hpp.

References e_Getmlruid, eDoNotResetVariant, m_Getmlruid, and Select().

CMla_request_Base::TGetmlruid & CMla_request_Base::SetGetmlruid (  void   )  [inline]
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 1045 of file Mla_request_.hpp.

References e_Getmlruid, eDoNotResetVariant, m_Getmlruid, and Select().

Referenced by CMLAClient_Base::AskGetmlruid().

void CMla_request_Base::SetGetmripmids (  TGetmripmids  value  )  [inline]
 

Select the variant and set its data.

Parameters:
value Variant data.

Definition at line 966 of file Mla_request_.hpp.

References e_Getmripmids, eDoNotResetVariant, m_Getmripmids, and Select().

CMla_request_Base::TGetmripmids & CMla_request_Base::SetGetmripmids (  void   )  [inline]
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 959 of file Mla_request_.hpp.

References e_Getmripmids, eDoNotResetVariant, m_Getmripmids, and Select().

Referenced by CMLAClient_Base::AskGetmripmids().

void CMla_request_Base::SetGetmriuids (  TGetmriuids  value  )  [inline]
 

Select the variant and set its data.

Parameters:
value Variant data.

Definition at line 840 of file Mla_request_.hpp.

References e_Getmriuids, eDoNotResetVariant, m_Getmriuids, and Select().

CMla_request_Base::TGetmriuids & CMla_request_Base::SetGetmriuids (  void   )  [inline]
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 833 of file Mla_request_.hpp.

References e_Getmriuids, eDoNotResetVariant, m_Getmriuids, and Select().

Referenced by CMLAClient_Base::AskGetmriuids().

void CMla_request_Base::SetGetpub (  TGetpub  value  )  [inline]
 

Select the variant and set its data.

Parameters:
value Variant data.

Definition at line 789 of file Mla_request_.hpp.

References e_Getpub, eDoNotResetVariant, m_Getpub, and Select().

CMla_request_Base::TGetpub & CMla_request_Base::SetGetpub (  void   )  [inline]
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 782 of file Mla_request_.hpp.

References e_Getpub, eDoNotResetVariant, m_Getpub, and Select().

Referenced by CMLAClient_Base::AskGetpub().

void CMla_request_Base::SetGetpubpmid (  const TGetpubpmid &  value  ) 
 

Select the variant and set its data.

Parameters:
value Variant data.

Definition at line 253 of file Mla_request_.cpp.

References e_Getpubpmid, eDoNotResetVariant, m_Getpubpmid, and Select().

CMla_request_Base::TGetpubpmid & CMla_request_Base::SetGetpubpmid (  void   )  [inline]
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 933 of file Mla_request_.hpp.

References e_Getpubpmid, eDoNotResetVariant, m_Getpubpmid, and Select().

Referenced by CMLAClient_Base::AskGetpubpmid().

void CMla_request_Base::SetGettitle (  TGettitle &  value  ) 
 

Select the variant and set its data.

Parameters:
value Reference to the data.

Definition at line 187 of file Mla_request_.cpp.

References CObject::AddReference(), e_Gettitle, m_choice, m_object, and Reset().

CMla_request_Base::TGettitle & CMla_request_Base::SetGettitle (  void   ) 
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 181 of file Mla_request_.cpp.

References e_Gettitle, eDoNotResetVariant, m_object, and Select().

Referenced by CMLAClient_Base::AskGettitle().

void CMla_request_Base::SetInit (  void   )  [inline]
 

Select the variant.

Definition at line 736 of file Mla_request_.hpp.

References e_Init, eDoNotResetVariant, and Select().

Referenced by CMLAClient_Base::AskInit().

void CMla_request_Base::SetPmidtouid (  const TPmidtouid &  value  ) 
 

Select the variant and set its data.

Parameters:
value Variant data.

Definition at line 241 of file Mla_request_.cpp.

References e_Pmidtouid, eDoNotResetVariant, m_Pmidtouid, and Select().

CMla_request_Base::TPmidtouid & CMla_request_Base::SetPmidtouid (  void   )  [inline]
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 893 of file Mla_request_.hpp.

References e_Pmidtouid, eDoNotResetVariant, m_Pmidtouid, and Select().

Referenced by CMLAClient_Base::AskPmidtouid().

void CMla_request_Base::SetUidtopmid (  TUidtopmid  value  )  [inline]
 

Select the variant and set its data.

Parameters:
value Variant data.

Definition at line 873 of file Mla_request_.hpp.

References e_Uidtopmid, eDoNotResetVariant, m_Uidtopmid, and Select().

CMla_request_Base::TUidtopmid & CMla_request_Base::SetUidtopmid (  void   )  [inline]
 

Select the variant.

Returns:
Reference to the variant data.

Definition at line 866 of file Mla_request_.hpp.

References e_Uidtopmid, eDoNotResetVariant, m_Uidtopmid, and Select().

Referenced by CMLAClient_Base::AskUidtopmid().

void CMla_request_Base::ThrowInvalidSelection (  E_Choice  index  )  const
 

Throw 'InvalidSelection' exception.

Parameters:
index Expected selection.

Definition at line 170 of file Mla_request_.cpp.

References DIAG_COMPILE_INFO, m_choice, and sm_SelectionNames.

Referenced by CheckSelected().

CMla_request_Base::E_Choice CMla_request_Base::Which (  void   )  const [inline]
 

Which variant is currently selected.

Returns:
Choice state enumerator.

Definition at line 701 of file Mla_request_.hpp.

References m_choice.

Member Data Documentation

E_Choice CMla_request_Base::m_choice [private]
 

Definition at line 669 of file Mla_request_.hpp.

Referenced by CheckSelected(), IsCitlstpmids(), IsCitmatch(), IsCitmatchpmid(), IsFini(), IsGetaccpmids(), IsGetaccuids(), IsGetmle(), IsGetmlepmid(), IsGetmleuid(), IsGetmlrpmid(), IsGetmlruid(), IsGetmripmids(), IsGetmriuids(), IsGetpub(), IsGetpubpmid(), IsGettitle(), IsInit(), IsPmidtouid(), IsUidtopmid(), Reset(), SetCitlstpmids(), SetCitmatch(), SetCitmatchpmid(), SetGetaccpmids(), SetGetaccuids(), SetGettitle(), ThrowInvalidSelection(), Which(), and ~CMla_request_Base().

TGetmle CMla_request_Base::m_Getmle [private]
 

Definition at line 676 of file Mla_request_.hpp.

Referenced by GetGetmle(), and SetGetmle().

NCBI_NS_NCBI::CUnionBuffer<TGetmlepmid> CMla_request_Base::m_Getmlepmid [private]
 

Definition at line 681 of file Mla_request_.hpp.

Referenced by GetGetmlepmid(), Reset(), and SetGetmlepmid().

TGetmleuid CMla_request_Base::m_Getmleuid [private]
 

Definition at line 684 of file Mla_request_.hpp.

Referenced by GetGetmleuid(), and SetGetmleuid().

NCBI_NS_NCBI::CUnionBuffer<TGetmlrpmid> CMla_request_Base::m_Getmlrpmid [private]
 

Definition at line 685 of file Mla_request_.hpp.

Referenced by GetGetmlrpmid(), Reset(), and SetGetmlrpmid().

TGetmlruid CMla_request_Base::m_Getmlruid [private]
 

Definition at line 686 of file Mla_request_.hpp.

Referenced by GetGetmlruid(), and SetGetmlruid().

TGetmripmids CMla_request_Base::m_Getmripmids [private]
 

Definition at line 683 of file Mla_request_.hpp.

Referenced by GetGetmripmids(), and SetGetmripmids().

TGetmriuids CMla_request_Base::m_Getmriuids [private]
 

Definition at line 678 of file Mla_request_.hpp.

Referenced by GetGetmriuids(), and SetGetmriuids().

TGetpub CMla_request_Base::m_Getpub [private]
 

Definition at line 677 of file Mla_request_.hpp.

Referenced by GetGetpub(), and SetGetpub().

NCBI_NS_NCBI::CUnionBuffer<TGetpubpmid> CMla_request_Base::m_Getpubpmid [private]
 

Definition at line 682 of file Mla_request_.hpp.

Referenced by GetGetpubpmid(), Reset(), and SetGetpubpmid().

NCBI_NS_NCBI::CSerialObject* CMla_request_Base::m_object [private]
 

Definition at line 687 of file Mla_request_.hpp.

Referenced by GetCitlstpmids(), GetCitmatch(), GetCitmatchpmid(), GetGetaccpmids(), GetGetaccuids(), GetGettitle(), Reset(), SetCitlstpmids(), SetCitmatch(), SetCitmatchpmid(), SetGetaccpmids(), SetGetaccuids(), and SetGettitle().

NCBI_NS_NCBI::CUnionBuffer<TPmidtouid> CMla_request_Base::m_Pmidtouid [private]
 

Definition at line 680 of file Mla_request_.hpp.

Referenced by GetPmidtouid(), Reset(), and SetPmidtouid().

TUidtopmid CMla_request_Base::m_Uidtopmid [private]
 

Definition at line 679 of file Mla_request_.hpp.

Referenced by GetUidtopmid(), and SetUidtopmid().

const char *const CMla_request_Base::sm_SelectionNames [static, private]
 

Initial value:

 {
    "not set",
    "init",
    "getmle",
    "getpub",
    "gettitle",
    "citmatch",
    "fini",
    "getmriuids",
    "getaccuids",
    "uidtopmid",
    "pmidtouid",
    "getmlepmid",
    "getpubpmid",
    "citmatchpmid",
    "getmripmids",
    "getaccpmids",
    "citlstpmids",
    "getmleuid",
    "getmlrpmid",
    "getmlruid"
}

Definition at line 673 of file Mla_request_.hpp.

Referenced by SelectionName(), and ThrowInvalidSelection().

The documentation for this class was generated from the following files:
Generated on Mon Dec 7 12:55:47 2009 for NCBI C++ ToolKit by  doxygen 1.4.6
Modified on Mon Dec 07 16:23:28 2009 by modify_doxy.py rev. 173732