NCBI C++ ToolKit
Public Member Functions | List of all members
CCommentDescField Class Reference

Search Toolkit Book for CCommentDescField

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

+ Inheritance diagram for CCommentDescField:
+ Collaboration diagram for CCommentDescField:

Public Member Functions

 CCommentDescField ()
 
virtual string GetVal (const CObject &object)
 
virtual vector< stringGetVals (const CObject &object)
 
virtual bool IsEmpty (const CObject &object) const
 
virtual void ClearVal (CObject &object)
 
virtual bool SetVal (CObject &object, const string &val, objects::edit::EExistingText existing_text)
 
 CCommentDescField ()
 
string GetVal (const CObject &object) override
 
vector< stringGetVals (const CObject &object) override
 
bool IsEmpty (const CObject &object) const override
 
void ClearVal (CObject &object) override
 
bool SetVal (CObject &object, const string &val, EExistingText existing_text) override
 
- Public Member Functions inherited from CTextDescriptorField
virtual vector< CConstRef< CObject > > GetObjects (objects::CBioseq_Handle bsh)
 
virtual vector< CConstRef< CObject > > GetObjects (objects::CSeq_entry_Handle seh, const string &constraint_field, CRef< objects::edit::CStringConstraint > string_constraint)
 
virtual vector< CRef< objects::edit::CApplyObject > > GetApplyObjects (objects::CBioseq_Handle bsh)
 
virtual vector< CConstRef< CObject > > GetRelatedObjects (const CObject &object, CRef< objects::CScope > scope)
 
virtual vector< CConstRef< CObject > > GetRelatedObjects (const objects::edit::CApplyObject &object)
 
virtual objects::CSeqFeatData::ESubtype GetFeatureSubtype ()
 
virtual objects::CSeqdesc::E_Choice GetDescriptorSubtype ()
 
virtual void SetConstraint (const string &field_name, CConstRef< objects::edit::CStringConstraint > string_constraint)
 
objects::CSeqdesc::E_Choice GetSubtype ()
 
void SetSubtype (objects::CSeqdesc::E_Choice subtype)
 
virtual bool AllowMultipleValues ()
 
vector< CConstRef< CObject > > GetObjects (CBioseq_Handle bsh) override
 
vector< CConstRef< CObject > > GetObjects (CSeq_entry_Handle seh, const string &constraint_field, CRef< CStringConstraint > string_constraint) override
 
vector< CRef< CApplyObject > > GetApplyObjects (CBioseq_Handle bsh) override
 
vector< CConstRef< CObject > > GetRelatedObjects (const CObject &object, CRef< CScope > scope) override
 
vector< CConstRef< CObject > > GetRelatedObjects (const CApplyObject &object) override
 
CSeqFeatData::ESubtype GetFeatureSubtype () override
 
CSeqdesc::E_Choice GetDescriptorSubtype () override
 
void SetConstraint (const string &field_name, CConstRef< CStringConstraint > string_constraint) override
 
bool AllowMultipleValues () override
 
CSeqdesc::E_Choice GetSubtype ()
 
void SetSubtype (CSeqdesc::E_Choice subtype)
 
- Public Member Functions inherited from CFieldHandler
virtual string IsValid (const string &val)
 
virtual vector< stringIsValid (const vector< string > &values)
 
void SetScope (CRef< CScope > scope)
 
virtual string IsValid (const string &)
 
virtual vector< stringIsValid (const vector< string > &)
 
virtual vector< CRef< CApplyObject > > GetRelatedApplyObjects (const CObject &object, CRef< CScope > scope)
 
- 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...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. 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
 

Additional Inherited Members

- 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...
 
- Static Public Member Functions inherited from CFieldHandler
static bool QualifierNamesAreEquivalent (string name1, string name2)
 
static vector< CRef< CApplyObject > > GetApplyObjectsFromRelatedObjects (vector< CConstRef< CObject >>, CRef< CScope > scope)
 
- 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)
 
- 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...
 
- Protected Attributes inherited from CTextDescriptorField
objects::CSeqdesc::E_Choice m_Subtype
 
CSeqdesc::E_Choice m_Subtype
 
- Protected Attributes inherited from CFieldHandler
CRef< CScopem_Scope
 

Detailed Description

Definition at line 85 of file miscedit_util.hpp.

Constructor & Destructor Documentation

◆ CCommentDescField() [1/2]

CCommentDescField::CCommentDescField ( )
inline

Definition at line 88 of file miscedit_util.hpp.

References CTextDescriptorField::m_Subtype.

◆ CCommentDescField() [2/2]

CCommentDescField::CCommentDescField ( )
inline

Member Function Documentation

◆ ClearVal() [1/2]

void CCommentDescField::ClearVal ( CObject object)
virtual

Implements CFieldHandler.

Definition at line 323 of file miscedit_util.cpp.

References CSeqdesc_Base::SetComment().

◆ ClearVal() [2/2]

void CCommentDescField::ClearVal ( CObject object)
overridevirtual

Implements CFieldHandler.

◆ GetVal() [1/2]

string CCommentDescField::GetVal ( const CObject object)
virtual

Implements CFieldHandler.

Definition at line 292 of file miscedit_util.cpp.

References CSeqdesc_Base::GetComment(), and CSeqdesc_Base::IsComment().

Referenced by GetVals().

◆ GetVal() [2/2]

string CCommentDescField::GetVal ( const CObject object)
overridevirtual

Implements CFieldHandler.

◆ GetVals() [1/2]

vector< string > CCommentDescField::GetVals ( const CObject object)
virtual

Implements CFieldHandler.

Definition at line 303 of file miscedit_util.cpp.

References GetVal().

◆ GetVals() [2/2]

vector<string> CCommentDescField::GetVals ( const CObject object)
overridevirtual

Implements CFieldHandler.

◆ IsEmpty() [1/2]

bool CCommentDescField::IsEmpty ( const CObject object) const
virtual

◆ IsEmpty() [2/2]

bool CCommentDescField::IsEmpty ( const CObject object) const
overridevirtual

Implements CFieldHandler.

◆ SetVal() [1/2]

bool CCommentDescField::SetVal ( CObject object,
const string val,
EExistingText  existing_text 
)
overridevirtual

◆ SetVal() [2/2]

virtual bool CCommentDescField::SetVal ( CObject object,
const string val,
objects::edit::EExistingText  existing_text 
)
virtual

Implements CFieldHandler.


The documentation for this class was generated from the following files:
Modified on Fri May 03 15:53:58 2024 by modify_doxy.py rev. 669887