NCBI C++ ToolKit
Public Member Functions | Private Types | Private Member Functions | List of all members

Search Toolkit Book for CPagination

CPagination –. More...

#include <objtools/eutils/efetch/Pagination.hpp>

+ Inheritance diagram for CPagination:
+ Collaboration diagram for CPagination:

Public Member Functions

 CPagination (void)
 
 ~CPagination (void)
 
- Public Member Functions inherited from CPagination_Base
 CPagination_Base (void)
 
virtual ~CPagination_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
virtual void Reset (void)
 Reset the whole object. More...
 
virtual void ResetSelection (void)
 Reset the selection (set it to e_not_set). More...
 
E_Choice Which (void) const
 Which variant is currently selected. More...
 
void CheckSelected (E_Choice index) const
 Verify selection, throw exception if it differs from the expected. More...
 
void ThrowInvalidSelection (E_Choice index) const
 Throw 'InvalidSelection' exception. More...
 
void Select (E_Choice index, NCBI_NS_NCBI::EResetVariant reset=NCBI_NS_NCBI::eDoResetVariant)
 Select the requested variant if needed. More...
 
void Select (E_Choice index, NCBI_NS_NCBI::EResetVariant reset, NCBI_NS_NCBI::CObjectMemoryPool *pool)
 Select the requested variant if needed, allocating CObject variants from memory pool. More...
 
bool IsSEM (void) const
 Check if variant SEM is selected. More...
 
const TSEMGetSEM (void) const
 Get the variant data. More...
 
TSEMSetSEM (void)
 Select the variant. More...
 
void SetSEM (TSEM &value)
 Select the variant and set its data. More...
 
bool IsMedlinePgn (void) const
 Check if variant MedlinePgn is selected. More...
 
const TMedlinePgnGetMedlinePgn (void) const
 Get the variant data. More...
 
TMedlinePgnSetMedlinePgn (void)
 Select the variant. More...
 
void SetMedlinePgn (TMedlinePgn &value)
 Select the variant and set its data. More...
 

Private Types

typedef CPagination_Base Tparent
 

Private Member Functions

 CPagination (const CPagination &value)
 
CPaginationoperator= (const CPagination &value)
 

Additional Inherited Members

- Public Types inherited from CPagination_Base
enum  E_Choice { e_not_set = 0 , e_SEM , e_MedlinePgn }
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 3 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef C_SEM TSEM
 
typedef CMedlinePgn TMedlinePgn
 
- Static Public Member Functions inherited from CPagination_Base
static NCBI_NS_STD::string SelectionName (E_Choice index)
 Retrieve selection name (for diagnostic purposes). More...
 

Detailed Description

CPagination –.

Definition at line 63 of file Pagination.hpp.


The documentation for this class was generated from the following files:
Modified on Wed May 22 11:30:05 2024 by modify_doxy.py rev. 669887