NCBI C++ ToolKit
Classes | Typedefs | Enumerations | Enumerator | Functions | Variables
Code generated by DATATOOL from 'seqfeat.asn' (module 'NCBI-Protein')
+ Collaboration diagram for Code generated by DATATOOL from 'seqfeat.asn' (module 'NCBI-Protein'):

Classes

class  CProt_ref_Base
 *** Prot-ref *********************************************** * * Reference to a protein name * More...
 

Typedefs

typedef CSerialObject CProt_ref_Base::Tparent
 
typedef list< stringCProt_ref_Base::TName
 
typedef string CProt_ref_Base::TDesc
 
typedef list< stringCProt_ref_Base::TEc
 
typedef list< stringCProt_ref_Base::TActivity
 
typedef vector< CRef< CDbtag > > CProt_ref_Base::TDb
 
typedef EProcessed CProt_ref_Base::TProcessed
 
typedef Tparent::CMemberIndex< E_memberIndex, 7 > CProt_ref_Base::TmemberIndex
 

Enumerations

enum  CProt_ref_Base::EProcessed {
  CProt_ref_Base::eProcessed_not_set = 0 , CProt_ref_Base::eProcessed_preprotein = 1 , CProt_ref_Base::eProcessed_mature = 2 , CProt_ref_Base::eProcessed_signal_peptide = 3 ,
  CProt_ref_Base::eProcessed_transit_peptide = 4 , CProt_ref_Base::eProcessed_propeptide = 5
}
 processing status More...
 
enum class  CProt_ref_Base::E_memberIndex {
  CProt_ref_Base::e__allMandatory = 0 , CProt_ref_Base::e_name , CProt_ref_Base::e_desc , CProt_ref_Base::e_ec ,
  CProt_ref_Base::e_activity , CProt_ref_Base::e_db , CProt_ref_Base::e_processed
}
 

Functions

 CProt_ref_Base::CProt_ref_Base (void)
 
virtual CProt_ref_Base::~CProt_ref_Base (void)
 
 CProt_ref_Base::DECLARE_INTERNAL_TYPE_INFO ()
 
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() CProt_ref_Base::EProcessed (void)
 Access to EProcessed's attributes (values, names) as defined in spec. More...
 
bool CProt_ref_Base::IsSetName (void) const
 protein name Check if a value has been assigned to Name data member. More...
 
bool CProt_ref_Base::CanGetName (void) const
 Check if it is safe to call GetName method. More...
 
void CProt_ref_Base::ResetName (void)
 Reset Name data member. More...
 
const TNameCProt_ref_Base::GetName (void) const
 Get the Name member data. More...
 
TNameCProt_ref_Base::SetName (void)
 Assign a value to Name data member. More...
 
bool CProt_ref_Base::IsSetDesc (void) const
 description (instead of name) Check if a value has been assigned to Desc data member. More...
 
bool CProt_ref_Base::CanGetDesc (void) const
 Check if it is safe to call GetDesc method. More...
 
void CProt_ref_Base::ResetDesc (void)
 Reset Desc data member. More...
 
const TDescCProt_ref_Base::GetDesc (void) const
 Get the Desc member data. More...
 
void CProt_ref_Base::SetDesc (const TDesc &value)
 Assign a value to Desc data member. More...
 
void CProt_ref_Base::SetDesc (TDesc &&value)
 
TDescCProt_ref_Base::SetDesc (void)
 Assign a value to Desc data member. More...
 
bool CProt_ref_Base::IsSetEc (void) const
 E.C. More...
 
bool CProt_ref_Base::CanGetEc (void) const
 Check if it is safe to call GetEc method. More...
 
void CProt_ref_Base::ResetEc (void)
 Reset Ec data member. More...
 
const TEcCProt_ref_Base::GetEc (void) const
 Get the Ec member data. More...
 
TEcCProt_ref_Base::SetEc (void)
 Assign a value to Ec data member. More...
 
bool CProt_ref_Base::IsSetActivity (void) const
 activities Check if a value has been assigned to Activity data member. More...
 
bool CProt_ref_Base::CanGetActivity (void) const
 Check if it is safe to call GetActivity method. More...
 
void CProt_ref_Base::ResetActivity (void)
 Reset Activity data member. More...
 
const TActivityCProt_ref_Base::GetActivity (void) const
 Get the Activity member data. More...
 
TActivityCProt_ref_Base::SetActivity (void)
 Assign a value to Activity data member. More...
 
bool CProt_ref_Base::IsSetDb (void) const
 ids in other dbases Check if a value has been assigned to Db data member. More...
 
bool CProt_ref_Base::CanGetDb (void) const
 Check if it is safe to call GetDb method. More...
 
void CProt_ref_Base::ResetDb (void)
 Reset Db data member. More...
 
const TDbCProt_ref_Base::GetDb (void) const
 Get the Db member data. More...
 
TDbCProt_ref_Base::SetDb (void)
 Assign a value to Db data member. More...
 
bool CProt_ref_Base::IsSetProcessed (void) const
 Check if a value has been assigned to Processed data member. More...
 
bool CProt_ref_Base::CanGetProcessed (void) const
 Check if it is safe to call GetProcessed method. More...
 
void CProt_ref_Base::ResetProcessed (void)
 Reset Processed data member. More...
 
void CProt_ref_Base::SetDefaultProcessed (void)
 Assign default value to Processed data member. More...
 
TProcessed CProt_ref_Base::GetProcessed (void) const
 Get the Processed member data. More...
 
void CProt_ref_Base::SetProcessed (TProcessed value)
 Assign a value to Processed data member. More...
 
TProcessedCProt_ref_Base::SetProcessed (void)
 Assign a value to Processed data member. More...
 
virtual void CProt_ref_Base::Reset (void)
 Reset the whole object. More...
 
 CProt_ref_Base::CProt_ref_Base (const CProt_ref_Base &)
 
CProt_ref_BaseCProt_ref_Base::operator= (const CProt_ref_Base &)
 

Variables

Uint4 CProt_ref_Base::m_set_State [1]
 
list< stringCProt_ref_Base::m_Name
 
string CProt_ref_Base::m_Desc
 
list< stringCProt_ref_Base::m_Ec
 
list< stringCProt_ref_Base::m_Activity
 
vector< CRef< CDbtag > > CProt_ref_Base::m_Db
 
EProcessed CProt_ref_Base::m_Processed
 

Detailed Description

Typedef Documentation

◆ TActivity

Definition at line 111 of file Prot_ref_.hpp.

◆ TDb

typedef vector< CRef< CDbtag > > CProt_ref_Base::TDb

Definition at line 112 of file Prot_ref_.hpp.

◆ TDesc

Definition at line 109 of file Prot_ref_.hpp.

◆ TEc

typedef list< string > CProt_ref_Base::TEc

Definition at line 110 of file Prot_ref_.hpp.

◆ TmemberIndex

Definition at line 125 of file Prot_ref_.hpp.

◆ TName

typedef list< string > CProt_ref_Base::TName

Definition at line 108 of file Prot_ref_.hpp.

◆ Tparent

Definition at line 84 of file Prot_ref_.hpp.

◆ TProcessed

Definition at line 113 of file Prot_ref_.hpp.

Enumeration Type Documentation

◆ E_memberIndex

Enumerator
e__allMandatory 
e_name 
e_desc 
e_ec 
e_activity 
e_db 
e_processed 

Definition at line 116 of file Prot_ref_.hpp.

◆ EProcessed

processing status

Enumerator
eProcessed_not_set 
eProcessed_preprotein 
eProcessed_mature 
eProcessed_signal_peptide 
eProcessed_transit_peptide 
eProcessed_propeptide 

Definition at line 95 of file Prot_ref_.hpp.

Function Documentation

◆ CanGetActivity()

bool CProt_ref_Base::CanGetActivity ( void  ) const
inline

Check if it is safe to call GetActivity method.

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

Definition at line 469 of file Prot_ref_.hpp.

◆ CanGetDb()

bool CProt_ref_Base::CanGetDb ( void  ) const
inline

Check if it is safe to call GetDb method.

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

Definition at line 494 of file Prot_ref_.hpp.

◆ CanGetDesc()

bool CProt_ref_Base::CanGetDesc ( void  ) const
inline

Check if it is safe to call GetDesc method.

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

Definition at line 397 of file Prot_ref_.hpp.

References CProt_ref_Base::IsSetDesc().

Referenced by CProt_ref_Base::GetDesc().

◆ CanGetEc()

bool CProt_ref_Base::CanGetEc ( void  ) const
inline

Check if it is safe to call GetEc method.

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

Definition at line 444 of file Prot_ref_.hpp.

◆ CanGetName()

bool CProt_ref_Base::CanGetName ( void  ) const
inline

Check if it is safe to call GetName method.

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

Definition at line 372 of file Prot_ref_.hpp.

Referenced by GetProduct().

◆ CanGetProcessed()

bool CProt_ref_Base::CanGetProcessed ( void  ) const
inline

Check if it is safe to call GetProcessed method.

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

Definition at line 519 of file Prot_ref_.hpp.

◆ CProt_ref_Base() [1/2]

CProt_ref_Base::CProt_ref_Base ( const CProt_ref_Base )
private

◆ CProt_ref_Base() [2/2]

END_CLASS_INFO CProt_ref_Base::CProt_ref_Base ( void  )

Definition at line 120 of file Prot_ref_.cpp.

References CProt_ref_Base::m_set_State.

◆ DECLARE_INTERNAL_TYPE_INFO()

CProt_ref_Base::DECLARE_INTERNAL_TYPE_INFO ( )

◆ EProcessed()

static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME() CProt_ref_Base::EProcessed ( void  )
static

Access to EProcessed's attributes (values, names) as defined in spec.

◆ GetActivity()

const CProt_ref_Base::TActivity & CProt_ref_Base::GetActivity ( void  ) const
inline

Get the Activity member data.

Returns
Reference to the member data.

Definition at line 475 of file Prot_ref_.hpp.

References CProt_ref_Base::m_Activity.

Referenced by CProtRefColumn::GetFromFeat(), s_AppendProtRefInfo(), CFeatureItem::x_AddFTableProtQuals(), CFeatureItem::x_AddQualProtActivity(), and CFeatureItem::x_AddQualsProt().

◆ GetDb()

const CProt_ref_Base::TDb & CProt_ref_Base::GetDb ( void  ) const
inline

Get the Db member data.

Returns
Reference to the member data.

Definition at line 500 of file Prot_ref_.hpp.

References CProt_ref_Base::m_Db.

Referenced by CProt_ref::GetLabel(), and s_AppendProtRefInfo().

◆ GetDesc()

const CProt_ref_Base::TDesc & CProt_ref_Base::GetDesc ( void  ) const
inline

◆ GetEc()

const CProt_ref_Base::TEc & CProt_ref_Base::GetEc ( void  ) const
inline

◆ GetName()

const CProt_ref_Base::TName & CProt_ref_Base::GetName ( void  ) const
inline

Get the Name member data.

Returns
Reference to the member data.

Definition at line 378 of file Prot_ref_.hpp.

References CProt_ref_Base::m_Name.

Referenced by CProductColumn::AddToFeature(), CProtRefColumn::AddToFeature(), BOOST_AUTO_TEST_CASE(), ConvertProteinToImp(), CTruncateCDS::GetCommand(), CEntrezgene::GetDescription(), CProductColumn::GetFromFeat(), CProtRefColumn::GetFromFeat(), CProt_ref::GetLabel(), GetProduct(), LookForProductName(), s_AppendProtRefInfo(), s_NotPeptideException(), s_TitleFromSegment(), CCleanup::SetProteinName(), CMacroFunction_SwapRelFeatQual::TheFunction(), CMacroFunction_SetRelFeatQual::TheFunction(), CMacroFunction_ConvertFeatQual::TheFunction(), CMacroFunction_ParseFeatQual::TheFunction(), CMacroFunction_CopyFeatQual::TheFunction(), CMacroFunction_RemoveOutside::TheFunction(), CMacroFunction_RmvOutsideRelFeatQual::TheFunction(), CMacroFunction_ReplaceStopWithSelenocysteine::TheFunction(), UpdatemRNAProduct(), CValidError_bioseq::ValidateRawConst(), CFeatureItem::x_AddFTableProtQuals(), CGeneFeatFromOtherFeatDlg::x_AddGeneQuals(), CFastaOstreamEx::x_AddProteinNameAttribute(), CFeatureItem::x_AddQualCdsProduct(), CFeatureItem::x_AddQualsProt(), CCmdFeatIdXrefsFromQualifiers::x_CreateActionCmd(), CValidErrorFormat::x_FormatECNumberForSubmitterReport(), CAutoDefFeatureClause::x_GetProductName(), CProtValidator::x_ReportUninformativeNames(), CEditObjectSeq_feat::x_UpdatemRNA(), CGff2Writer::xAssignFeatureAttributeProduct(), CFeatTableEdit::xGenerate_mRNA_Product(), CFeatureTableReader::xTranslateProtein(), and CGff3Writer::xWriteProteinFeature().

◆ GetProcessed()

CProt_ref_Base::TProcessed CProt_ref_Base::GetProcessed ( void  ) const
inline

◆ IsSetActivity()

bool CProt_ref_Base::IsSetActivity ( void  ) const
inline

activities Check if a value has been assigned to Activity data member.

Data member Activity is optional; its type is defined as 'typedef list< string > TActivity'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 463 of file Prot_ref_.hpp.

References CProt_ref_Base::m_set_State.

Referenced by CProtRefColumn::AddToFeature(), CProtRefColumn::GetFromFeat(), CFindASN1Dlg::ReplaceInFeature(), s_AppendProtRefInfo(), CFeatureItem::x_AddQualsProt(), and CAutogeneratedCleanup::x_BasicCleanupProtRef().

◆ IsSetDb()

bool CProt_ref_Base::IsSetDb ( void  ) const
inline

ids in other dbases Check if a value has been assigned to Db data member.

Data member Db is optional; its type is defined as 'typedef vector< CRef< CDbtag > > TDb'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 488 of file Prot_ref_.hpp.

References CProt_ref_Base::m_set_State.

Referenced by CProt_ref::GetLabel(), CNewCleanup_imp::ProtFeatfBC(), CFindASN1Dlg::ReplaceInFeature(), and s_AppendProtRefInfo().

◆ IsSetDesc()

bool CProt_ref_Base::IsSetDesc ( void  ) const
inline

◆ IsSetEc()

bool CProt_ref_Base::IsSetEc ( void  ) const
inline

◆ IsSetName()

bool CProt_ref_Base::IsSetName ( void  ) const
inline

protein name Check if a value has been assigned to Name data member.

Data member Name is optional; its type is defined as 'typedef list< string > TName'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 366 of file Prot_ref_.hpp.

References CProt_ref_Base::m_set_State.

Referenced by CProductColumn::AddToFeature(), CProtRefColumn::AddToFeature(), CFixProductNames::apply(), CProductColumn::ClearInFeature(), ConvertProteinToImp(), CTruncateCDS::GetCommand(), CProductColumn::GetFromFeat(), CProtRefColumn::GetFromFeat(), CProt_ref::GetLabel(), LookForProductName(), CCleanup::MoveFeatToProtein(), CSuspectProductRulesEditor::OnApplyFixes(), CSuspectProductRulesEditor::OnListMatches(), CNewCleanup_imp::ProtrefBC(), CFindASN1Dlg::ReplaceInFeature(), RescueProtProductQual(), s_AppendProtRefInfo(), s_NotPeptideException(), s_SetProtRef(), s_TitleFromSegment(), CCleanup::SetProteinName(), CMacroFunction_ReplaceStopWithSelenocysteine::TheFunction(), UpdatemRNAProduct(), CGeneFeatFromOtherFeatDlg::x_AddGeneQuals(), CFastaOstreamEx::x_AddProteinNameAttribute(), CFeatureItem::x_AddQualsProt(), CAutogeneratedCleanup::x_BasicCleanupProtRef(), CCmdFeatIdXrefsFromQualifiers::x_CreateActionCmd(), CValidErrorFormat::x_FormatECNumberForSubmitterReport(), CAutoDefFeatureClause::x_GetProductName(), CEditObjectSeq_feat::x_UpdatemRNA(), CGff2Writer::xAssignFeatureAttributeProduct(), CFeatTableEdit::xGenerate_mRNA_Product(), CFeatureTableReader::xTranslateProtein(), and CGff3Writer::xWriteProteinFeature().

◆ IsSetProcessed()

bool CProt_ref_Base::IsSetProcessed ( void  ) const
inline

◆ operator=()

CProt_ref_Base& CProt_ref_Base::operator= ( const CProt_ref_Base )
private

◆ Reset()

void CProt_ref_Base::Reset ( void  )
virtual

◆ ResetActivity()

void CProt_ref_Base::ResetActivity ( void  )

Reset Activity data member.

Definition at line 82 of file Prot_ref_.cpp.

References CProt_ref_Base::m_Activity, and CProt_ref_Base::m_set_State.

Referenced by CProt_ref_Base::Reset().

◆ ResetDb()

void CProt_ref_Base::ResetDb ( void  )

Reset Db data member.

Definition at line 88 of file Prot_ref_.cpp.

References CProt_ref_Base::m_Db, and CProt_ref_Base::m_set_State.

Referenced by CNewCleanup_imp::ProtFeatfBC(), and CProt_ref_Base::Reset().

◆ ResetDesc()

void CProt_ref_Base::ResetDesc ( void  )

◆ ResetEc()

void CProt_ref_Base::ResetEc ( void  )

Reset Ec data member.

Definition at line 76 of file Prot_ref_.cpp.

References CProt_ref_Base::m_Ec, and CProt_ref_Base::m_set_State.

Referenced by CProt_ref::RemoveBadEC(), and CProt_ref_Base::Reset().

◆ ResetName()

END_ENUM_INFO void CProt_ref_Base::ResetName ( void  )

Reset Name data member.

Definition at line 64 of file Prot_ref_.cpp.

References CProt_ref_Base::m_Name, and CProt_ref_Base::m_set_State.

Referenced by CProt_ref_Base::Reset().

◆ ResetProcessed()

void CProt_ref_Base::ResetProcessed ( void  )
inline

◆ SetActivity()

CProt_ref_Base::TActivity & CProt_ref_Base::SetActivity ( void  )
inline

Assign a value to Activity data member.

Returns
Reference to the data value.

Definition at line 481 of file Prot_ref_.hpp.

References CProt_ref_Base::m_Activity, and CProt_ref_Base::m_set_State.

Referenced by CkCdRegion(), GetProtRefAnnot(), s_AppendProtRefInfo(), CFeatureTableReader_Imp::x_AddQualifierToCdregion(), and CAutogeneratedCleanup::x_BasicCleanupProtRef().

◆ SetDb()

CProt_ref_Base::TDb & CProt_ref_Base::SetDb ( void  )
inline

Assign a value to Db data member.

Returns
Reference to the data value.

Definition at line 506 of file Prot_ref_.hpp.

References CProt_ref_Base::m_Db, and CProt_ref_Base::m_set_State.

Referenced by CNewCleanup_imp::ProtFeatfBC(), and s_AppendProtRefInfo().

◆ SetDefaultProcessed()

void CProt_ref_Base::SetDefaultProcessed ( void  )
inline

Assign default value to Processed data member.

Definition at line 532 of file Prot_ref_.hpp.

References CProt_ref_Base::ResetProcessed().

◆ SetDesc() [1/3]

void CProt_ref_Base::SetDesc ( const TDesc value)
inline

◆ SetDesc() [2/3]

void CProt_ref_Base::SetDesc ( CProt_ref_Base::TDesc &&  value)
inline

◆ SetDesc() [3/3]

CProt_ref_Base::TDesc & CProt_ref_Base::SetDesc ( void  )
inline

Assign a value to Desc data member.

Returns
Reference to the data value.

Definition at line 426 of file Prot_ref_.hpp.

References CProt_ref_Base::IsSetDesc(), CProt_ref_Base::m_Desc, CProt_ref_Base::m_set_State, and CSerialObject::UnassignedString().

◆ SetEc()

CProt_ref_Base::TEc & CProt_ref_Base::SetEc ( void  )
inline

◆ SetName()

CProt_ref_Base::TName & CProt_ref_Base::SetName ( void  )
inline

◆ SetProcessed() [1/2]

void CProt_ref_Base::SetProcessed ( CProt_ref_Base::TProcessed  value)
inline

Assign a value to Processed data member.

Parameters
valueValue to assign

Definition at line 544 of file Prot_ref_.hpp.

References CProt_ref_Base::m_Processed, CProt_ref_Base::m_set_State, and rapidjson::value.

Referenced by CNewCleanup_imp::ImpFeatBC(), s_AppendProtRefInfo(), and CFeatureTableReader_Imp::x_SetupSeqFeat().

◆ SetProcessed() [2/2]

CProt_ref_Base::TProcessed & CProt_ref_Base::SetProcessed ( void  )
inline

Assign a value to Processed data member.

Returns
Reference to the data value.

Definition at line 551 of file Prot_ref_.hpp.

References CProt_ref_Base::IsSetProcessed(), CProt_ref_Base::m_Processed, CProt_ref_Base::m_set_State, and CSerialObject::UnassignedByte().

◆ ~CProt_ref_Base()

CProt_ref_Base::~CProt_ref_Base ( void  )
virtual

Definition at line 127 of file Prot_ref_.cpp.

Variable Documentation

◆ m_Activity

list< string > CProt_ref_Base::m_Activity
private

◆ m_Db

vector< CRef< CDbtag > > CProt_ref_Base::m_Db
private

◆ m_Desc

string CProt_ref_Base::m_Desc
private

◆ m_Ec

list< string > CProt_ref_Base::m_Ec
private

◆ m_Name

list< string > CProt_ref_Base::m_Name
private

◆ m_Processed

EProcessed CProt_ref_Base::m_Processed
private

◆ m_set_State

Uint4 CProt_ref_Base::m_set_State[1]
private
Modified on Sat Apr 13 11:44:26 2024 by modify_doxy.py rev. 669887