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

Search Toolkit Book for CSeqDB_MinLengthWalker

+ Inheritance diagram for CSeqDB_MinLengthWalker:
+ Collaboration diagram for CSeqDB_MinLengthWalker:

Public Member Functions

 CSeqDB_MinLengthWalker ()
 Constructor. More...
 
virtual const char * GetFileKey () const
 This provides the alias file key used for this field. More...
 
virtual void Accumulate (const CSeqDBVol &vol)
 Collect data from the volume. More...
 
virtual void AddString (const string &value)
 Collect data from an alias file. More...
 
int GetMinLength ()
 Returns the maximum sequence length. More...
 
- Public Member Functions inherited from CSeqDB_AliasWalker
virtual ~CSeqDB_AliasWalker ()
 Destructor. More...
 

Private Attributes

int m_Value
 The maximum sequence length. More...
 

Detailed Description

Definition at line 1102 of file seqdbalias.cpp.

Constructor & Destructor Documentation

◆ CSeqDB_MinLengthWalker()

CSeqDB_MinLengthWalker::CSeqDB_MinLengthWalker ( )
inline

Constructor.

Definition at line 1105 of file seqdbalias.cpp.

References INT4_MAX, and m_Value.

Member Function Documentation

◆ Accumulate()

virtual void CSeqDB_MinLengthWalker::Accumulate ( const CSeqDBVol vol)
inlinevirtual

Collect data from the volume.

If the MAX_SEQ_LENGTH field is not specified in an alias file, the maximum values of all contributing volumes is used.

Parameters
volA database volume

Implements CSeqDB_AliasWalker.

Definition at line 1123 of file seqdbalias.cpp.

References CSeqDBVol::GetMinLength(), and m_Value.

◆ AddString()

virtual void CSeqDB_MinLengthWalker::AddString ( const string value)
inlinevirtual

Collect data from an alias file.

Values from alias node tree siblings are compared, and the maximum value is used as the result.

Parameters
valueA database volume

Implements CSeqDB_AliasWalker.

Definition at line 1139 of file seqdbalias.cpp.

References m_Value, NStr::StringToUInt(), and value.

◆ GetFileKey()

virtual const char* CSeqDB_MinLengthWalker::GetFileKey ( ) const
inlinevirtual

This provides the alias file key used for this field.

Implements CSeqDB_AliasWalker.

Definition at line 1111 of file seqdbalias.cpp.

◆ GetMinLength()

int CSeqDB_MinLengthWalker::GetMinLength ( )
inline

Returns the maximum sequence length.

Definition at line 1149 of file seqdbalias.cpp.

References m_Value.

Referenced by CSeqDBAliasNode::GetMinLength().

Member Data Documentation

◆ m_Value

int CSeqDB_MinLengthWalker::m_Value
private

The maximum sequence length.

Definition at line 1156 of file seqdbalias.cpp.

Referenced by Accumulate(), AddString(), CSeqDB_MinLengthWalker(), and GetMinLength().


The documentation for this class was generated from the following file:
Modified on Fri Feb 23 11:45:26 2024 by modify_doxy.py rev. 669887