NCBI C++ ToolKit
Public Member Functions | Protected Attributes | List of all members
CSrcQual Class Reference

Search Toolkit Book for CSrcQual

#include <gui/packages/pkg_sequence_edit/srcedit_util.hpp>

+ Inheritance diagram for CSrcQual:

Public Member Functions

 CSrcQual ()
 Constructors. More...
 
 CSrcQual (string name, bool required, bool report_missing, string example="")
 
virtual string GetValue (const objects::CBioSource &src)
 
virtual string GetFormatErrors (string value)
 
virtual string GetExample ()
 
void SetExample (string example)
 
string GetName (void)
 
bool IsRequired (void)
 
bool ReportMissing (void)
 
void SetRequired (bool required)
 
void SetReportMissing (bool report_missing)
 
virtual ~CSrcQual ()
 Destructor. More...
 

Protected Attributes

string m_Name
 
string m_Example
 
bool m_Required
 
bool m_ReportMissing
 

Detailed Description

Definition at line 62 of file srcedit_util.hpp.

Constructor & Destructor Documentation

◆ CSrcQual() [1/2]

CSrcQual::CSrcQual ( )

Constructors.

Definition at line 81 of file srcedit_util.cpp.

References m_Example, m_Name, m_ReportMissing, and m_Required.

◆ CSrcQual() [2/2]

CSrcQual::CSrcQual ( string  name,
bool  required,
bool  report_missing,
string  example = "" 
)

Definition at line 90 of file srcedit_util.cpp.

◆ ~CSrcQual()

CSrcQual::~CSrcQual ( )
virtual

Destructor.

Definition at line 95 of file srcedit_util.cpp.

Member Function Documentation

◆ GetExample()

virtual string CSrcQual::GetExample ( )
inlinevirtual

Definition at line 70 of file srcedit_util.hpp.

References m_Example.

◆ GetFormatErrors()

virtual string CSrcQual::GetFormatErrors ( string  value)
inlinevirtual

Reimplemented in CSubSrcQual, COrgModQual, CGenomeQual, CUnculturedTaxnameQual, and CTaxnameQual.

Definition at line 69 of file srcedit_util.hpp.

◆ GetName()

string CSrcQual::GetName ( void  )
inline

Definition at line 73 of file srcedit_util.hpp.

References m_Name.

◆ GetValue()

string CSrcQual::GetValue ( const objects::CBioSource &  src)
virtual

Reimplemented in CSubSrcQual, COrgModQual, CGenomeQual, and CTaxnameQual.

Definition at line 100 of file srcedit_util.cpp.

◆ IsRequired()

bool CSrcQual::IsRequired ( void  )
inline

Definition at line 74 of file srcedit_util.hpp.

References m_Required.

◆ ReportMissing()

bool CSrcQual::ReportMissing ( void  )
inline

Definition at line 75 of file srcedit_util.hpp.

References m_ReportMissing.

◆ SetExample()

void CSrcQual::SetExample ( string  example)
inline

Definition at line 71 of file srcedit_util.hpp.

References example, and m_Example.

◆ SetReportMissing()

void CSrcQual::SetReportMissing ( bool  report_missing)
inline

Definition at line 77 of file srcedit_util.hpp.

References m_ReportMissing.

◆ SetRequired()

void CSrcQual::SetRequired ( bool  required)
inline

Definition at line 76 of file srcedit_util.hpp.

References m_Required.

Member Data Documentation

◆ m_Example

string CSrcQual::m_Example
protected

Definition at line 84 of file srcedit_util.hpp.

Referenced by CSrcQual(), GetExample(), and SetExample().

◆ m_Name

string CSrcQual::m_Name
protected

Definition at line 83 of file srcedit_util.hpp.

Referenced by CSrcQual(), and GetName().

◆ m_ReportMissing

bool CSrcQual::m_ReportMissing
protected

Definition at line 86 of file srcedit_util.hpp.

Referenced by CSrcQual(), ReportMissing(), and SetReportMissing().

◆ m_Required

bool CSrcQual::m_Required
protected

Definition at line 85 of file srcedit_util.hpp.

Referenced by CSrcQual(), IsRequired(), and SetRequired().


The documentation for this class was generated from the following files:
Modified on Tue Dec 05 02:12:48 2023 by modify_doxy.py rev. 669887