NCBI C++ ToolKit
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes

Represents ASN.1 type Dbtag defined in file general.asn

Search Toolkit Book for CDbtag_Base

Dbtag is generalized for tagging eg. More...

#include <objects/general/Dbtag_.hpp>

+ Inheritance diagram for CDbtag_Base:
+ Collaboration diagram for CDbtag_Base:

List of all members.

Public Types

typedef string TDb
typedef CObject_id TTag

Public Member Functions

 CDbtag_Base (void)
virtual ~CDbtag_Base (void)
 DECLARE_INTERNAL_TYPE_INFO ()
bool IsSetDb (void) const
 name of database or system Check if a value has been assigned to Db data member.
bool CanGetDb (void) const
 Check if it is safe to call GetDb method.
void ResetDb (void)
 Reset Db data member.
const TDbGetDb (void) const
 Get the Db member data.
void SetDb (const TDb &value)
 Assign a value to Db data member.
TDbSetDb (void)
 Assign a value to Db data member.
bool IsSetTag (void) const
 appropriate tag Check if a value has been assigned to Tag data member.
bool CanGetTag (void) const
 Check if it is safe to call GetTag method.
void ResetTag (void)
 Reset Tag data member.
const TTagGetTag (void) const
 Get the Tag member data.
void SetTag (TTag &value)
 Assign a value to Tag data member.
TTagSetTag (void)
 Assign a value to Tag data member.
virtual void Reset (void)
 Reset the whole object.

Private Types

typedef CSerialObject Tparent

Private Member Functions

 CDbtag_Base (const CDbtag_Base &)
CDbtag_Baseoperator= (const CDbtag_Base &)

Private Attributes

Uint4 m_set_State [1]
string m_Db
CRef< TTagm_Tag

Detailed Description

Dbtag is generalized for tagging eg.

{ "Social Security", str "023-79-8841" } or { "member", id 8882224 }

CDbtag_Base --

Definition at line 79 of file Dbtag_.hpp.


Member Typedef Documentation

Definition at line 92 of file Dbtag_.hpp.

Reimplemented in CTMgr_DTrackId_Base, CDbtag, and CTMgr_DTrackId.

Definition at line 81 of file Dbtag_.hpp.

Definition at line 93 of file Dbtag_.hpp.


Constructor & Destructor Documentation

Definition at line 87 of file Dbtag_.cpp.

References CObject::IsAllocatedInPool(), m_set_State, and ResetTag().

CDbtag_Base::~CDbtag_Base ( void  ) [virtual]

Definition at line 96 of file Dbtag_.cpp.


Member Function Documentation

bool CDbtag_Base::CanGetDb ( void  ) const [inline]
bool CDbtag_Base::CanGetTag ( void  ) const [inline]

Check if it is safe to call GetTag method.

Returns:
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 245 of file Dbtag_.hpp.

Referenced by CFlatNomenclatureQVal::Format(), CTableDataSNP::GetHtmlValue(), CTableDataSNP::GetIntValue(), CTableDataSNP::GetStringValue(), s_GetSRASeqMetadata(), SeqDB_SimplifySeqid(), CCommentItem::x_GatherDescInfo(), and CVcfWriter::x_WriteFeatureInfo().

Reimplemented in CTMgr_DTrackId_Base.

const CDbtag_Base::TDb & CDbtag_Base::GetDb ( void  ) const [inline]

Get the Db member data.

Returns:
Reference to the member data.

Definition at line 211 of file Dbtag_.hpp.

References CanGetDb(), m_Db, and CSerialObject::ThrowUnassigned().

Referenced by CSeq_id::AdjustScore(), BOOST_AUTO_TEST_CASE(), CDbtag::Compare(), CSeq_id::Compare(), CGuiObjectInfoSeq_id::CreateObject(), CSeqIdGuesser::CSeqIdGuesser(), CNewCleanup_imp::DbtagBC(), CSuspectRuleCheck::DoesSeqIDListMeetStringConstraint(), CSuspectRuleCheck::DoesTextMatchBankItId(), CBlastDBExtractor::ExtractAccession(), ExtractGnomonModelNum(), CBlastDBExtractor::ExtractSeqId(), CSeq_id_General_Tree::FindInfo(), CSeq_id_General_Tree::FindMatch(), CSeq_id_General_Tree::FindOrCreate(), CFlatNomenclatureQVal::Format(), CFlatXrefQVal::Format(), GetAccessionAndDatabaseSource(), GetCDDPssmIdFromSeqId(), CDbtag::GetDBFlags(), CWriteUtil::GetDbTag(), CAlignFormatUtil::GetDbType(), GetDirectLabel(), CAlignFormatUtil::GetDisplayIds(), variation::GetFocusLocusIDs(), CCSRABlobId::GetGeneralIdType(), CSeqIdGuesser::GetIdStrings(), CWriteUtil::GetIdType(), CDbtag::GetLabel(), GetLabel(), CSeq_featHandler::GetLabel(), CScope_Impl::GetTaxId(), CScope_Impl::GetTaxIds(), CDbtag::GetType(), CSeq_id::IdentifyAccession(), CDbtag::IsApproved(), CDbtag::IsApprovedNoCase(), CFeatGlyph::IsDbVar(), CGuiSeqInfoSeq_id::IsDNA(), CDbtag::IsSkippable(), CSGSequenceDS::IsTraceAssembly(), CId1Reader::LoadSeq_idBlob_ids(), CId1Reader::LoadSeq_idSeq_ids(), CDbtag::Match(), SSortReferenceByName::operator()(), CSeq_id_General_Str_Info::Parse(), SSNP_Info::ParseSeq_feat(), Residue::Residue(), variation::CVariationUtil::s_AttachGeneIDdbxref(), s_Fingerprint_Dbtag(), s_GetAlignmentTooltip(), s_GetFeatureIdLabel(), variation::CVariationUtil::CVariantPropertiesIndex::s_GetGeneID(), s_GtfDbtag(), s_IsSkippableDbtag(), SeqDB_SimplifySeqid(), CSeq_id::Set(), sx_GetReadId(), CBioseq_test_on_prot::TestOnObj(), CValidError_imp::ValidateDbxref(), CValidError_bioseq::ValidateSeqDescContext(), CValidError_bioseq::ValidateSeqId(), CValidError_imp::ValidateTaxonomy(), CSeq_id::WriteAsFasta(), CFeatureItem::x_AddFTableDbxref(), CFeatureItem::x_AddQualsVariation(), CWriteDB_IsamIndex::x_AddTraceIds(), x_Assign(), CGvfWriteRecord::x_AssignSource(), CSeq_id_Resolver__LRG::x_Create(), CSeq_id_General_Tree::x_FindInfo(), CCommentItem::x_GatherDescInfo(), CDBSourceItem::x_GatherInfo(), CFeatGlyph::x_GetFeatureId(), CSeqDBVol::x_GetHdrAsn1(), x_GetLabel_Content(), x_GetSourceName(), CPrimaryItem::x_GetStrForPrimary(), CId2ReaderBase::x_ProcessGetSeqIdSeqId(), CVcfWriter::x_WriteFeatureInfo(), CSrcWriter::xGatherDb(), and CSrcWriter::xGatherTaxonId().

const CDbtag_Base::TTag & CDbtag_Base::GetTag ( void  ) const [inline]

Get the Tag member data.

Returns:
Reference to the member data.

Definition at line 251 of file Dbtag_.hpp.

References m_Tag, and ResetTag().

Referenced by BOOST_AUTO_TEST_CASE(), CDbtag::Compare(), CSeqIdGuesser::CSeqIdGuesser(), CNewCleanup_imp::DbtagBC(), CSuspectRuleCheck::DoesSeqIDListMeetStringConstraint(), CSuspectRuleCheck::DoesTextMatchBankItId(), ExtractGnomonModelNum(), CSeq_id_General_Tree::FindInfo(), CSeq_id_General_Tree::FindMatch(), CSeq_id_General_Tree::FindOrCreate(), CFlatNomenclatureQVal::Format(), CScore_GeneID::Get(), GetAccessionAndDatabaseSource(), GetCDDPssmIdFromSeqId(), CWriteUtil::GetDbTag(), GetDirectLabel(), variation::GetFocusLocusIDs(), CCSRABlobId::GetGeneralIdType(), CCSRABlobId::GetGeneralSRAAccLabel(), CAlignFormatUtil::GetGnlID(), CTableDataSNP::GetHtmlValue(), CSeqIdGuesser::GetIdStrings(), CTableDataSNP::GetIntValue(), CDbtag::GetLabel(), GetLabel(), CSeq_featHandler::GetLabel(), CGuiObjectInfoVariant::GetLinks(), CGuiObjectInfoVariation::GetLinks(), CGuiObjectInfoSeq_feat::GetLinks(), CSuspectRuleCheck::GetmRNAforCDS(), CTraceChromatogramLoader::GetRecords(), NSnp::GetRsid(), CTableDataSNP::GetStringValue(), CScope_Impl::GetTaxId(), CScope_Impl::GetTaxIds(), GetTitle(), CGuiObjectInfoVariant::GetToolTip(), CDbtag::GetUrl(), CTraceDataProxy::LoadData(), CId1Reader::LoadSeq_idBlob_ids(), CId1Reader::LoadSeq_idSeq_ids(), CDbtag::Match(), CSeq_id_General_Id_Info::Pack(), CSeq_id_General_Str_Info::Pack(), CSeq_id_General_Str_Info::Parse(), SSNP_Info::ParseSeq_feat(), Residue::Residue(), variation::CVariationUtil::s_AttachGeneIDdbxref(), s_CheckTraceMateAlign(), s_Fingerprint_Dbtag(), s_GetContentLabel(), s_GetFeatureIdLabel(), variation::CVariationUtil::CVariantPropertiesIndex::s_GetGeneID(), s_GetSRASeqMetadata(), s_GtfDbtag(), s_HasTag(), s_IsSV(), SeqDB_SimplifySeqid(), CSeq_id::Set(), sx_GetReadId(), CValidError_imp::ValidateDbxref(), CValidError_bioseq::ValidateSeqId(), CValidError_imp::ValidateTaxonomy(), CSeq_id::WriteAsFasta(), CFeatureItem::x_AddFTableDbxref(), CFeatureItem::x_AddQualProteinId(), CFeatureItem::x_AddQualsVariation(), CWriteDB_IsamIndex::x_AddTraceIds(), x_Assign(), CDeltaBlastTestFixture::x_CountNumberUniqueIds(), CSeq_id_Resolver__LRG::x_Create(), CCreateGeneModelJob::x_CreateProjectItems(), CSeq_id_General_Tree::x_FindInfo(), CCommentItem::x_GatherDescInfo(), CGsdbComment::x_GatherInfo(), CFeatGlyph::x_GetFeatureId(), CSeqDBVol::x_GetHdrAsn1(), x_GetLabel_Content(), CId2ReaderBase::x_ProcessGetBlobId(), CId2ReaderBase::x_ProcessGetSeqIdSeqId(), CGeneModelFeatJob::x_ProcessLandMarkFeatures(), CDeflineGenerator::x_SetFlags(), CNewCleanup_imp::x_SplitDbtag(), CValidError_bioseq::x_ValidateLocusTagGeneralMatch(), CVcfWriter::x_WriteFeatureId(), CVcfWriter::x_WriteFeatureInfo(), CSrcWriter::xGatherDb(), and CSrcWriter::xGatherTaxonId().

bool CDbtag_Base::IsSetDb ( void  ) const [inline]
bool CDbtag_Base::IsSetTag ( void  ) const [inline]
CDbtag_Base& CDbtag_Base::operator= ( const CDbtag_Base ) [private]
void CDbtag_Base::Reset ( void  ) [virtual]

Reset the whole object.

Definition at line 71 of file Dbtag_.cpp.

References ResetDb(), and ResetTag().

void CDbtag_Base::ResetDb ( void  )

Reset Db data member.

Definition at line 51 of file Dbtag_.cpp.

References m_Db, and m_set_State.

Referenced by Reset().

void CDbtag_Base::ResetTag ( void  )

Reset Tag data member.

Definition at line 57 of file Dbtag_.cpp.

References m_Tag, and CRef< C, Locker >::Reset().

Referenced by CDbtag_Base(), GetTag(), Reset(), and SetTag().

void CDbtag_Base::SetDb ( const TDb value) [inline]
CDbtag_Base::TDb & CDbtag_Base::SetDb ( void  ) [inline]

Assign a value to Db data member.

Returns:
Reference to the data value.

Definition at line 227 of file Dbtag_.hpp.

References IsSetDb(), m_Db, m_set_State, and CSerialObject::UnassignedString().

CDbtag_Base::TTag & CDbtag_Base::SetTag ( void  ) [inline]

Assign a value to Tag data member.

Returns:
Reference to the data value.

Definition at line 260 of file Dbtag_.hpp.

References m_Tag, and ResetTag().


Member Data Documentation

Definition at line 185 of file Dbtag_.hpp.

Referenced by GetDb(), ResetDb(), and SetDb().

Definition at line 184 of file Dbtag_.hpp.

Referenced by CDbtag_Base(), IsSetDb(), ResetDb(), and SetDb().

Definition at line 186 of file Dbtag_.hpp.

Referenced by GetTag(), IsSetTag(), ResetTag(), and SetTag().


The documentation for this class was generated from the following files:
Modified on Wed Jul 09 16:59:46 2014 by modify_doxy.py rev. 426318