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

Search Toolkit Book for CFeatListItem

CFeatListItem - basic configuration data for one "feature" type. More...

#include <objects/seqfeat/SeqFeatData.hpp>

Public Member Functions

 CFeatListItem ()
 
 CFeatListItem (int type, int subtype, const char *desc, const char *key)
 
bool operator< (const CFeatListItem &rhs) const
 CFeatListItem comparator to sort the set properly. More...
 
int GetType () const
 
int GetSubtype () const
 
string GetDescription () const
 
string GetStoragekey () const
 

Private Attributes

int m_Type = 0
 Feature type, or e_not_set for default values. More...
 
int m_Subtype = 0
 Feature subtype or eSubtype_any for default values. More...
 
string m_Description
 a string for display purposes. More...
 
string m_StorageKey
 a short string to use as a key or part of a key when storing a value by key/value string pairs. More...
 

Detailed Description

CFeatListItem - basic configuration data for one "feature" type.

"feature" expanded to include things that are not SeqFeats.

Definition at line 599 of file SeqFeatData.hpp.

Constructor & Destructor Documentation

◆ CFeatListItem() [1/2]

CFeatListItem::CFeatListItem ( )
inline

Definition at line 602 of file SeqFeatData.hpp.

◆ CFeatListItem() [2/2]

CFeatListItem::CFeatListItem ( int  type,
int  subtype,
const char *  desc,
const char *  key 
)
inline

Definition at line 603 of file SeqFeatData.hpp.

Member Function Documentation

◆ GetDescription()

string CFeatListItem::GetDescription ( void  ) const
inline

◆ GetStoragekey()

string CFeatListItem::GetStoragekey ( ) const
inline

◆ GetSubtype()

int CFeatListItem::GetSubtype ( void  ) const
inline

◆ GetType()

int CFeatListItem::GetType ( void  ) const
inline

◆ operator<()

bool CFeatListItem::operator< ( const CFeatListItem rhs) const

CFeatListItem comparator to sort the set properly.

Definition at line 4084 of file SeqFeatData.cpp.

References CSeqFeatData::eSubtype_any, m_Subtype, and m_Type.

Member Data Documentation

◆ m_Description

string CFeatListItem::m_Description
private

a string for display purposes.

Definition at line 619 of file SeqFeatData.hpp.

◆ m_StorageKey

string CFeatListItem::m_StorageKey
private

a short string to use as a key or part of a key when storing a value by key/value string pairs.

Definition at line 620 of file SeqFeatData.hpp.

◆ m_Subtype

int CFeatListItem::m_Subtype = 0
private

Feature subtype or eSubtype_any for default values.

Definition at line 618 of file SeqFeatData.hpp.

Referenced by operator<().

◆ m_Type

int CFeatListItem::m_Type = 0
private

Feature type, or e_not_set for default values.

Definition at line 617 of file SeqFeatData.hpp.

Referenced by operator<().


The documentation for this class was generated from the following files:
Modified on Sat Dec 02 09:23:54 2023 by modify_doxy.py rev. 669887