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 CTitle_Base::C_E

C_E –. More...

#include <objects/biblio/Title_.hpp>

+ Inheritance diagram for CTitle_Base::C_E:
+ Collaboration diagram for CTitle_Base::C_E:

Public Types

enum  E_Choice {
  e_not_set = 0 , e_Name , e_Tsub , e_Trans ,
  e_Jta , e_Iso_jta , e_Ml_jta , e_Coden ,
  e_Issn , e_Abr , e_Isbn
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 11 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef string TName
 
typedef string TTsub
 
typedef string TTrans
 
typedef string TJta
 
typedef string TIso_jta
 
typedef string TMl_jta
 
typedef string TCoden
 
typedef string TIssn
 
typedef string TAbr
 
typedef string TIsbn
 
- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

 C_E (void)
 
 ~C_E (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
void Reset (void)
 Reset the whole object. More...
 
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, EResetVariant reset=eDoResetVariant)
 Select the requested variant if needed. More...
 
void Select (E_Choice index, EResetVariant reset, CObjectMemoryPool *pool)
 Select the requested variant if needed, allocating CObject variants from memory pool. More...
 
bool IsName (void) const
 Check if variant Name is selected. More...
 
const TNameGetName (void) const
 Get the variant data. More...
 
TNameSetName (void)
 Select the variant. More...
 
void SetName (const TName &value)
 Select the variant and set its data. More...
 
bool IsTsub (void) const
 Check if variant Tsub is selected. More...
 
const TTsubGetTsub (void) const
 Get the variant data. More...
 
TTsubSetTsub (void)
 Select the variant. More...
 
void SetTsub (const TTsub &value)
 Select the variant and set its data. More...
 
bool IsTrans (void) const
 Check if variant Trans is selected. More...
 
const TTransGetTrans (void) const
 Get the variant data. More...
 
TTransSetTrans (void)
 Select the variant. More...
 
void SetTrans (const TTrans &value)
 Select the variant and set its data. More...
 
bool IsJta (void) const
 Check if variant Jta is selected. More...
 
const TJtaGetJta (void) const
 Get the variant data. More...
 
TJtaSetJta (void)
 Select the variant. More...
 
void SetJta (const TJta &value)
 Select the variant and set its data. More...
 
bool IsIso_jta (void) const
 Check if variant Iso_jta is selected. More...
 
const TIso_jtaGetIso_jta (void) const
 Get the variant data. More...
 
TIso_jtaSetIso_jta (void)
 Select the variant. More...
 
void SetIso_jta (const TIso_jta &value)
 Select the variant and set its data. More...
 
bool IsMl_jta (void) const
 Check if variant Ml_jta is selected. More...
 
const TMl_jtaGetMl_jta (void) const
 Get the variant data. More...
 
TMl_jtaSetMl_jta (void)
 Select the variant. More...
 
void SetMl_jta (const TMl_jta &value)
 Select the variant and set its data. More...
 
bool IsCoden (void) const
 Check if variant Coden is selected. More...
 
const TCodenGetCoden (void) const
 Get the variant data. More...
 
TCodenSetCoden (void)
 Select the variant. More...
 
void SetCoden (const TCoden &value)
 Select the variant and set its data. More...
 
bool IsIssn (void) const
 Check if variant Issn is selected. More...
 
const TIssnGetIssn (void) const
 Get the variant data. More...
 
TIssnSetIssn (void)
 Select the variant. More...
 
void SetIssn (const TIssn &value)
 Select the variant and set its data. More...
 
bool IsAbr (void) const
 Check if variant Abr is selected. More...
 
const TAbrGetAbr (void) const
 Get the variant data. More...
 
TAbrSetAbr (void)
 Select the variant. More...
 
void SetAbr (const TAbr &value)
 Select the variant and set its data. More...
 
bool IsIsbn (void) const
 Check if variant Isbn is selected. More...
 
const TIsbnGetIsbn (void) const
 Get the variant data. More...
 
TIsbnSetIsbn (void)
 Select the variant. More...
 
void SetIsbn (const TIsbn &value)
 Select the variant and set its data. More...
 
- Public Member Functions inherited from CSerialObject
 CSerialObject (void)
 
virtual ~CSerialObject (void)
 
virtual const CTypeInfoGetThisTypeInfo (void) const =0
 
virtual void Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive)
 Set object to copy of another one. More...
 
virtual bool Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const
 Check if both objects contain the same values. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
void ThrowUnassigned (TMemberIndex index) const
 
void ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const
 
bool HasNamespaceName (void) const
 Check if object data type has namespace name. More...
 
const stringGetNamespaceName (void) const
 Get namespace name. More...
 
bool HasNamespacePrefix (void) const
 Check if data type has namespace prefix. More...
 
const stringGetNamespacePrefix (void) const
 Get namespace prefix. More...
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 

Static Public Member Functions

static string SelectionName (E_Choice index)
 Retrieve selection name (for diagnostic purposes). More...
 
- Static Public Member Functions inherited from CSerialObject
static void SetVerifyDataThread (ESerialVerifyData verify)
 
static void SetVerifyDataGlobal (ESerialVerifyData verify)
 
static string UnassignedString (void)
 
static CStringUTF8 UnassignedStringUTF8 (void)
 
static char UnassignedByte (void)
 
- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 

Private Types

typedef CSerialObject Tparent
 

Private Member Functions

 C_E (const C_E &)
 
C_Eoperator= (const C_E &)
 
void DoSelect (E_Choice index, CObjectMemoryPool *pool=0)
 

Private Attributes

E_Choice m_choice
 
union {
   NCBI_NS_NCBI::CUnionBuffer< NCBI_NS_STD::string >   CTitle_Base::C_E::m_string
 
   void *   CTitle_Base::C_E::m_dummy_pointer_for_alignment
 
}; 
 

Static Private Attributes

static const char *const sm_SelectionNames []
 

Additional Inherited Members

- Static Public Attributes inherited from CSerialObject
static const char * ms_UnassignedStr = "<*unassigned*>"
 
static const char ms_UnassignedByte = char(0xcd)
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

C_E –.

Definition at line 95 of file Title_.hpp.


The documentation for this class was generated from the following files:
Modified on Fri Dec 08 08:22:03 2023 by modify_doxy.py rev. 669887