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

Search Toolkit Book for CMolInfo_Base

******* NOTE: * mol-type, modif, method, and org are consolidated and expanded * in Org-ref, BioSource, and MolInfo in this specification. More...

#include <objects/seq/MolInfo_.hpp>

+ Inheritance diagram for CMolInfo_Base:
+ Collaboration diagram for CMolInfo_Base:

Public Types

enum  EBiomol {
  eBiomol_unknown = 0 , eBiomol_genomic = 1 , eBiomol_pre_RNA = 2 , eBiomol_mRNA = 3 ,
  eBiomol_rRNA = 4 , eBiomol_tRNA = 5 , eBiomol_snRNA = 6 , eBiomol_scRNA = 7 ,
  eBiomol_peptide = 8 , eBiomol_other_genetic = 9 , eBiomol_genomic_mRNA = 10 , eBiomol_cRNA = 11 ,
  eBiomol_snoRNA = 12 , eBiomol_transcribed_RNA = 13 , eBiomol_ncRNA = 14 , eBiomol_tmRNA = 15 ,
  eBiomol_other = 255
}
 
enum  ETech {
  eTech_unknown = 0 , eTech_standard = 1 , eTech_est = 2 , eTech_sts = 3 ,
  eTech_survey = 4 , eTech_genemap = 5 , eTech_physmap = 6 , eTech_derived = 7 ,
  eTech_concept_trans = 8 , eTech_seq_pept = 9 , eTech_both = 10 , eTech_seq_pept_overlap = 11 ,
  eTech_seq_pept_homol = 12 , eTech_concept_trans_a = 13 , eTech_htgs_1 = 14 , eTech_htgs_2 = 15 ,
  eTech_htgs_3 = 16 , eTech_fli_cdna = 17 , eTech_htgs_0 = 18 , eTech_htc = 19 ,
  eTech_wgs = 20 , eTech_barcode = 21 , eTech_composite_wgs_htgs = 22 , eTech_tsa = 23 ,
  eTech_targeted = 24 , eTech_other = 255
}
 
enum  ECompleteness {
  eCompleteness_unknown = 0 , eCompleteness_complete = 1 , eCompleteness_partial = 2 , eCompleteness_no_left = 3 ,
  eCompleteness_no_right = 4 , eCompleteness_no_ends = 5 , eCompleteness_has_left = 6 , eCompleteness_has_right = 7 ,
  eCompleteness_other = 255
}
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_biomol , e_tech , e_techexp ,
  e_completeness , e_gbmoltype
}
 
typedef int TBiomol
 
typedef int TTech
 
typedef string TTechexp
 
typedef int TCompleteness
 
typedef string TGbmoltype
 
typedef Tparent::CMemberIndex< E_memberIndex, 6 > 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

 CMolInfo_Base (void)
 
virtual ~CMolInfo_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetBiomol (void) const
 Check if a value has been assigned to Biomol data member. More...
 
bool CanGetBiomol (void) const
 Check if it is safe to call GetBiomol method. More...
 
void ResetBiomol (void)
 Reset Biomol data member. More...
 
void SetDefaultBiomol (void)
 Assign default value to Biomol data member. More...
 
TBiomol GetBiomol (void) const
 Get the Biomol member data. More...
 
void SetBiomol (TBiomol value)
 Assign a value to Biomol data member. More...
 
TBiomolSetBiomol (void)
 Assign a value to Biomol data member. More...
 
bool IsSetTech (void) const
 Check if a value has been assigned to Tech data member. More...
 
bool CanGetTech (void) const
 Check if it is safe to call GetTech method. More...
 
void ResetTech (void)
 Reset Tech data member. More...
 
void SetDefaultTech (void)
 Assign default value to Tech data member. More...
 
TTech GetTech (void) const
 Get the Tech member data. More...
 
void SetTech (TTech value)
 Assign a value to Tech data member. More...
 
TTechSetTech (void)
 Assign a value to Tech data member. More...
 
bool IsSetTechexp (void) const
 explanation if tech not enough More...
 
bool CanGetTechexp (void) const
 Check if it is safe to call GetTechexp method. More...
 
void ResetTechexp (void)
 Reset Techexp data member. More...
 
const TTechexpGetTechexp (void) const
 Get the Techexp member data. More...
 
void SetTechexp (const TTechexp &value)
 Assign a value to Techexp data member. More...
 
void SetTechexp (TTechexp &&value)
 
TTechexpSetTechexp (void)
 Assign a value to Techexp data member. More...
 
bool IsSetCompleteness (void) const
 Check if a value has been assigned to Completeness data member. More...
 
bool CanGetCompleteness (void) const
 Check if it is safe to call GetCompleteness method. More...
 
void ResetCompleteness (void)
 Reset Completeness data member. More...
 
void SetDefaultCompleteness (void)
 Assign default value to Completeness data member. More...
 
TCompleteness GetCompleteness (void) const
 Get the Completeness member data. More...
 
void SetCompleteness (TCompleteness value)
 Assign a value to Completeness data member. More...
 
TCompletenessSetCompleteness (void)
 Assign a value to Completeness data member. More...
 
bool IsSetGbmoltype (void) const
 identifies particular ncRNA Check if a value has been assigned to Gbmoltype data member. More...
 
bool CanGetGbmoltype (void) const
 Check if it is safe to call GetGbmoltype method. More...
 
void ResetGbmoltype (void)
 Reset Gbmoltype data member. More...
 
const TGbmoltypeGetGbmoltype (void) const
 Get the Gbmoltype member data. More...
 
void SetGbmoltype (const TGbmoltype &value)
 Assign a value to Gbmoltype data member. More...
 
void SetGbmoltype (TGbmoltype &&value)
 
TGbmoltypeSetGbmoltype (void)
 Assign a value to Gbmoltype 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
 

Static Public Member Functions

static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() EBiomol (void)
 Access to EBiomol's attributes (values, names) as defined in spec. More...
 
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() ETech (void)
 Access to ETech's attributes (values, names) as defined in spec. More...
 
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() ECompleteness (void)
 Access to ECompleteness's attributes (values, names) as defined in spec. 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

 CMolInfo_Base (const CMolInfo_Base &)
 
CMolInfo_Baseoperator= (const CMolInfo_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
int m_Biomol
 
int m_Tech
 
string m_Techexp
 
int m_Completeness
 
string m_Gbmoltype
 

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

******* NOTE: * mol-type, modif, method, and org are consolidated and expanded * in Org-ref, BioSource, and MolInfo in this specification.

They * will be removed in later specifications. Do not use them in the * the future. Instead expect the new structures. * *************************** ********************************************************************

MolInfo gives information on the classification of the type and quality of the sequence

WARNING: this will replace GIBB-mol, GIBB-mod, GIBB-method

********************************************************************

CMolInfo_Base

Definition at line 87 of file MolInfo_.hpp.


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