Search Toolkit Book for CWinMaskUtil::CIdSet
Base class for sets of seq_id representations used with -ids and -exclude-ids options. More...
#include <algo/winmask/win_mask_util.hpp>
Inheritance diagram for CWinMaskUtil::CIdSet:
Public Member Functions | |
| virtual | ~CIdSet () |
| Object destructor. More... | |
| virtual void | insert (const string &id_str)=0 |
| Add a string to the id set. More... | |
| virtual bool | empty () const =0 |
| Check if the id set is empty. More... | |
| virtual bool | find (const objects::CBioseq_Handle &bsh) const =0 |
| Check if the id of the given bioseq is in the id set. More... | |
Detailed Description
Base class for sets of seq_id representations used with -ids and -exclude-ids options.
Definition at line 57 of file win_mask_util.hpp.
Constructor & Destructor Documentation
◆ ~CIdSet()
|
inlinevirtual |
Object destructor.
Definition at line 63 of file win_mask_util.hpp.
Member Function Documentation
◆ empty()
|
pure virtual |
Check if the id set is empty.
- Returns
- true if the id set is empty, false otherwise
Implemented in CWinMaskUtil::CIdSet_TextMatch, and CWinMaskUtil::CIdSet_SeqId.
Referenced by CWinMaskUtil::consider().
◆ find()
Check if the id of the given bioseq is in the id set.
- Parameters
-
bsh bioseq handle which id is to be checked
- Returns
- true if the id of the bsh is found in the id set; false otherwise
Implemented in CWinMaskUtil::CIdSet_TextMatch, and CWinMaskUtil::CIdSet_SeqId.
Referenced by CWinMaskUtil::consider().
◆ insert()
Add a string to the id set.
- Parameters
-
id_str id to add
Implemented in CWinMaskUtil::CIdSet_TextMatch, and CWinMaskUtil::CIdSet_SeqId.
Referenced by CWinMaskConfig::FillIdList().
The documentation for this class was generated from the following file:
- include/algo/winmask/win_mask_util.hpp
