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

Represents ASN.1 type HG-Gene defined in file homologene.asn

Search Toolkit Book for CHG_Gene

#include <objects/homologene/HG_Gene.hpp>

+ Inheritance diagram for CHG_Gene:
+ Collaboration diagram for CHG_Gene:

Public Types

typedef list< stringTAliases
 
typedef TAliases::const_iterator TAliases_iter
 
typedef TGene_links TLinks
 
- Public Types inherited from CHG_Gene_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_geneid , e_otherid , e_symbol ,
  e_aliases , e_title , e_taxid , e_prot_gi ,
  e_prot_acc , e_prot_len , e_nuc_gi , e_nuc_acc ,
  e_gene_links , e_prot_links , e_domains , e_chr ,
  e_location , e_locus_tag
}
 
typedef int TGeneid
 
typedef int TOtherid
 
typedef string TSymbol
 
typedef list< stringTAliases
 
typedef string TTitle
 
typedef int TTaxid
 
typedef int TProt_gi
 
typedef string TProt_acc
 
typedef int TProt_len
 
typedef int TNuc_gi
 
typedef string TNuc_acc
 
typedef list< CRef< CHG_Link > > TGene_links
 
typedef list< CRef< CHG_Link > > TProt_links
 
typedef list< CRef< CHG_Domain > > TDomains
 
typedef string TChr
 
typedef CSeq_loc TLocation
 
typedef string TLocus_tag
 
typedef Tparent::CMemberIndex< E_memberIndex, 18 > 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...
 

Public Member Functions

 CHG_Gene (void)
 
 ~CHG_Gene (void)
 
bool IsSetLinks (void) const
 
bool CanGetLinks (void) const
 
void ResetLinks (void)
 
const TLinksGetLinks (void) const
 
TLinksSetLinks (void)
 
CHG_Gene::TSymbol GetLabel (void) const
 
- Public Member Functions inherited from CHG_Gene_Base
 CHG_Gene_Base (void)
 
virtual ~CHG_Gene_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetGeneid (void) const
 Check if a value has been assigned to Geneid data member. More...
 
bool CanGetGeneid (void) const
 Check if it is safe to call GetGeneid method. More...
 
void ResetGeneid (void)
 Reset Geneid data member. More...
 
TGeneid GetGeneid (void) const
 Get the Geneid member data. More...
 
void SetGeneid (TGeneid value)
 Assign a value to Geneid data member. More...
 
TGeneidSetGeneid (void)
 Assign a value to Geneid data member. More...
 
bool IsSetOtherid (void) const
 internal use only!!!!! Check if a value has been assigned to Otherid data member. More...
 
bool CanGetOtherid (void) const
 Check if it is safe to call GetOtherid method. More...
 
void ResetOtherid (void)
 Reset Otherid data member. More...
 
TOtherid GetOtherid (void) const
 Get the Otherid member data. More...
 
void SetOtherid (TOtherid value)
 Assign a value to Otherid data member. More...
 
TOtheridSetOtherid (void)
 Assign a value to Otherid data member. More...
 
bool IsSetSymbol (void) const
 Check if a value has been assigned to Symbol data member. More...
 
bool CanGetSymbol (void) const
 Check if it is safe to call GetSymbol method. More...
 
void ResetSymbol (void)
 Reset Symbol data member. More...
 
const TSymbolGetSymbol (void) const
 Get the Symbol member data. More...
 
void SetSymbol (const TSymbol &value)
 Assign a value to Symbol data member. More...
 
void SetSymbol (TSymbol &&value)
 
TSymbolSetSymbol (void)
 Assign a value to Symbol data member. More...
 
bool IsSetAliases (void) const
 Check if a value has been assigned to Aliases data member. More...
 
bool CanGetAliases (void) const
 Check if it is safe to call GetAliases method. More...
 
void ResetAliases (void)
 Reset Aliases data member. More...
 
const TAliasesGetAliases (void) const
 Get the Aliases member data. More...
 
TAliasesSetAliases (void)
 Assign a value to Aliases data member. More...
 
bool IsSetTitle (void) const
 Check if a value has been assigned to Title data member. More...
 
bool CanGetTitle (void) const
 Check if it is safe to call GetTitle method. More...
 
void ResetTitle (void)
 Reset Title data member. More...
 
const TTitleGetTitle (void) const
 Get the Title member data. More...
 
void SetTitle (const TTitle &value)
 Assign a value to Title data member. More...
 
void SetTitle (TTitle &&value)
 
TTitleSetTitle (void)
 Assign a value to Title data member. More...
 
bool IsSetTaxid (void) const
 taxid of gene node Check if a value has been assigned to Taxid data member. More...
 
bool CanGetTaxid (void) const
 Check if it is safe to call GetTaxid method. More...
 
void ResetTaxid (void)
 Reset Taxid data member. More...
 
TTaxid GetTaxid (void) const
 Get the Taxid member data. More...
 
void SetTaxid (TTaxid value)
 Assign a value to Taxid data member. More...
 
TTaxidSetTaxid (void)
 Assign a value to Taxid data member. More...
 
bool IsSetProt_gi (void) const
 Check if a value has been assigned to Prot_gi data member. More...
 
bool CanGetProt_gi (void) const
 Check if it is safe to call GetProt_gi method. More...
 
void ResetProt_gi (void)
 Reset Prot_gi data member. More...
 
TProt_gi GetProt_gi (void) const
 Get the Prot_gi member data. More...
 
void SetProt_gi (TProt_gi value)
 Assign a value to Prot_gi data member. More...
 
TProt_giSetProt_gi (void)
 Assign a value to Prot_gi data member. More...
 
bool IsSetProt_acc (void) const
 Check if a value has been assigned to Prot_acc data member. More...
 
bool CanGetProt_acc (void) const
 Check if it is safe to call GetProt_acc method. More...
 
void ResetProt_acc (void)
 Reset Prot_acc data member. More...
 
const TProt_accGetProt_acc (void) const
 Get the Prot_acc member data. More...
 
void SetProt_acc (const TProt_acc &value)
 Assign a value to Prot_acc data member. More...
 
void SetProt_acc (TProt_acc &&value)
 
TProt_accSetProt_acc (void)
 Assign a value to Prot_acc data member. More...
 
bool IsSetProt_len (void) const
 Check if a value has been assigned to Prot_len data member. More...
 
bool CanGetProt_len (void) const
 Check if it is safe to call GetProt_len method. More...
 
void ResetProt_len (void)
 Reset Prot_len data member. More...
 
TProt_len GetProt_len (void) const
 Get the Prot_len member data. More...
 
void SetProt_len (TProt_len value)
 Assign a value to Prot_len data member. More...
 
TProt_lenSetProt_len (void)
 Assign a value to Prot_len data member. More...
 
bool IsSetNuc_gi (void) const
 Check if a value has been assigned to Nuc_gi data member. More...
 
bool CanGetNuc_gi (void) const
 Check if it is safe to call GetNuc_gi method. More...
 
void ResetNuc_gi (void)
 Reset Nuc_gi data member. More...
 
TNuc_gi GetNuc_gi (void) const
 Get the Nuc_gi member data. More...
 
void SetNuc_gi (TNuc_gi value)
 Assign a value to Nuc_gi data member. More...
 
TNuc_giSetNuc_gi (void)
 Assign a value to Nuc_gi data member. More...
 
bool IsSetNuc_acc (void) const
 Check if a value has been assigned to Nuc_acc data member. More...
 
bool CanGetNuc_acc (void) const
 Check if it is safe to call GetNuc_acc method. More...
 
void ResetNuc_acc (void)
 Reset Nuc_acc data member. More...
 
const TNuc_accGetNuc_acc (void) const
 Get the Nuc_acc member data. More...
 
void SetNuc_acc (const TNuc_acc &value)
 Assign a value to Nuc_acc data member. More...
 
void SetNuc_acc (TNuc_acc &&value)
 
TNuc_accSetNuc_acc (void)
 Assign a value to Nuc_acc data member. More...
 
bool IsSetGene_links (void) const
 Check if a value has been assigned to Gene_links data member. More...
 
bool CanGetGene_links (void) const
 Check if it is safe to call GetGene_links method. More...
 
void ResetGene_links (void)
 Reset Gene_links data member. More...
 
const TGene_linksGetGene_links (void) const
 Get the Gene_links member data. More...
 
TGene_linksSetGene_links (void)
 Assign a value to Gene_links data member. More...
 
bool IsSetProt_links (void) const
 Check if a value has been assigned to Prot_links data member. More...
 
bool CanGetProt_links (void) const
 Check if it is safe to call GetProt_links method. More...
 
void ResetProt_links (void)
 Reset Prot_links data member. More...
 
const TProt_linksGetProt_links (void) const
 Get the Prot_links member data. More...
 
TProt_linksSetProt_links (void)
 Assign a value to Prot_links data member. More...
 
bool IsSetDomains (void) const
 Check if a value has been assigned to Domains data member. More...
 
bool CanGetDomains (void) const
 Check if it is safe to call GetDomains method. More...
 
void ResetDomains (void)
 Reset Domains data member. More...
 
const TDomainsGetDomains (void) const
 Get the Domains member data. More...
 
TDomainsSetDomains (void)
 Assign a value to Domains data member. More...
 
bool IsSetChr (void) const
 Check if a value has been assigned to Chr data member. More...
 
bool CanGetChr (void) const
 Check if it is safe to call GetChr method. More...
 
void ResetChr (void)
 Reset Chr data member. More...
 
const TChrGetChr (void) const
 Get the Chr member data. More...
 
void SetChr (const TChr &value)
 Assign a value to Chr data member. More...
 
void SetChr (TChr &&value)
 
TChrSetChr (void)
 Assign a value to Chr data member. More...
 
bool IsSetLocation (void) const
 location on the genome Check if a value has been assigned to Location data member. More...
 
bool CanGetLocation (void) const
 Check if it is safe to call GetLocation method. More...
 
void ResetLocation (void)
 Reset Location data member. More...
 
const TLocationGetLocation (void) const
 Get the Location member data. More...
 
void SetLocation (TLocation &value)
 Assign a value to Location data member. More...
 
TLocationSetLocation (void)
 Assign a value to Location data member. More...
 
bool IsSetLocus_tag (void) const
 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...
 
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 CHG_Gene_Base Tparent
 

Private Member Functions

 CHG_Gene (const CHG_Gene &value)
 
CHG_Geneoperator= (const CHG_Gene &value)
 
CHG_Gene::TSymbol x_GetGeneidLabel (void) const
 

Additional Inherited Members

- 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 50 of file HG_Gene.hpp.

Member Typedef Documentation

◆ TAliases

typedef list<string> CHG_Gene::TAliases

Definition at line 59 of file HG_Gene.hpp.

◆ TAliases_iter

typedef TAliases::const_iterator CHG_Gene::TAliases_iter

Definition at line 60 of file HG_Gene.hpp.

◆ TLinks

Definition at line 62 of file HG_Gene.hpp.

◆ Tparent

Definition at line 52 of file HG_Gene.hpp.

Constructor & Destructor Documentation

◆ CHG_Gene() [1/2]

CHG_Gene::CHG_Gene ( void  )
inline

Definition at line 83 of file HG_Gene.hpp.

◆ ~CHG_Gene()

CHG_Gene::~CHG_Gene ( void  )

Definition at line 51 of file HG_Gene.cpp.

◆ CHG_Gene() [2/2]

CHG_Gene::CHG_Gene ( const CHG_Gene value)
private

Member Function Documentation

◆ CanGetLinks()

bool CHG_Gene::CanGetLinks ( void  ) const
inline

Definition at line 64 of file HG_Gene.hpp.

References CHG_Gene_Base::CanGetGene_links().

◆ GetLabel()

CHG_Gene::TSymbol CHG_Gene::GetLabel ( void  ) const

◆ GetLinks()

const TLinks& CHG_Gene::GetLinks ( void  ) const
inline

Definition at line 66 of file HG_Gene.hpp.

References CHG_Gene_Base::GetGene_links().

◆ IsSetLinks()

bool CHG_Gene::IsSetLinks ( void  ) const
inline

Definition at line 63 of file HG_Gene.hpp.

References CHG_Gene_Base::IsSetGene_links().

◆ operator=()

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

◆ ResetLinks()

void CHG_Gene::ResetLinks ( void  )
inline

Definition at line 65 of file HG_Gene.hpp.

References CHG_Gene_Base::ResetGene_links().

◆ SetLinks()

TLinks& CHG_Gene::SetLinks ( void  )
inline

Definition at line 67 of file HG_Gene.hpp.

References CHG_Gene_Base::SetGene_links().

◆ x_GetGeneidLabel()

CHG_Gene::TSymbol CHG_Gene::x_GetGeneidLabel ( void  ) const
inlineprivate

Definition at line 56 of file HG_Gene.cpp.

References CHG_Gene_Base::GetGeneid(), and NStr::IntToString().

Referenced by GetLabel().


The documentation for this class was generated from the following files:
Modified on Sat May 25 14:21:53 2024 by modify_doxy.py rev. 669887