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

Search Toolkit Book for CCitSubUpdater

#include <gui/widgets/edit/citsub_updater.hpp>

Static Public Member Functions

static CRef< objects::CSeqdesc > s_GetCitSubForUpdatedSequence (const objects::CBioseq_Handle &bsh, string &message, CConstRef< objects::CSeqdesc > &changedSeqdesc, objects::CSeq_entry_Handle &seh)
 Generates/Creates a Cit-sub publication that will be added to the sequence. More...
 
static CRef< objects::CSeqdesc > s_GetCitSubForTrimmedSequence (const objects::CBioseq_Handle &bsh, string &message, CConstRef< objects::CSeqdesc > &changedSeqdesc, objects::CSeq_entry_Handle &seh)
 

Static Public Attributes

static const char * sm_SubmitterUpdateText = "Sequence update by submitter"
 
static const char * sm_NoEarlierCitSub = "There is no earlier Cit-sub template"
 
static const char * sm_ChangeExistingCitSub = "Adding update indication to existing cit-sub"
 
static const char * sm_ExistingCitSub = "There already exists an update on today's date"
 
static const char * sm_AddedCitSub = "The update Cit-sub has been placed on the top Seq-entry"
 
static const char * sm_DifferentCitSub = "There already exists a Cit-sub having today's date with a description different than update"
 
static const char * sm_TrimmedText = "Sequence update by database staff to remove vector contamination"
 

Static Private Member Functions

static CRef< objects::CSeqdesc > sx_GetCitSubForSequence (const objects::CBioseq_Handle &bsh, string &message, CConstRef< objects::CSeqdesc > &changedSeqdesc, objects::CSeq_entry_Handle &seh, const CTempString &text)
 

Detailed Description

Definition at line 43 of file citsub_updater.hpp.

Member Function Documentation

◆ s_GetCitSubForTrimmedSequence()

CRef< CSeqdesc > CCitSubUpdater::s_GetCitSubForTrimmedSequence ( const objects::CBioseq_Handle &  bsh,
string message,
CConstRef< objects::CSeqdesc > &  changedSeqdesc,
objects::CSeq_entry_Handle &  seh 
)
static

Definition at line 91 of file citsub_updater.cpp.

References sm_TrimmedText, and sx_GetCitSubForSequence().

Referenced by CVectorTrimPanel::x_TrimSelected().

◆ s_GetCitSubForUpdatedSequence()

CRef< CSeqdesc > CCitSubUpdater::s_GetCitSubForUpdatedSequence ( const objects::CBioseq_Handle &  bsh,
string message,
CConstRef< objects::CSeqdesc > &  changedSeqdesc,
objects::CSeq_entry_Handle &  seh 
)
static

Generates/Creates a Cit-sub publication that will be added to the sequence.

Parameters
[in]bshSequence that will be receiving a Cit-sub publication
[out]messageInformation presented to the user
[out]changedSeqdescIf it's not null, it points to an existing publication that have to be removed before the new one is added
Returns
A publication descriptor that will be added to the sequence

Definition at line 86 of file citsub_updater.cpp.

References sm_SubmitterUpdateText, and sx_GetCitSubForSequence().

Referenced by CAddCitSubForUpdate::ApplyToCSeq_entry(), CEditSequenceEnds::GetCommand(), and CSequenceUpdater::x_AddCitSubToUpdatedSequence().

◆ sx_GetCitSubForSequence()

CRef< CSeqdesc > CCitSubUpdater::sx_GetCitSubForSequence ( const objects::CBioseq_Handle &  bsh,
string message,
CConstRef< objects::CSeqdesc > &  changedSeqdesc,
objects::CSeq_entry_Handle &  seh,
const CTempString text 
)
staticprivate

Member Data Documentation

◆ sm_AddedCitSub

const char * CCitSubUpdater::sm_AddedCitSub = "The update Cit-sub has been placed on the top Seq-entry"
static

Definition at line 67 of file citsub_updater.hpp.

Referenced by sx_GetCitSubForSequence().

◆ sm_ChangeExistingCitSub

const char * CCitSubUpdater::sm_ChangeExistingCitSub = "Adding update indication to existing cit-sub"
static

◆ sm_DifferentCitSub

const char * CCitSubUpdater::sm_DifferentCitSub = "There already exists a Cit-sub having today's date with a description different than update"
static

Definition at line 68 of file citsub_updater.hpp.

Referenced by sx_GetCitSubForSequence().

◆ sm_ExistingCitSub

const char * CCitSubUpdater::sm_ExistingCitSub = "There already exists an update on today's date"
static

◆ sm_NoEarlierCitSub

const char * CCitSubUpdater::sm_NoEarlierCitSub = "There is no earlier Cit-sub template"
static

Definition at line 64 of file citsub_updater.hpp.

Referenced by sx_GetCitSubForSequence().

◆ sm_SubmitterUpdateText

const char * CCitSubUpdater::sm_SubmitterUpdateText = "Sequence update by submitter"
static

Definition at line 63 of file citsub_updater.hpp.

Referenced by s_GetCitSubForUpdatedSequence().

◆ sm_TrimmedText

const char * CCitSubUpdater::sm_TrimmedText = "Sequence update by database staff to remove vector contamination"
static

Definition at line 70 of file citsub_updater.hpp.

Referenced by s_GetCitSubForTrimmedSequence().


The documentation for this class was generated from the following files:
Modified on Wed Jul 24 17:17:31 2024 by modify_doxy.py rev. 669887