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

Represents ASN.1 type Gene-ref defined in file seqfeat.asn

Search Toolkit Book for CGene_ref

#include <objects/seqfeat/Gene_ref.hpp>

+ Inheritance diagram for CGene_ref:
+ Collaboration diagram for CGene_ref:

Public Member Functions

 CGene_ref (void)
 
 ~CGene_ref (void)
 
void GetLabel (string *label) const
 
bool IsSuppressed (void) const
 
bool RefersToSameGene (const CGene_ref &xref) const
 
- Public Member Functions inherited from CGene_ref_Base
 CGene_ref_Base (void)
 
virtual ~CGene_ref_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetLocus (void) const
 Official gene symbol Check if a value has been assigned to Locus data member. More...
 
bool CanGetLocus (void) const
 Check if it is safe to call GetLocus method. More...
 
void ResetLocus (void)
 Reset Locus data member. More...
 
const TLocusGetLocus (void) const
 Get the Locus member data. More...
 
void SetLocus (const TLocus &value)
 Assign a value to Locus data member. More...
 
void SetLocus (TLocus &&value)
 
TLocusSetLocus (void)
 Assign a value to Locus data member. More...
 
bool IsSetAllele (void) const
 Official allele designation Check if a value has been assigned to Allele data member. More...
 
bool CanGetAllele (void) const
 Check if it is safe to call GetAllele method. More...
 
void ResetAllele (void)
 Reset Allele data member. More...
 
const TAlleleGetAllele (void) const
 Get the Allele member data. More...
 
void SetAllele (const TAllele &value)
 Assign a value to Allele data member. More...
 
void SetAllele (TAllele &&value)
 
TAlleleSetAllele (void)
 Assign a value to Allele data member. More...
 
bool IsSetDesc (void) const
 descriptive name Check if a value has been assigned to Desc data member. More...
 
bool CanGetDesc (void) const
 Check if it is safe to call GetDesc method. More...
 
void ResetDesc (void)
 Reset Desc data member. More...
 
const TDescGetDesc (void) const
 Get the Desc member data. More...
 
void SetDesc (const TDesc &value)
 Assign a value to Desc data member. More...
 
void SetDesc (TDesc &&value)
 
TDescSetDesc (void)
 Assign a value to Desc data member. More...
 
bool IsSetMaploc (void) const
 descriptive map location Check if a value has been assigned to Maploc data member. More...
 
bool CanGetMaploc (void) const
 Check if it is safe to call GetMaploc method. More...
 
void ResetMaploc (void)
 Reset Maploc data member. More...
 
const TMaplocGetMaploc (void) const
 Get the Maploc member data. More...
 
void SetMaploc (const TMaploc &value)
 Assign a value to Maploc data member. More...
 
void SetMaploc (TMaploc &&value)
 
TMaplocSetMaploc (void)
 Assign a value to Maploc data member. More...
 
bool IsSetPseudo (void) const
 pseudogene Check if a value has been assigned to Pseudo data member. More...
 
bool CanGetPseudo (void) const
 Check if it is safe to call GetPseudo method. More...
 
void ResetPseudo (void)
 Reset Pseudo data member. More...
 
void SetDefaultPseudo (void)
 Assign default value to Pseudo data member. More...
 
TPseudo GetPseudo (void) const
 Get the Pseudo member data. More...
 
void SetPseudo (TPseudo value)
 Assign a value to Pseudo data member. More...
 
TPseudoSetPseudo (void)
 Assign a value to Pseudo data member. More...
 
bool IsSetDb (void) const
 ids in other dbases Check if a value has been assigned to Db data member. More...
 
bool CanGetDb (void) const
 Check if it is safe to call GetDb method. More...
 
void ResetDb (void)
 Reset Db data member. More...
 
const TDbGetDb (void) const
 Get the Db member data. More...
 
TDbSetDb (void)
 Assign a value to Db data member. More...
 
bool IsSetSyn (void) const
 synonyms for locus Check if a value has been assigned to Syn data member. More...
 
bool CanGetSyn (void) const
 Check if it is safe to call GetSyn method. More...
 
void ResetSyn (void)
 Reset Syn data member. More...
 
const TSynGetSyn (void) const
 Get the Syn member data. More...
 
TSynSetSyn (void)
 Assign a value to Syn data member. More...
 
bool IsSetLocus_tag (void) const
 systematic gene name (e.g., MI0001, ORF0069) Check if a value has been assigned to Locus_tag data member. More...
 
bool CanGetLocus_tag (void) const
 Check if it is safe to call GetLocus_tag method. More...
 
void ResetLocus_tag (void)
 Reset Locus_tag data member. More...
 
const TLocus_tagGetLocus_tag (void) const
 Get the Locus_tag member data. More...
 
void SetLocus_tag (const TLocus_tag &value)
 Assign a value to Locus_tag data member. More...
 
void SetLocus_tag (TLocus_tag &&value)
 
TLocus_tagSetLocus_tag (void)
 Assign a value to Locus_tag data member. More...
 
bool IsSetFormal_name (void) const
 Check if a value has been assigned to Formal_name data member. More...
 
bool CanGetFormal_name (void) const
 Check if it is safe to call GetFormal_name method. More...
 
void ResetFormal_name (void)
 Reset Formal_name data member. More...
 
const TFormal_nameGetFormal_name (void) const
 Get the Formal_name member data. More...
 
void SetFormal_name (TFormal_name &value)
 Assign a value to Formal_name data member. More...
 
TFormal_nameSetFormal_name (void)
 Assign a value to Formal_name 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_ref_Base Tparent
 

Private Member Functions

 CGene_ref (const CGene_ref &value)
 
CGene_refoperator= (const CGene_ref &value)
 

Additional Inherited Members

- Public Types inherited from CGene_ref_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_locus , e_allele , e_desc ,
  e_maploc , e_pseudo , e_db , e_syn ,
  e_locus_tag , e_formal_name
}
 
typedef string TLocus
 
typedef string TAllele
 
typedef string TDesc
 
typedef string TMaploc
 
typedef bool TPseudo
 
typedef vector< CRef< CDbtag > > TDb
 
typedef list< stringTSyn
 
typedef string TLocus_tag
 
typedef CGene_nomenclature TFormal_name
 
typedef Tparent::CMemberIndex< E_memberIndex, 10 > 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

Definition at line 51 of file Gene_ref.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 53 of file Gene_ref.hpp.

Constructor & Destructor Documentation

◆ CGene_ref() [1/2]

CGene_ref::CGene_ref ( void  )
inline

Definition at line 81 of file Gene_ref.hpp.

◆ ~CGene_ref()

CGene_ref::~CGene_ref ( void  )

Definition at line 52 of file Gene_ref.cpp.

◆ CGene_ref() [2/2]

CGene_ref::CGene_ref ( const CGene_ref value)
private

Member Function Documentation

◆ GetLabel()

void CGene_ref::GetLabel ( string label) const

◆ IsSuppressed()

bool CGene_ref::IsSuppressed ( void  ) const

◆ operator=()

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

◆ RefersToSameGene()

bool CGene_ref::RefersToSameGene ( const CGene_ref xref) const

The documentation for this class was generated from the following files:
Modified on Sat Apr 13 11:48:21 2024 by modify_doxy.py rev. 669887