NCBI C++ ToolKit
Public Member Functions | List of all members
IIdMapper Class Referenceabstract

Search Toolkit Book for IIdMapper

General IdMapper interface. More...

#include <objtools/readers/iidmapper.hpp>

+ Inheritance diagram for IIdMapper:

Public Member Functions

virtual ~IIdMapper ()
 
virtual CSeq_id_Handle Map (const CSeq_id_Handle &id)=0
 Map a single given CSeq_id_Handle to another. More...
 
virtual CRef< CSeq_locMap (const CSeq_loc &loc)=0
 
virtual void MapObject (CSerialObject &)=0
 Map all embedded IDs in a given object at once. More...
 

Detailed Description

General IdMapper interface.

This interface should suffice for typical IdMapper use, regardless of the actual inplementation.

Definition at line 47 of file iidmapper.hpp.

Constructor & Destructor Documentation

◆ ~IIdMapper()

virtual IIdMapper::~IIdMapper ( )
inlinevirtual

Definition at line 50 of file iidmapper.hpp.

Member Function Documentation

◆ Map() [1/2]

virtual CSeq_id_Handle IIdMapper::Map ( const CSeq_id_Handle id)
pure virtual

Map a single given CSeq_id_Handle to another.

Returns
the mapped handle, or an invalid handle if a mapping is not possible.

Implemented in CIdMapperDatabase, CIdMapperGCAssembly, CIdMapperComposite, and CIdMapper.

◆ Map() [2/2]

virtual CRef<CSeq_loc> IIdMapper::Map ( const CSeq_loc loc)
pure virtual

Implemented in CIdMapperComposite, and CIdMapper.

◆ MapObject()

virtual void IIdMapper::MapObject ( CSerialObject )
pure virtual

Map all embedded IDs in a given object at once.

Implemented in CIdMapper.

Referenced by sx_MapId(), CWig2tableApplication::x_MakeChromId(), and CCSraDb_Impl::x_MakeRefSeq_ids().


The documentation for this class was generated from the following file:
Modified on Thu Feb 29 12:18:35 2024 by modify_doxy.py rev. 669887