NCBI C++ ToolKit
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | List of all members
CFeat_qual_choice Class Reference

Search Toolkit Book for CFeat_qual_choice

#include <objects/macro/Feat_qual_choice.hpp>

+ Inheritance diagram for CFeat_qual_choice:
+ Collaboration diagram for CFeat_qual_choice:

Public Member Functions

 CFeat_qual_choice (void)
 
 ~CFeat_qual_choice (void)
 
- Public Member Functions inherited from CFeat_qual_choice_Base
 CFeat_qual_choice_Base (void)
 
virtual ~CFeat_qual_choice_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, 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 IsLegal_qual (void) const
 Check if variant Legal_qual is selected. More...
 
TLegal_qual GetLegal_qual (void) const
 Get the variant data. More...
 
TLegal_qualSetLegal_qual (void)
 Select the variant. More...
 
void SetLegal_qual (TLegal_qual value)
 Select the variant and set its data. More...
 
bool IsIllegal_qual (void) const
 Check if variant Illegal_qual is selected. More...
 
const TIllegal_qualGetIllegal_qual (void) const
 Get the variant data. More...
 
TIllegal_qualSetIllegal_qual (void)
 Select the variant. More...
 
void SetIllegal_qual (TIllegal_qual &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 GetFirstStringMatch (const list< string > &strs, const CString_constraint &str_cons)
 
static string GetFirstStringMatch (const vector< string > &strs, const CString_constraint &str_cons)
 
- Static Public Member Functions inherited from CFeat_qual_choice_Base
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 CFeat_qual_choice_Base Tparent
 

Private Member Functions

 CFeat_qual_choice (const CFeat_qual_choice &value)
 
CFeat_qual_choiceoperator= (const CFeat_qual_choice &value)
 
string x_GetLegalQualName (vector< EFeat_qual_legal > &v_qual, EFeat_qual_legal qual) const
 
void x_GetTwoFieldSubfield (string &str, int subfield) const
 
string x_GetFirstGBQualMatch (const vector< CRef< CGb_qual > > &quals, const string &qual_name, int subfield, const CString_constraint &str_cons) const
 
string x_GetFirstGBQualMatchConstraintName (const CSeq_feat &feat, const CString_constraint &str_cons) const
 

Additional Inherited Members

- Public Types inherited from CFeat_qual_choice_Base
enum  E_Choice { e_not_set = 0 , e_Legal_qual , e_Illegal_qual }
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 3 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef EFeat_qual_legal TLegal_qual
 
typedef CString_constraint TIllegal_qual
 
- 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...
 
- 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

Definition at line 57 of file Feat_qual_choice.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 59 of file Feat_qual_choice.hpp.

Constructor & Destructor Documentation

◆ CFeat_qual_choice() [1/2]

CFeat_qual_choice::CFeat_qual_choice ( void  )
inline

Definition at line 90 of file Feat_qual_choice.hpp.

◆ ~CFeat_qual_choice()

CFeat_qual_choice::~CFeat_qual_choice ( void  )

Definition at line 50 of file Feat_qual_choice.cpp.

◆ CFeat_qual_choice() [2/2]

CFeat_qual_choice::CFeat_qual_choice ( const CFeat_qual_choice value)
private

Member Function Documentation

◆ GetFirstStringMatch() [1/2]

string CFeat_qual_choice::GetFirstStringMatch ( const list< string > &  strs,
const CString_constraint str_cons 
)
static

Definition at line 120 of file Feat_qual_choice.cpp.

References ITERATE, kEmptyStr, and CString_constraint::Match().

◆ GetFirstStringMatch() [2/2]

string CFeat_qual_choice::GetFirstStringMatch ( const vector< string > &  strs,
const CString_constraint str_cons 
)
static

Definition at line 130 of file Feat_qual_choice.cpp.

References ITERATE, kEmptyStr, and CString_constraint::Match().

◆ operator=()

CFeat_qual_choice& CFeat_qual_choice::operator= ( const CFeat_qual_choice value)
private

◆ x_GetFirstGBQualMatch()

string CFeat_qual_choice::x_GetFirstGBQualMatch ( const vector< CRef< CGb_qual > > &  quals,
const string qual_name,
int  subfield,
const CString_constraint str_cons 
) const
private

◆ x_GetFirstGBQualMatchConstraintName()

string CFeat_qual_choice::x_GetFirstGBQualMatchConstraintName ( const CSeq_feat feat,
const CString_constraint str_cons 
) const
private

◆ x_GetLegalQualName()

string CFeat_qual_choice::x_GetLegalQualName ( vector< EFeat_qual_legal > &  v_qual,
EFeat_qual_legal  qual 
) const
private

Definition at line 54 of file Feat_qual_choice.cpp.

References ENUM_METHOD_NAME, ITERATE, and kEmptyStr.

◆ x_GetTwoFieldSubfield()

void CFeat_qual_choice::x_GetTwoFieldSubfield ( string str,
int  subfield 
) const
private

Definition at line 77 of file Feat_qual_choice.cpp.

References kEmptyStr, and str().

Referenced by x_GetFirstGBQualMatch().


The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:57:20 2024 by modify_doxy.py rev. 669887