NCBI C++ ToolKit
Public Member Functions | Public Attributes | List of all members
CBlastDB_FormatterConfig Struct Reference

Search Toolkit Book for CBlastDB_FormatterConfig

Configuration object for CBlastDB_Formatter classes. More...

#include <objtools/blast/blastdb_format/seq_formatter.hpp>

+ Collaboration diagram for CBlastDB_FormatterConfig:

Public Member Functions

 CBlastDB_FormatterConfig ()
 Default constructor. More...
 

Public Attributes

TSeqRange m_SeqRange
 The range of the sequence to retrieve, if empty, the entire sequence will be retrived. More...
 
objects::ENa_strand m_Strand
 All SeqLoc types will have this strand assigned; If set to 'other', the strand will be set to 'unknown' for protein sequences and 'both' for nucleotide. More...
 
bool m_UseCtrlA
 Determines whether Ctrl-A characters should be used as defline separators. More...
 
int m_FiltAlgoId
 Filtering algorithm ID to mask the FASTA. More...
 
int m_FmtAlgoId
 Filtering algorithm ID for outfmt m. More...
 

Detailed Description

Configuration object for CBlastDB_Formatter classes.

Definition at line 43 of file seq_formatter.hpp.

Constructor & Destructor Documentation

◆ CBlastDB_FormatterConfig()

CBlastDB_FormatterConfig::CBlastDB_FormatterConfig ( )
inline

Default constructor.

Definition at line 45 of file seq_formatter.hpp.

References eNa_strand_other, m_FiltAlgoId, m_FmtAlgoId, m_SeqRange, m_Strand, and m_UseCtrlA.

Member Data Documentation

◆ m_FiltAlgoId

int CBlastDB_FormatterConfig::m_FiltAlgoId

Filtering algorithm ID to mask the FASTA.

Definition at line 65 of file seq_formatter.hpp.

Referenced by CBlastDB_FormatterConfig(), CBlastDBCmdApp::x_InitSearchRequest(), and CBlastDBCmdApp::x_ModifyConfigForBatchEntry().

◆ m_FmtAlgoId

int CBlastDB_FormatterConfig::m_FmtAlgoId

Filtering algorithm ID for outfmt m.

Definition at line 67 of file seq_formatter.hpp.

Referenced by CBlastDB_FormatterConfig(), and CBlastDBCmdApp::x_InitSearchRequest().

◆ m_SeqRange

TSeqRange CBlastDB_FormatterConfig::m_SeqRange

The range of the sequence to retrieve, if empty, the entire sequence will be retrived.

Definition at line 56 of file seq_formatter.hpp.

Referenced by CBlastDB_FormatterConfig(), CBlastDBCmdApp::x_InitSearchRequest(), and CBlastDBCmdApp::x_ModifyConfigForBatchEntry().

◆ m_Strand

objects::ENa_strand CBlastDB_FormatterConfig::m_Strand

All SeqLoc types will have this strand assigned; If set to 'other', the strand will be set to 'unknown' for protein sequences and 'both' for nucleotide.

Definition at line 60 of file seq_formatter.hpp.

Referenced by CBlastDB_FormatterConfig(), CBlastDBCmdApp::x_InitSearchRequest(), and CBlastDBCmdApp::x_ModifyConfigForBatchEntry().

◆ m_UseCtrlA

bool CBlastDB_FormatterConfig::m_UseCtrlA

Determines whether Ctrl-A characters should be used as defline separators.

Definition at line 63 of file seq_formatter.hpp.

Referenced by CBlastDB_FormatterConfig(), and CBlastDBCmdApp::x_InitSearchRequest().


The documentation for this struct was generated from the following file:
Modified on Mon Feb 26 04:03:28 2024 by modify_doxy.py rev. 669887