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

Search Toolkit Book for SAnnotObjectsIndex

#include <objmgr/impl/annot_object_index.hpp>

+ Collaboration diagram for SAnnotObjectsIndex:

Public Types

typedef deque< CAnnotObject_InfoTObjectInfos
 
typedef vector< SAnnotObject_KeyTObjectKeys
 

Public Member Functions

 SAnnotObjectsIndex (void)
 
 SAnnotObjectsIndex (const CAnnotName &name)
 
 SAnnotObjectsIndex (const SAnnotObjectsIndex &)
 
 ~SAnnotObjectsIndex (void)
 
void SetName (const CAnnotName &name)
 
const CAnnotNameGetName (void) const
 
bool IsIndexed (void) const
 
void SetIndexed (void)
 
bool IsEmpty (void) const
 
void Clear (void)
 
void ReserveInfoSize (size_t size)
 
void AddInfo (const CAnnotObject_Info &info)
 
TObjectInfosGetInfos (void)
 
const TObjectInfosGetInfos (void) const
 
void ReserveMapSize (size_t size)
 
void AddMap (const SAnnotObject_Key &key, const SAnnotObject_Index &index)
 
void RemoveLastMap (void)
 
void PackKeys (void)
 
const TObjectKeysGetKeys (void) const
 
const SAnnotObject_KeyGetKey (size_t i) const
 

Private Member Functions

SAnnotObjectsIndexoperator= (const SAnnotObjectsIndex &)
 

Private Attributes

CAnnotName m_Name
 
TObjectInfos m_Infos
 
bool m_Indexed
 
TObjectKeys m_Keys
 

Detailed Description

Definition at line 150 of file annot_object_index.hpp.

Member Typedef Documentation

◆ TObjectInfos

Definition at line 157 of file annot_object_index.hpp.

◆ TObjectKeys

Definition at line 158 of file annot_object_index.hpp.

Constructor & Destructor Documentation

◆ SAnnotObjectsIndex() [1/3]

SAnnotObjectsIndex::SAnnotObjectsIndex ( void  )

Definition at line 41 of file annot_object_index.cpp.

◆ SAnnotObjectsIndex() [2/3]

SAnnotObjectsIndex::SAnnotObjectsIndex ( const CAnnotName name)

Definition at line 47 of file annot_object_index.cpp.

◆ SAnnotObjectsIndex() [3/3]

SAnnotObjectsIndex::SAnnotObjectsIndex ( const SAnnotObjectsIndex info)

Definition at line 53 of file annot_object_index.cpp.

◆ ~SAnnotObjectsIndex()

SAnnotObjectsIndex::~SAnnotObjectsIndex ( void  )

Definition at line 59 of file annot_object_index.cpp.

Member Function Documentation

◆ AddInfo()

void SAnnotObjectsIndex::AddInfo ( const CAnnotObject_Info info)

◆ AddMap()

void SAnnotObjectsIndex::AddMap ( const SAnnotObject_Key key,
const SAnnotObject_Index index 
)

◆ Clear()

void SAnnotObjectsIndex::Clear ( void  )

◆ GetInfos() [1/2]

SAnnotObjectsIndex::TObjectInfos & SAnnotObjectsIndex::GetInfos ( void  )
inline

◆ GetInfos() [2/2]

const SAnnotObjectsIndex::TObjectInfos & SAnnotObjectsIndex::GetInfos ( void  ) const
inline

Definition at line 229 of file annot_object_index.hpp.

References m_Infos.

◆ GetKey()

const SAnnotObject_Key & SAnnotObjectsIndex::GetKey ( size_t  i) const
inline

◆ GetKeys()

const SAnnotObjectsIndex::TObjectKeys & SAnnotObjectsIndex::GetKeys ( void  ) const
inline

◆ GetName()

const CAnnotName & SAnnotObjectsIndex::GetName ( void  ) const
inline

◆ IsEmpty()

bool SAnnotObjectsIndex::IsEmpty ( void  ) const
inline

Definition at line 221 of file annot_object_index.hpp.

References m_Infos.

Referenced by CSeq_annot_Info::x_InitAnnotList().

◆ IsIndexed()

bool SAnnotObjectsIndex::IsIndexed ( void  ) const
inline

◆ operator=()

SAnnotObjectsIndex& SAnnotObjectsIndex::operator= ( const SAnnotObjectsIndex )
private

◆ PackKeys()

void SAnnotObjectsIndex::PackKeys ( void  )

◆ RemoveLastMap()

void SAnnotObjectsIndex::RemoveLastMap ( void  )

◆ ReserveInfoSize()

void SAnnotObjectsIndex::ReserveInfoSize ( size_t  size)

◆ ReserveMapSize()

void SAnnotObjectsIndex::ReserveMapSize ( size_t  size)

◆ SetIndexed()

void SAnnotObjectsIndex::SetIndexed ( void  )
inline

◆ SetName()

void SAnnotObjectsIndex::SetName ( const CAnnotName name)

Definition at line 64 of file annot_object_index.cpp.

References _ASSERT, IsIndexed(), and m_Name.

Referenced by CSeq_annot_Info::x_InitAnnotKeys().

Member Data Documentation

◆ m_Indexed

bool SAnnotObjectsIndex::m_Indexed
private

Definition at line 191 of file annot_object_index.hpp.

Referenced by Clear(), IsIndexed(), and SetIndexed().

◆ m_Infos

TObjectInfos SAnnotObjectsIndex::m_Infos
private

Definition at line 190 of file annot_object_index.hpp.

Referenced by AddInfo(), GetInfos(), and IsEmpty().

◆ m_Keys

TObjectKeys SAnnotObjectsIndex::m_Keys
private

◆ m_Name

CAnnotName SAnnotObjectsIndex::m_Name
private

Definition at line 189 of file annot_object_index.hpp.

Referenced by GetName(), and SetName().


The documentation for this struct was generated from the following files:
Modified on Mon Jul 22 05:05:59 2024 by modify_doxy.py rev. 669887