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 CPopulation_data_Base

CPopulation_data_Base –. More...

#include <objects/seqfeat/Population_data_.hpp>

+ Inheritance diagram for CPopulation_data_Base:
+ Collaboration diagram for CPopulation_data_Base:

Public Types

enum  EFlags { eFlags_is_default_population = 1 , eFlags_is_minor_allele = 2 , eFlags_is_rare_allele = 4 }
 This field is an explicit bit-field Valid values should be a bitwise combination (= simple sum) of any of the values below. More...
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_population , e_genotype_frequency , e_chromosomes_tested ,
  e_sample_ids , e_allele_frequency , e_flags
}
 
typedef string TPopulation
 
typedef double TGenotype_frequency
 
typedef int TChromosomes_tested
 
typedef list< CRef< CObject_id > > TSample_ids
 
typedef double TAllele_frequency
 
typedef int TFlags
 
typedef Tparent::CMemberIndex< E_memberIndex, 7 > 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

 CPopulation_data_Base (void)
 
virtual ~CPopulation_data_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetPopulation (void) const
 assayed population (e.g. More...
 
bool CanGetPopulation (void) const
 Check if it is safe to call GetPopulation method. More...
 
void ResetPopulation (void)
 Reset Population data member. More...
 
const TPopulationGetPopulation (void) const
 Get the Population member data. More...
 
void SetPopulation (const TPopulation &value)
 Assign a value to Population data member. More...
 
void SetPopulation (TPopulation &&value)
 
TPopulationSetPopulation (void)
 Assign a value to Population data member. More...
 
bool IsSetGenotype_frequency (void) const
 Check if a value has been assigned to Genotype_frequency data member. More...
 
bool CanGetGenotype_frequency (void) const
 Check if it is safe to call GetGenotype_frequency method. More...
 
void ResetGenotype_frequency (void)
 Reset Genotype_frequency data member. More...
 
TGenotype_frequency GetGenotype_frequency (void) const
 Get the Genotype_frequency member data. More...
 
void SetGenotype_frequency (TGenotype_frequency value)
 Assign a value to Genotype_frequency data member. More...
 
TGenotype_frequencySetGenotype_frequency (void)
 Assign a value to Genotype_frequency data member. More...
 
bool IsSetChromosomes_tested (void) const
 Check if a value has been assigned to Chromosomes_tested data member. More...
 
bool CanGetChromosomes_tested (void) const
 Check if it is safe to call GetChromosomes_tested method. More...
 
void ResetChromosomes_tested (void)
 Reset Chromosomes_tested data member. More...
 
TChromosomes_tested GetChromosomes_tested (void) const
 Get the Chromosomes_tested member data. More...
 
void SetChromosomes_tested (TChromosomes_tested value)
 Assign a value to Chromosomes_tested data member. More...
 
TChromosomes_testedSetChromosomes_tested (void)
 Assign a value to Chromosomes_tested data member. More...
 
bool IsSetSample_ids (void) const
 Check if a value has been assigned to Sample_ids data member. More...
 
bool CanGetSample_ids (void) const
 Check if it is safe to call GetSample_ids method. More...
 
void ResetSample_ids (void)
 Reset Sample_ids data member. More...
 
const TSample_idsGetSample_ids (void) const
 Get the Sample_ids member data. More...
 
TSample_idsSetSample_ids (void)
 Assign a value to Sample_ids data member. More...
 
bool IsSetAllele_frequency (void) const
 Check if a value has been assigned to Allele_frequency data member. More...
 
bool CanGetAllele_frequency (void) const
 Check if it is safe to call GetAllele_frequency method. More...
 
void ResetAllele_frequency (void)
 Reset Allele_frequency data member. More...
 
TAllele_frequency GetAllele_frequency (void) const
 Get the Allele_frequency member data. More...
 
void SetAllele_frequency (TAllele_frequency value)
 Assign a value to Allele_frequency data member. More...
 
TAllele_frequencySetAllele_frequency (void)
 Assign a value to Allele_frequency data member. More...
 
bool IsSetFlags (void) const
 Check if a value has been assigned to Flags data member. More...
 
bool CanGetFlags (void) const
 Check if it is safe to call GetFlags method. More...
 
void ResetFlags (void)
 Reset Flags data member. More...
 
TFlags GetFlags (void) const
 Get the Flags member data. More...
 
void SetFlags (TFlags value)
 Assign a value to Flags data member. More...
 
TFlagsSetFlags (void)
 Assign a value to Flags 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() EFlags (void)
 Access to EFlags'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

 CPopulation_data_Base (const CPopulation_data_Base &)
 
CPopulation_data_Baseoperator= (const CPopulation_data_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
string m_Population
 
double m_Genotype_frequency
 
int m_Chromosomes_tested
 
list< CRef< CObject_id > > m_Sample_ids
 
double m_Allele_frequency
 
int m_Flags
 

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

CPopulation_data_Base –.

Definition at line 77 of file Population_data_.hpp.


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