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

Represents ASN.1 type Repeat defined in file varrep.asn

Search Toolkit Book for SRepeat

Implementation of IRepeat backed by a simple structure. More...

#include <objtools/readers/rm_reader.hpp>

+ Inheritance diagram for SRepeat:
+ Collaboration diagram for SRepeat:

Public Member Functions

 SRepeat ()
 
string GetRptName () const
 Gets repeat name. More...
 
string GetRptFamily () const
 Gets repeat family, or empty string if not known. More...
 
string GetRptClass () const
 Gets repeat class, or empty string if not known. More...
 
TSeqPos GetRptLength () const
 Gets repeat length, or kInvalidSeqPos if not known. More...
 
TTaxId GetRptSpecificity () const
 Gets specificity as a taxonomy ID, or 0 if not known. More...
 
string GetRptSpecificityName () const
 Gets specificity as a name, or empty string if not known. More...
 
string GetRptRepbaseId () const
 Gets the RepbaseID, or empty string if not known. More...
 
- Public Member Functions inherited from IRepeat
virtual ~IRepeat (void)
 Enforce virtual destructor. More...
 

Public Attributes

string m_RptName
 
string m_RptFamily
 
string m_RptClass
 
TSeqPos m_RptLength
 
TTaxId m_RptSpecificity
 
string m_RptSpecificityName
 
string m_RptRepbaseId
 

Additional Inherited Members

- Public Types inherited from IRepeat
typedef ITaxonomyResolver::TTaxId TTaxId
 
- Static Public Attributes inherited from IRepeat
static const TTaxId kInvalidTaxId = 0
 

Detailed Description

Implementation of IRepeat backed by a simple structure.

Definition at line 121 of file rm_reader.hpp.

Constructor & Destructor Documentation

◆ SRepeat()

SRepeat::SRepeat ( )
inline

Definition at line 124 of file rm_reader.hpp.

Member Function Documentation

◆ GetRptClass()

string SRepeat::GetRptClass ( ) const
inlinevirtual

Gets repeat class, or empty string if not known.

Implements IRepeat.

Definition at line 128 of file rm_reader.hpp.

References m_RptClass.

◆ GetRptFamily()

string SRepeat::GetRptFamily ( ) const
inlinevirtual

Gets repeat family, or empty string if not known.

Implements IRepeat.

Definition at line 127 of file rm_reader.hpp.

References m_RptFamily.

◆ GetRptLength()

TSeqPos SRepeat::GetRptLength ( ) const
inlinevirtual

Gets repeat length, or kInvalidSeqPos if not known.

Implements IRepeat.

Definition at line 129 of file rm_reader.hpp.

References m_RptLength.

Referenced by CRepeatToFeat::operator()().

◆ GetRptName()

string SRepeat::GetRptName ( ) const
inlinevirtual

Gets repeat name.

Implements IRepeat.

Definition at line 126 of file rm_reader.hpp.

References m_RptName.

◆ GetRptRepbaseId()

string SRepeat::GetRptRepbaseId ( ) const
inlinevirtual

Gets the RepbaseID, or empty string if not known.

Implements IRepeat.

Definition at line 132 of file rm_reader.hpp.

References m_RptRepbaseId.

Referenced by CRepeatToFeat::operator()().

◆ GetRptSpecificity()

TTaxId SRepeat::GetRptSpecificity ( ) const
inlinevirtual

Gets specificity as a taxonomy ID, or 0 if not known.

Implements IRepeat.

Definition at line 130 of file rm_reader.hpp.

References m_RptSpecificity.

Referenced by CRepeatToFeat::operator()().

◆ GetRptSpecificityName()

string SRepeat::GetRptSpecificityName ( ) const
inlinevirtual

Gets specificity as a name, or empty string if not known.

Implements IRepeat.

Definition at line 131 of file rm_reader.hpp.

References m_RptSpecificityName.

Referenced by CRepeatToFeat::operator()().

Member Data Documentation

◆ m_RptClass

string SRepeat::m_RptClass

Definition at line 138 of file rm_reader.hpp.

Referenced by GetRptClass(), and CRepeatLibrary::Read().

◆ m_RptFamily

string SRepeat::m_RptFamily

Definition at line 137 of file rm_reader.hpp.

Referenced by GetRptFamily(), and CRepeatLibrary::Read().

◆ m_RptLength

TSeqPos SRepeat::m_RptLength

Definition at line 139 of file rm_reader.hpp.

Referenced by GetRptLength(), and CRepeatLibrary::Read().

◆ m_RptName

string SRepeat::m_RptName

Definition at line 136 of file rm_reader.hpp.

Referenced by GetRptName(), and CRepeatLibrary::Read().

◆ m_RptRepbaseId

string SRepeat::m_RptRepbaseId

Definition at line 142 of file rm_reader.hpp.

Referenced by GetRptRepbaseId(), and CRepeatLibrary::Read().

◆ m_RptSpecificity

TTaxId SRepeat::m_RptSpecificity

Definition at line 140 of file rm_reader.hpp.

Referenced by GetRptSpecificity(), and CRepeatLibrary::Read().

◆ m_RptSpecificityName

string SRepeat::m_RptSpecificityName

Definition at line 141 of file rm_reader.hpp.

Referenced by GetRptSpecificityName(), and CRepeatLibrary::Read().


The documentation for this class was generated from the following file:
Modified on Sun Apr 14 05:24:17 2024 by modify_doxy.py rev. 669887