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

Search Toolkit Book for CSeqDB_OidMaskTypeWalker

Walker for oid mask type. More...

+ Inheritance diagram for CSeqDB_OidMaskTypeWalker:
+ Collaboration diagram for CSeqDB_OidMaskTypeWalker:

Public Member Functions

 CSeqDB_OidMaskTypeWalker ()
 Constructor. More...
 
virtual const char * GetFileKey () const
 This provides the alias file key used for this field. More...
 
virtual void Accumulate (const CSeqDBVol &)
 Collect data from the volume. More...
 
virtual void AddString (const string &value)
 Collect data from an alias file. More...
 
int GetOidMaskType () const
 Returns the oid mask type. More...
 
- Public Member Functions inherited from CSeqDB_AliasWalker
virtual ~CSeqDB_AliasWalker ()
 Destructor. More...
 

Private Attributes

int m_Value
 The oid mask type. More...
 

Detailed Description

Walker for oid mask type.

This just searches alias files for the oid mask type if one is specified.

Definition at line 1422 of file seqdbalias.cpp.

Constructor & Destructor Documentation

◆ CSeqDB_OidMaskTypeWalker()

CSeqDB_OidMaskTypeWalker::CSeqDB_OidMaskTypeWalker ( )
inline

Constructor.

Definition at line 1425 of file seqdbalias.cpp.

References m_Value.

Member Function Documentation

◆ Accumulate()

virtual void CSeqDB_OidMaskTypeWalker::Accumulate ( const CSeqDBVol )
inlinevirtual

Collect data from the volume.

If the MEMB_BIT field is not specified in an alias file, then it is not needed. This field is intended to allow filtration of deflines by taxonomic category, which is only needed if an alias file reduces the taxonomic scope.

Implements CSeqDB_AliasWalker.

Definition at line 1442 of file seqdbalias.cpp.

◆ AddString()

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

Collect data from an alias file.

If the MEMB_BIT field is specified in an alias file, it will be used unmodified. No attempt is made to combine or collect bit values - currently, only one can be used at a time.

Parameters
valueA database volume

Implements CSeqDB_AliasWalker.

Definition at line 1455 of file seqdbalias.cpp.

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

◆ GetFileKey()

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

This provides the alias file key used for this field.

Implements CSeqDB_AliasWalker.

Definition at line 1431 of file seqdbalias.cpp.

◆ GetOidMaskType()

int CSeqDB_OidMaskTypeWalker::GetOidMaskType ( ) const
inline

Returns the oid mask type.

Definition at line 1461 of file seqdbalias.cpp.

References m_Value.

Referenced by CSeqDBAliasNode::GetOidMaskType().

Member Data Documentation

◆ m_Value

int CSeqDB_OidMaskTypeWalker::m_Value
private

The oid mask type.

Definition at line 1468 of file seqdbalias.cpp.

Referenced by AddString(), CSeqDB_OidMaskTypeWalker(), and GetOidMaskType().


The documentation for this class was generated from the following file:
Modified on Fri Mar 01 10:06:23 2024 by modify_doxy.py rev. 669887