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

Search Toolkit Book for CBioSource

#include <objects/seqfeat/BioSource.hpp>

+ Inheritance diagram for CBioSource:
+ Collaboration diagram for CBioSource:

Public Types

typedef pair< string, stringTNameVal
 
typedef vector< TNameValTNameValList
 
- Public Types inherited from CBioSource_Base
enum  EGenome {
  eGenome_unknown = 0 , eGenome_genomic = 1 , eGenome_chloroplast = 2 , eGenome_chromoplast = 3 ,
  eGenome_kinetoplast = 4 , eGenome_mitochondrion = 5 , eGenome_plastid = 6 , eGenome_macronuclear = 7 ,
  eGenome_extrachrom = 8 , eGenome_plasmid = 9 , eGenome_transposon = 10 , eGenome_insertion_seq = 11 ,
  eGenome_cyanelle = 12 , eGenome_proviral = 13 , eGenome_virion = 14 , eGenome_nucleomorph = 15 ,
  eGenome_apicoplast = 16 , eGenome_leucoplast = 17 , eGenome_proplastid = 18 , eGenome_endogenous_virus = 19 ,
  eGenome_hydrogenosome = 20 , eGenome_chromosome = 21 , eGenome_chromatophore = 22 , eGenome_plasmid_in_mitochondrion = 23 ,
  eGenome_plasmid_in_plastid = 24
}
 biological context More...
 
enum  EOrigin {
  eOrigin_unknown = 0 , eOrigin_natural = 1 , eOrigin_natmut = 2 , eOrigin_mut = 3 ,
  eOrigin_artificial = 4 , eOrigin_synthetic = 5 , eOrigin_other = 255
}
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_genome , e_origin , e_org ,
  e_subtype , e_is_focus , e_pcr_primers
}
 
typedef int TGenome
 
typedef int TOrigin
 
typedef COrg_ref TOrg
 
typedef list< CRef< CSubSource > > TSubtype
 
typedef CPCRReactionSet TPcr_primers
 
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

 CBioSource (void)
 
 ~CBioSource (void)
 
int GetGenCode (int def=1) const
 
bool IsSetTaxname (void) const
 
const stringGetTaxname (void) const
 
bool IsSetCommon (void) const
 
const stringGetCommon (void) const
 
bool IsSetLineage (void) const
 
const stringGetLineage (void) const
 
bool IsSetGcode (void) const
 
int GetGcode (void) const
 
bool IsSetMgcode (void) const
 
int GetMgcode (void) const
 
bool IsSetPgcode (void) const
 
int GetPgcode (void) const
 
bool IsSetDivision (void) const
 
const stringGetDivision (void) const
 
bool IsSetOrgname (void) const
 
const COrgNameGetOrgname (void) const
 
bool IsSetOrgMod (void) const
 
string GetRepliconName (void) const
 
string GetBioprojectType (void) const
 
string GetBioprojectLocation (void) const
 
void SetDisableStrainForwarding (bool val)
 
bool GetDisableStrainForwarding () const
 
void UpdateWithBioSample (const CBioSource &biosample, bool force, bool is_local_copy=false)
 
TFieldDiffList GetBiosampleDiffs (const CBioSource &biosample, bool is_local_copy=false) const
 
bool BiosampleDiffsOkForUpdate (const TFieldDiffList &diffs) const
 
TNameValList GetNameValPairs () const
 
void AutoFix ()
 
void RemoveCultureNotes (bool is_species_level=true)
 
bool RemoveLineageSourceNotes ()
 
bool RemoveSubSource (int subtype)
 
bool RemoveSubSource (int subtype, const string &val)
 
bool RemoveOrgMod (int subtype)
 
bool RemoveOrgMod (int subtype, const string &val)
 
bool FixEnvironmentalSample ()
 
bool RemoveNullTerms ()
 
bool AllowSexQualifier () const
 
bool AllowMatingTypeQualifier () const
 
bool FixSexMatingTypeInconsistencies ()
 
bool RemoveUnexpectedViralQualifiers ()
 
bool FixGenomeForQualifiers ()
 
bool IsViral () const
 
bool HasSubtype (CSubSource::TSubtype subtype) const
 
CRef< CBioSourceMakeCommon (const CBioSource &other) const
 
CRef< CBioSourceMakeCommonExceptOrg (const CBioSource &other) const
 
- Public Member Functions inherited from CBioSource_Base
 CBioSource_Base (void)
 
virtual ~CBioSource_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetGenome (void) const
 Check if a value has been assigned to Genome data member. More...
 
bool CanGetGenome (void) const
 Check if it is safe to call GetGenome method. More...
 
void ResetGenome (void)
 Reset Genome data member. More...
 
void SetDefaultGenome (void)
 Assign default value to Genome data member. More...
 
TGenome GetGenome (void) const
 Get the Genome member data. More...
 
void SetGenome (TGenome value)
 Assign a value to Genome data member. More...
 
TGenomeSetGenome (void)
 Assign a value to Genome data member. More...
 
bool IsSetOrigin (void) const
 Check if a value has been assigned to Origin data member. More...
 
bool CanGetOrigin (void) const
 Check if it is safe to call GetOrigin method. More...
 
void ResetOrigin (void)
 Reset Origin data member. More...
 
void SetDefaultOrigin (void)
 Assign default value to Origin data member. More...
 
TOrigin GetOrigin (void) const
 Get the Origin member data. More...
 
void SetOrigin (TOrigin value)
 Assign a value to Origin data member. More...
 
TOriginSetOrigin (void)
 Assign a value to Origin data member. More...
 
bool IsSetOrg (void) const
 Check if a value has been assigned to Org data member. More...
 
bool CanGetOrg (void) const
 Check if it is safe to call GetOrg method. More...
 
void ResetOrg (void)
 Reset Org data member. More...
 
const TOrgGetOrg (void) const
 Get the Org member data. More...
 
void SetOrg (TOrg &value)
 Assign a value to Org data member. More...
 
TOrgSetOrg (void)
 Assign a value to Org data member. More...
 
bool IsSetSubtype (void) const
 Check if a value has been assigned to Subtype data member. More...
 
bool CanGetSubtype (void) const
 Check if it is safe to call GetSubtype method. More...
 
void ResetSubtype (void)
 Reset Subtype data member. More...
 
const TSubtypeGetSubtype (void) const
 Get the Subtype member data. More...
 
TSubtypeSetSubtype (void)
 Assign a value to Subtype data member. More...
 
bool IsSetIs_focus (void) const
 to distinguish biological focus Check if a value has been assigned to Is_focus data member. More...
 
bool CanGetIs_focus (void) const
 Check if value of Is_focus member is getatable. More...
 
void ResetIs_focus (void)
 Reset Is_focus data member. More...
 
void SetIs_focus (void)
 Set NULL data member (assign 'NULL' value to Is_focus data member). More...
 
bool IsSetPcr_primers (void) const
 Check if a value has been assigned to Pcr_primers data member. More...
 
bool CanGetPcr_primers (void) const
 Check if it is safe to call GetPcr_primers method. More...
 
void ResetPcr_primers (void)
 Reset Pcr_primers data member. More...
 
const TPcr_primersGetPcr_primers (void) const
 Get the Pcr_primers member data. More...
 
void SetPcr_primers (TPcr_primers &value)
 Assign a value to Pcr_primers data member. More...
 
TPcr_primersSetPcr_primers (void)
 Assign a value to Pcr_primers 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 CBioSource::EGenome GetGenomeByOrganelle (const string &organelle, NStr::ECase use_case=NStr::eCase, bool starts_with=false)
 
static string GetOrganelleByGenome (unsigned int genome)
 
static CBioSource::EOrigin GetOriginByString (const string &origin, NStr::ECase use_case=NStr::eCase, bool starts_with=false)
 
static string GetStringFromOrigin (unsigned int origin)
 
static bool ShouldIgnoreConflict (const string &label, string src_val, string sample_val, bool is_local_copy=false)
 
static bool IsStopWord (const string &value)
 
static bool AllowSexQualifier (const string &lineage)
 
static bool AllowMatingTypeQualifier (const string &lineage)
 
static bool IsViral (const string &lineage)
 
- Static Public Member Functions inherited from CBioSource_Base
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() EGenome (void)
 Access to EGenome's attributes (values, names) as defined in spec. More...
 
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() EOrigin (void)
 Access to EOrigin'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 CBioSource_Base Tparent
 

Private Member Functions

 CBioSource (const CBioSource &value)
 
CBioSourceoperator= (const CBioSource &value)
 
void x_ClearCoordinatedBioSampleSubSources ()
 
void x_ClearCoordinatedBioSampleOrgMods ()
 
TNameValList x_GetOrgModNameValPairs () const
 
TNameValList x_GetSubtypeNameValPairs () const
 
void x_RemoveNameElementDiffs (const CBioSource &biosample, TFieldDiffList &diff_list) const
 
bool x_ShouldIgnoreNoteForBiosample () const
 

Static Private Member Functions

static void x_InitStopWords (void)
 
static void x_RemoveStopWords (COrg_ref &org_ref)
 

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

Definition at line 58 of file BioSource.hpp.

Member Typedef Documentation

◆ TNameVal

Definition at line 126 of file BioSource.hpp.

◆ TNameValList

Definition at line 127 of file BioSource.hpp.

◆ Tparent

Definition at line 60 of file BioSource.hpp.

Constructor & Destructor Documentation

◆ CBioSource() [1/2]

CBioSource::CBioSource ( void  )
inline

Definition at line 203 of file BioSource.hpp.

Referenced by MakeCommonExceptOrg().

◆ ~CBioSource()

CBioSource::~CBioSource ( void  )

Definition at line 68 of file BioSource.cpp.

◆ CBioSource() [2/2]

CBioSource::CBioSource ( const CBioSource value)
private

Member Function Documentation

◆ AllowMatingTypeQualifier() [1/2]

bool CBioSource::AllowMatingTypeQualifier ( ) const

◆ AllowMatingTypeQualifier() [2/2]

bool CBioSource::AllowMatingTypeQualifier ( const string lineage)
static

Definition at line 1878 of file BioSource.cpp.

References NStr::eNocase, IsViral(), and NStr::StartsWith().

Referenced by BOOST_AUTO_TEST_CASE().

◆ AllowSexQualifier() [1/2]

bool CBioSource::AllowSexQualifier ( ) const

◆ AllowSexQualifier() [2/2]

bool CBioSource::AllowSexQualifier ( const string lineage)
static

Definition at line 1845 of file BioSource.cpp.

References NStr::eNocase, IsViral(), and NStr::StartsWith().

Referenced by BOOST_AUTO_TEST_CASE().

◆ AutoFix()

void CBioSource::AutoFix ( )

◆ BiosampleDiffsOkForUpdate()

bool CBioSource::BiosampleDiffsOkForUpdate ( const TFieldDiffList diffs) const

Definition at line 693 of file BioSource.cpp.

References NStr::IsBlank(), and ITERATE.

Referenced by UpdateWithBioSample().

◆ FixEnvironmentalSample()

bool CBioSource::FixEnvironmentalSample ( )

◆ FixGenomeForQualifiers()

bool CBioSource::FixGenomeForQualifiers ( )

◆ FixSexMatingTypeInconsistencies()

bool CBioSource::FixSexMatingTypeInconsistencies ( )

◆ GetBioprojectLocation()

string CBioSource::GetBioprojectLocation ( void  ) const

◆ GetBioprojectType()

string CBioSource::GetBioprojectType ( void  ) const

◆ GetBiosampleDiffs()

TFieldDiffList CBioSource::GetBiosampleDiffs ( const CBioSource biosample,
bool  is_local_copy = false 
) const

◆ GetCommon()

const string & CBioSource::GetCommon ( void  ) const

◆ GetDisableStrainForwarding()

bool CBioSource::GetDisableStrainForwarding ( ) const

◆ GetDivision()

const string & CBioSource::GetDivision ( void  ) const

◆ GetGcode()

int CBioSource::GetGcode ( void  ) const

◆ GetGenCode()

int CBioSource::GetGenCode ( int  def = 1) const

◆ GetGenomeByOrganelle()

CBioSource::EGenome CBioSource::GetGenomeByOrganelle ( const string organelle,
NStr::ECase  use_case = NStr::eCase,
bool  starts_with = false 
)
static

◆ GetLineage()

const string & CBioSource::GetLineage ( void  ) const

◆ GetMgcode()

int CBioSource::GetMgcode ( void  ) const

◆ GetNameValPairs()

CBioSource::TNameValList CBioSource::GetNameValPairs ( ) const

◆ GetOrganelleByGenome()

string CBioSource::GetOrganelleByGenome ( unsigned int  genome)
static

◆ GetOrgname()

const COrgName & CBioSource::GetOrgname ( void  ) const

◆ GetOriginByString()

CBioSource::EOrigin CBioSource::GetOriginByString ( const string origin,
NStr::ECase  use_case = NStr::eCase,
bool  starts_with = false 
)
static

◆ GetPgcode()

int CBioSource::GetPgcode ( void  ) const

Definition at line 390 of file BioSource.cpp.

References CBioSource_Base::GetOrg(), and COrg_ref::GetPgcode().

◆ GetRepliconName()

string CBioSource::GetRepliconName ( void  ) const

◆ GetStringFromOrigin()

string CBioSource::GetStringFromOrigin ( unsigned int  origin)
static

◆ GetTaxname()

const string & CBioSource::GetTaxname ( void  ) const

◆ HasSubtype()

bool CBioSource::HasSubtype ( CSubSource::TSubtype  subtype) const

◆ IsSetCommon()

bool CBioSource::IsSetCommon ( void  ) const

◆ IsSetDivision()

bool CBioSource::IsSetDivision ( void  ) const

◆ IsSetGcode()

bool CBioSource::IsSetGcode ( void  ) const

◆ IsSetLineage()

bool CBioSource::IsSetLineage ( void  ) const

◆ IsSetMgcode()

bool CBioSource::IsSetMgcode ( void  ) const

◆ IsSetOrgMod()

bool CBioSource::IsSetOrgMod ( void  ) const

◆ IsSetOrgname()

bool CBioSource::IsSetOrgname ( void  ) const

◆ IsSetPgcode()

bool CBioSource::IsSetPgcode ( void  ) const

◆ IsSetTaxname()

bool CBioSource::IsSetTaxname ( void  ) const

◆ IsStopWord()

bool CBioSource::IsStopWord ( const string value)
static

◆ IsViral() [1/2]

bool CBioSource::IsViral ( ) const

◆ IsViral() [2/2]

bool CBioSource::IsViral ( const string lineage)
static

Definition at line 1825 of file BioSource.cpp.

References NStr::eNocase, and NStr::StartsWith().

◆ MakeCommon()

CRef< CBioSource > CBioSource::MakeCommon ( const CBioSource other) const

◆ MakeCommonExceptOrg()

CRef< CBioSource > CBioSource::MakeCommonExceptOrg ( const CBioSource other) const

◆ operator=()

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

◆ RemoveCultureNotes()

void CBioSource::RemoveCultureNotes ( bool  is_species_level = true)

◆ RemoveLineageSourceNotes()

bool CBioSource::RemoveLineageSourceNotes ( )

◆ RemoveNullTerms()

bool CBioSource::RemoveNullTerms ( )

◆ RemoveOrgMod() [1/2]

bool CBioSource::RemoveOrgMod ( int  subtype)

◆ RemoveOrgMod() [2/2]

bool CBioSource::RemoveOrgMod ( int  subtype,
const string val 
)

◆ RemoveSubSource() [1/2]

bool CBioSource::RemoveSubSource ( int  subtype)

◆ RemoveSubSource() [2/2]

bool CBioSource::RemoveSubSource ( int  subtype,
const string val 
)

◆ RemoveUnexpectedViralQualifiers()

bool CBioSource::RemoveUnexpectedViralQualifiers ( )

◆ SetDisableStrainForwarding()

void CBioSource::SetDisableStrainForwarding ( bool  val)

◆ ShouldIgnoreConflict()

bool CBioSource::ShouldIgnoreConflict ( const string label,
string  src_val,
string  sample_val,
bool  is_local_copy = false 
)
static

◆ UpdateWithBioSample()

void CBioSource::UpdateWithBioSample ( const CBioSource biosample,
bool  force,
bool  is_local_copy = false 
)

◆ x_ClearCoordinatedBioSampleOrgMods()

void CBioSource::x_ClearCoordinatedBioSampleOrgMods ( )
private

◆ x_ClearCoordinatedBioSampleSubSources()

void CBioSource::x_ClearCoordinatedBioSampleSubSources ( )
private

◆ x_GetOrgModNameValPairs()

CBioSource::TNameValList CBioSource::x_GetOrgModNameValPairs ( ) const
private

◆ x_GetSubtypeNameValPairs()

CBioSource::TNameValList CBioSource::x_GetSubtypeNameValPairs ( ) const
private

◆ x_InitStopWords()

static void CBioSource::x_InitStopWords ( void  )
staticprivate

◆ x_RemoveNameElementDiffs()

void CBioSource::x_RemoveNameElementDiffs ( const CBioSource biosample,
TFieldDiffList diff_list 
) const
private

◆ x_RemoveStopWords()

void CBioSource::x_RemoveStopWords ( COrg_ref org_ref)
staticprivate

◆ x_ShouldIgnoreNoteForBiosample()

bool CBioSource::x_ShouldIgnoreNoteForBiosample ( ) const
private

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