NCBI C++ ToolKit
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
CBiosampleFieldDiff Class Reference

Search Toolkit Book for CBiosampleFieldDiff

#include <misc/biosample_util/biosample_util.hpp>

+ Inheritance diagram for CBiosampleFieldDiff:
+ Collaboration diagram for CBiosampleFieldDiff:

Public Member Functions

 CBiosampleFieldDiff ()
 
 CBiosampleFieldDiff (const string &sequence_id, const string &biosample_id, const string &field_name, const string &src_val, const string &sample_val)
 
 CBiosampleFieldDiff (const string &sequence_id, const string &biosample_id, const CFieldDiff &diff)
 
 ~CBiosampleFieldDiff (void)
 
void Print (ncbi::CNcbiOstream &stream, bool show_seq_id=true) const
 
void Print (ncbi::CNcbiOstream &stream, const CBiosampleFieldDiff &prev)
 
void PrettyPrint (ncbi::CNcbiOstream &stream, size_t keyWidth=20, size_t valueWidth=40) const
 
const stringGetSequenceId () const
 
void SetSequenceId (const string &id)
 
const stringGetFieldName () const
 
string GetSrcVal () const
 
string GetSampleVal () const
 
string GetPureSrcVal () const
 
string GetPureSampleVal () const
 
const stringGetBioSample () const
 
int CompareAllButSequenceID (const CBiosampleFieldDiff &other)
 
int Compare (const CBiosampleFieldDiff &other)
 
- 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...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. 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 void PrintHeader (ncbi::CNcbiOstream &stream, bool show_seq_id=true)
 
- 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 Attributes

string m_SequenceID
 
string m_BiosampleID
 
string m_FieldName
 
string m_SrcVal
 
string m_SampleVal
 

Additional Inherited Members

- 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 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 79 of file biosample_util.hpp.

Constructor & Destructor Documentation

◆ CBiosampleFieldDiff() [1/3]

CBiosampleFieldDiff::CBiosampleFieldDiff ( )
inline

Definition at line 82 of file biosample_util.hpp.

◆ CBiosampleFieldDiff() [2/3]

CBiosampleFieldDiff::CBiosampleFieldDiff ( const string sequence_id,
const string biosample_id,
const string field_name,
const string src_val,
const string sample_val 
)
inline

Definition at line 83 of file biosample_util.hpp.

◆ CBiosampleFieldDiff() [3/3]

CBiosampleFieldDiff::CBiosampleFieldDiff ( const string sequence_id,
const string biosample_id,
const CFieldDiff diff 
)
inline

Definition at line 86 of file biosample_util.hpp.

◆ ~CBiosampleFieldDiff()

CBiosampleFieldDiff::~CBiosampleFieldDiff ( void  )
inline

Definition at line 93 of file biosample_util.hpp.

Member Function Documentation

◆ Compare()

int CBiosampleFieldDiff::Compare ( const CBiosampleFieldDiff other)

Definition at line 455 of file biosample_util.cpp.

References NStr::CompareCase(), and m_SequenceID.

◆ CompareAllButSequenceID()

int CBiosampleFieldDiff::CompareAllButSequenceID ( const CBiosampleFieldDiff other)

◆ GetBioSample()

const string& CBiosampleFieldDiff::GetBioSample ( ) const
inline

Definition at line 106 of file biosample_util.hpp.

References m_BiosampleID.

◆ GetFieldName()

const string& CBiosampleFieldDiff::GetFieldName ( ) const
inline

Definition at line 101 of file biosample_util.hpp.

References m_FieldName.

◆ GetPureSampleVal()

string CBiosampleFieldDiff::GetPureSampleVal ( ) const
inline

Definition at line 105 of file biosample_util.hpp.

References m_SampleVal.

◆ GetPureSrcVal()

string CBiosampleFieldDiff::GetPureSrcVal ( ) const
inline

Definition at line 104 of file biosample_util.hpp.

References m_SrcVal.

◆ GetSampleVal()

string CBiosampleFieldDiff::GetSampleVal ( ) const
inline

Definition at line 103 of file biosample_util.hpp.

References CBioSource::IsStopWord(), m_SampleVal, and string.

◆ GetSequenceId()

const string& CBiosampleFieldDiff::GetSequenceId ( ) const
inline

Definition at line 99 of file biosample_util.hpp.

References m_SequenceID.

◆ GetSrcVal()

string CBiosampleFieldDiff::GetSrcVal ( ) const
inline

Definition at line 102 of file biosample_util.hpp.

References CBioSource::IsStopWord(), m_SrcVal, and string.

◆ PrettyPrint()

void CBiosampleFieldDiff::PrettyPrint ( ncbi::CNcbiOstream stream,
size_t  keyWidth = 20,
size_t  valueWidth = 40 
) const

Definition at line 397 of file biosample_util.cpp.

References sPrintField(), and string.

◆ Print() [1/2]

void CBiosampleFieldDiff::Print ( ncbi::CNcbiOstream stream,
bool  show_seq_id = true 
) const

◆ Print() [2/2]

void CBiosampleFieldDiff::Print ( ncbi::CNcbiOstream stream,
const CBiosampleFieldDiff prev 
)

◆ PrintHeader()

void CBiosampleFieldDiff::PrintHeader ( ncbi::CNcbiOstream stream,
bool  show_seq_id = true 
)
static

Definition at line 359 of file biosample_util.cpp.

◆ SetSequenceId()

void CBiosampleFieldDiff::SetSequenceId ( const string id)
inline

Definition at line 100 of file biosample_util.hpp.

References m_SequenceID.

Member Data Documentation

◆ m_BiosampleID

string CBiosampleFieldDiff::m_BiosampleID
private

Definition at line 113 of file biosample_util.hpp.

Referenced by CompareAllButSequenceID(), and GetBioSample().

◆ m_FieldName

string CBiosampleFieldDiff::m_FieldName
private

Definition at line 114 of file biosample_util.hpp.

Referenced by CompareAllButSequenceID(), and GetFieldName().

◆ m_SampleVal

string CBiosampleFieldDiff::m_SampleVal
private

Definition at line 116 of file biosample_util.hpp.

Referenced by GetPureSampleVal(), and GetSampleVal().

◆ m_SequenceID

string CBiosampleFieldDiff::m_SequenceID
private

Definition at line 112 of file biosample_util.hpp.

Referenced by Compare(), GetSequenceId(), and SetSequenceId().

◆ m_SrcVal

string CBiosampleFieldDiff::m_SrcVal
private

Definition at line 115 of file biosample_util.hpp.

Referenced by CompareAllButSequenceID(), GetPureSrcVal(), and GetSrcVal().


The documentation for this class was generated from the following files:
Modified on Mon Jul 15 05:36:04 2024 by modify_doxy.py rev. 669887