NCBI C++ ToolKit
Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
NSnpBins::CGeneMap Class Reference

Search Toolkit Book for NSnpBins::CGeneMap

storage for gene maps as seen in strings in SBinEntry::genes_reported and SBinEntry::genes_mapped More...

#include <objtools/snputil/snp_bins.hpp>

+ Collaboration diagram for NSnpBins::CGeneMap:

Public Types

typedef map< string, stringTGeneMap
 maps of gene symbols to gene ids More...
 
typedef TGeneMap::const_iterator const_iterator
 masquerading as container More...
 

Public Member Functions

 CGeneMap (const string &sSrc="")
 expects a string like "GeneSym1^GeneID1:GeneSym2^geneID2:etc" More...
 
void Set (const string &sSrc)
 
string AsString () const
 recreate the string that was used for creation More...
 
const_iterator begin () const
 
const_iterator end () const
 

Private Member Functions

void x_Init (const string &sSrc)
 

Private Attributes

TGeneMap m_GeneMap
 

Friends

bool operator== (const CGeneMap &GeneMap1, const CGeneMap &GeneMap2)
 compare two GeneMaps, return true if they have the same set of elements More...
 

Detailed Description

storage for gene maps as seen in strings in SBinEntry::genes_reported and SBinEntry::genes_mapped

Definition at line 114 of file snp_bins.hpp.

Member Typedef Documentation

◆ const_iterator

masquerading as container

Definition at line 133 of file snp_bins.hpp.

◆ TGeneMap

maps of gene symbols to gene ids

key is gene symbol, value is gene id

Definition at line 130 of file snp_bins.hpp.

Constructor & Destructor Documentation

◆ CGeneMap()

NSnpBins::CGeneMap::CGeneMap ( const string sSrc = "")
inline

expects a string like "GeneSym1^GeneID1:GeneSym2^geneID2:etc"

Definition at line 118 of file snp_bins.hpp.

Member Function Documentation

◆ AsString()

string NSnpBins::CGeneMap::AsString ( void  ) const

recreate the string that was used for creation

  • sorting of genes may be different compared to the original
  • duplicates will be removed

Definition at line 267 of file snp_bins.cpp.

References ITERATE.

◆ begin()

const_iterator NSnpBins::CGeneMap::begin ( void  ) const
inline

Definition at line 134 of file snp_bins.hpp.

◆ end()

const_iterator NSnpBins::CGeneMap::end ( void  ) const
inline

Definition at line 135 of file snp_bins.hpp.

◆ Set()

void NSnpBins::CGeneMap::Set ( const string sSrc)
inline

Definition at line 119 of file snp_bins.hpp.

◆ x_Init()

void NSnpBins::CGeneMap::x_Init ( const string sSrc)
private

Friends And Related Function Documentation

◆ operator==

bool operator== ( const CGeneMap GeneMap1,
const CGeneMap GeneMap2 
)
friend

compare two GeneMaps, return true if they have the same set of elements

Definition at line 230 of file snp_bins.hpp.

Member Data Documentation

◆ m_GeneMap

TGeneMap NSnpBins::CGeneMap::m_GeneMap
private

Definition at line 140 of file snp_bins.hpp.

Referenced by operator==(), and x_Init().


The documentation for this class was generated from the following files:
Modified on Sun Jun 23 05:18:15 2024 by modify_doxy.py rev. 669887