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

Search Toolkit Book for SSeqIdKey

Auxiliary type to embed a CConstRef<objects::CSeq_id> in STL containers that require operator< to be defined. More...

#include <objtools/align_format/showalign.hpp>

+ Collaboration diagram for SSeqIdKey:

Public Member Functions

 SSeqIdKey (const objects::CSeq_id &id)
 Constructor. More...
 
bool operator< (const SSeqIdKey &other) const
 Operator< to comply with STL container requirements. More...
 
 operator const objects::CSeq_id & () const
 Retrieve the object contained in this structure. More...
 

Private Attributes

CConstRef< objects::CSeq_id > m_Id
 The wrapped object. More...
 

Detailed Description

Auxiliary type to embed a CConstRef<objects::CSeq_id> in STL containers that require operator< to be defined.

Definition at line 60 of file showalign.hpp.

Constructor & Destructor Documentation

◆ SSeqIdKey()

SSeqIdKey::SSeqIdKey ( const objects::CSeq_id &  id)
inline

Constructor.

Definition at line 62 of file showalign.hpp.

Member Function Documentation

◆ operator const objects::CSeq_id &()

SSeqIdKey::operator const objects::CSeq_id & ( ) const
inline

Retrieve the object contained in this structure.

Definition at line 68 of file showalign.hpp.

◆ operator<()

bool SSeqIdKey::operator< ( const SSeqIdKey other) const
inline

Operator< to comply with STL container requirements.

Definition at line 64 of file showalign.hpp.

References m_Id.

Member Data Documentation

◆ m_Id

CConstRef<objects::CSeq_id> SSeqIdKey::m_Id
private

The wrapped object.

Definition at line 70 of file showalign.hpp.

Referenced by operator<().


The documentation for this struct was generated from the following file:
Modified on Sun Jul 14 05:01:42 2024 by modify_doxy.py rev. 669887