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

Represents ASN.1 type Gene-source defined in file entrezgene.asn

Search Toolkit Book for CGene_source

CGene_source –. More...

#include <objects/entrezgene/Gene_source.hpp>

+ Inheritance diagram for CGene_source:
+ Collaboration diagram for CGene_source:

Public Member Functions

 CGene_source (void)
 
 ~CGene_source (void)
 
- Public Member Functions inherited from CGene_source_Base
 CGene_source_Base (void)
 
virtual ~CGene_source_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetSrc (void) const
 key to the source within NCBI locuslink, Ecoli, etc Check if a value has been assigned to Src data member. More...
 
bool CanGetSrc (void) const
 Check if it is safe to call GetSrc method. More...
 
void ResetSrc (void)
 Reset Src data member. More...
 
const TSrcGetSrc (void) const
 Get the Src member data. More...
 
void SetSrc (const TSrc &value)
 Assign a value to Src data member. More...
 
void SetSrc (TSrc &&value)
 
TSrcSetSrc (void)
 Assign a value to Src data member. More...
 
bool IsSetSrc_int (void) const
 eg. More...
 
bool CanGetSrc_int (void) const
 Check if it is safe to call GetSrc_int method. More...
 
void ResetSrc_int (void)
 Reset Src_int data member. More...
 
TSrc_int GetSrc_int (void) const
 Get the Src_int member data. More...
 
void SetSrc_int (TSrc_int value)
 Assign a value to Src_int data member. More...
 
TSrc_intSetSrc_int (void)
 Assign a value to Src_int data member. More...
 
bool IsSetSrc_str1 (void) const
 eg. More...
 
bool CanGetSrc_str1 (void) const
 Check if it is safe to call GetSrc_str1 method. More...
 
void ResetSrc_str1 (void)
 Reset Src_str1 data member. More...
 
const TSrc_str1GetSrc_str1 (void) const
 Get the Src_str1 member data. More...
 
void SetSrc_str1 (const TSrc_str1 &value)
 Assign a value to Src_str1 data member. More...
 
void SetSrc_str1 (TSrc_str1 &&value)
 
TSrc_str1SetSrc_str1 (void)
 Assign a value to Src_str1 data member. More...
 
bool IsSetSrc_str2 (void) const
 see note 3 Check if a value has been assigned to Src_str2 data member. More...
 
bool CanGetSrc_str2 (void) const
 Check if it is safe to call GetSrc_str2 method. More...
 
void ResetSrc_str2 (void)
 Reset Src_str2 data member. More...
 
const TSrc_str2GetSrc_str2 (void) const
 Get the Src_str2 member data. More...
 
void SetSrc_str2 (const TSrc_str2 &value)
 Assign a value to Src_str2 data member. More...
 
void SetSrc_str2 (TSrc_str2 &&value)
 
TSrc_str2SetSrc_str2 (void)
 Assign a value to Src_str2 data member. More...
 
bool IsSetGene_display (void) const
 do we have a URL for gene display? Check if a value has been assigned to Gene_display data member. More...
 
bool CanGetGene_display (void) const
 Check if it is safe to call GetGene_display method. More...
 
void ResetGene_display (void)
 Reset Gene_display data member. More...
 
void SetDefaultGene_display (void)
 Assign default value to Gene_display data member. More...
 
TGene_display GetGene_display (void) const
 Get the Gene_display member data. More...
 
void SetGene_display (TGene_display value)
 Assign a value to Gene_display data member. More...
 
TGene_displaySetGene_display (void)
 Assign a value to Gene_display data member. More...
 
bool IsSetLocus_display (void) const
 do we have a URL for map/locus display? Check if a value has been assigned to Locus_display data member. More...
 
bool CanGetLocus_display (void) const
 Check if it is safe to call GetLocus_display method. More...
 
void ResetLocus_display (void)
 Reset Locus_display data member. More...
 
void SetDefaultLocus_display (void)
 Assign default value to Locus_display data member. More...
 
TLocus_display GetLocus_display (void) const
 Get the Locus_display member data. More...
 
void SetLocus_display (TLocus_display value)
 Assign a value to Locus_display data member. More...
 
TLocus_displaySetLocus_display (void)
 Assign a value to Locus_display data member. More...
 
bool IsSetExtra_terms (void) const
 do we have a URL for extra indexing terms? Check if a value has been assigned to Extra_terms data member. More...
 
bool CanGetExtra_terms (void) const
 Check if it is safe to call GetExtra_terms method. More...
 
void ResetExtra_terms (void)
 Reset Extra_terms data member. More...
 
void SetDefaultExtra_terms (void)
 Assign default value to Extra_terms data member. More...
 
TExtra_terms GetExtra_terms (void) const
 Get the Extra_terms member data. More...
 
void SetExtra_terms (TExtra_terms value)
 Assign a value to Extra_terms data member. More...
 
TExtra_termsSetExtra_terms (void)
 Assign a value to Extra_terms data member. More...
 
virtual void Reset (void)
 Reset the whole object. 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
 

Private Types

typedef CGene_source_Base Tparent
 

Private Member Functions

 CGene_source (const CGene_source &value)
 
CGene_sourceoperator= (const CGene_source &value)
 

Additional Inherited Members

- Public Types inherited from CGene_source_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_src , e_src_int , e_src_str1 ,
  e_src_str2 , e_gene_display , e_locus_display , e_extra_terms
}
 
typedef string TSrc
 
typedef int TSrc_int
 
typedef string TSrc_str1
 
typedef string TSrc_str2
 
typedef bool TGene_display
 
typedef bool TLocus_display
 
typedef bool TExtra_terms
 
typedef Tparent::CMemberIndex< E_memberIndex, 8 > TmemberIndex
 
- 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 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)
 
- 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

CGene_source –.

Definition at line 65 of file Gene_source.hpp.


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