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

Search Toolkit Book for CSeqDB_MaxLengthWalker

Walker for MAX_SEQ_LENGTH field of alias file. More...

+ Inheritance diagram for CSeqDB_MaxLengthWalker:
+ Collaboration diagram for CSeqDB_MaxLengthWalker:

Public Member Functions

 CSeqDB_MaxLengthWalker ()
 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 GetMaxLength ()
 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

Walker for MAX_SEQ_LENGTH field of alias file.

This functor encapsulates the specifics of the MAX_SEQ_LENGTH field of the alias file. The NSEQ fields specifies the number of sequences to use when reporting information via the "CSeqDB::GetNumSeqs()" method. It is not the same as the number of OIDs unless there are no filtering mechanisms in use. (Note: this seems to be unused.)

Definition at line 1047 of file seqdbalias.cpp.

Constructor & Destructor Documentation

◆ CSeqDB_MaxLengthWalker()

CSeqDB_MaxLengthWalker::CSeqDB_MaxLengthWalker ( )
inline

Constructor.

Definition at line 1050 of file seqdbalias.cpp.

References m_Value.

Member Function Documentation

◆ Accumulate()

virtual void CSeqDB_MaxLengthWalker::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 1068 of file seqdbalias.cpp.

References CSeqDBVol::GetMaxLength(), and m_Value.

◆ AddString()

virtual void CSeqDB_MaxLengthWalker::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 1083 of file seqdbalias.cpp.

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

◆ GetFileKey()

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

This provides the alias file key used for this field.

Implements CSeqDB_AliasWalker.

Definition at line 1056 of file seqdbalias.cpp.

◆ GetMaxLength()

int CSeqDB_MaxLengthWalker::GetMaxLength ( )
inline

Returns the maximum sequence length.

Definition at line 1092 of file seqdbalias.cpp.

References m_Value.

Member Data Documentation

◆ m_Value

int CSeqDB_MaxLengthWalker::m_Value
private

The maximum sequence length.

Definition at line 1099 of file seqdbalias.cpp.

Referenced by Accumulate(), AddString(), CSeqDB_MaxLengthWalker(), and GetMaxLength().


The documentation for this class was generated from the following file:
Modified on Thu Feb 22 17:14:49 2024 by modify_doxy.py rev. 669887