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

Search Toolkit Book for CText_Base

CText_Base –. More...

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

+ Inheritance diagram for CText_Base:
+ Collaboration diagram for CText_Base:

Public Types

enum  E_Choice {
  e_not_set = 0 , e_B , e_I , e_Sup ,
  e_Sub , e_U
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 6 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef CB TB
 
typedef CI TI
 
typedef CSup TSup
 
typedef CSub TSub
 
typedef CU TU
 

Public Member Functions

 CText_Base (void)
 
virtual ~CText_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 IsB (void) const
 Check if variant B is selected. More...
 
const TBGetB (void) const
 Get the variant data. More...
 
TBSetB (void)
 Select the variant. More...
 
void SetB (TB &value)
 Select the variant and set its data. More...
 
bool IsI (void) const
 Check if variant I is selected. More...
 
const TIGetI (void) const
 Get the variant data. More...
 
TISetI (void)
 Select the variant. More...
 
void SetI (TI &value)
 Select the variant and set its data. More...
 
bool IsSup (void) const
 Check if variant Sup is selected. More...
 
const TSupGetSup (void) const
 Get the variant data. More...
 
TSupSetSup (void)
 Select the variant. More...
 
void SetSup (TSup &value)
 Select the variant and set its data. More...
 
bool IsSub (void) const
 Check if variant Sub is selected. More...
 
const TSubGetSub (void) const
 Get the variant data. More...
 
TSubSetSub (void)
 Select the variant. More...
 
void SetSub (TSub &value)
 Select the variant and set its data. More...
 
bool IsU (void) const
 Check if variant U is selected. More...
 
const TUGetU (void) const
 Get the variant data. More...
 
TUSetU (void)
 Select the variant. More...
 
void SetU (TU &value)
 Select the variant and set its data. More...
 

Static Public Member Functions

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

Private Types

typedef NCBI_NS_NCBI::CSerialObject Tparent
 

Private Member Functions

 CText_Base (const CText_Base &)
 
CText_Baseoperator= (const CText_Base &)
 
void DoSelect (E_Choice index, NCBI_NS_NCBI::CObjectMemoryPool *pool=0)
 

Private Attributes

E_Choice m_choice
 
NCBI_NS_NCBI::CSerialObject * m_object
 

Static Private Attributes

static const char *const sm_SelectionNames []
 

Detailed Description

CText_Base –.

Definition at line 74 of file Text_.hpp.


The documentation for this class was generated from the following files:
Modified on Tue Apr 23 07:39:21 2024 by modify_doxy.py rev. 669887