NCBI C++ ToolKit
seqalign_macros.hpp File Reference

Utility macros and typedefs for exploring NCBI objects from seqalign.asn. More...

#include <objects/misc/sequence_util_macros.hpp>
#include <objects/seqalign/seqalign__.hpp>
+ Include dependency graph for seqalign_macros.hpp:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Go to the SVN repository for this file.

#define NCBI_SEGTYPE(Type)   CSeq_align::C_Segs::e_##Type
 @NAME Convenience macros for NCBI objects More...
 
#define BOUND_ON_SEQALIGN_Type   CSeq_align::TBounds
 BOUND_ON_SEQALIGN macros. More...
 
#define BOUND_ON_SEQALIGN_Test(Var)   (Var).IsSetBounds()
 
#define BOUND_ON_SEQALIGN_Get(Var)   (Var).GetBounds()
 
#define BOUND_ON_SEQALIGN_Set(Var)   (Var).SetBounds()
 
#define EDIT_EACH_BOUND_ON_SEQALIGN(Itr, Var)    EDIT_EACH (BOUND_ON_SEQALIGN, Itr, Var)
 
#define SEGTYPE_ON_SEQALIGN_Test(Var)   ((Var).IsSetSegs())
 SEGTYPE_ON_SEQALIGN macros. More...
 
#define SEGTYPE_ON_SEQALIGN_Chs(Var)   (Var).GetSegs().Which()
 
#define SWITCH_ON_SEGTYPE_ON_SEQALIGN(Var)    SWITCH_ON( SEGTYPE_ON_SEQALIGN, Var )
 
#define DENDIAG_ON_SEQALIGN_Type   CSeq_align_Base::C_Segs::TDendiag
 DENDIAG_ON_SEQALIGN macros. More...
 
#define DENDIAG_ON_SEQALIGN_Test(Var)   (Var).IsSetSegs() && (Var).GetSegs().IsDendiag()
 
#define DENDIAG_ON_SEQALIGN_Get(Var)   (Var).GetSegs().GetDendiag()
 
#define DENDIAG_ON_SEQALIGN_Set(Var)   (Var).SetSegs().SetDendiag()
 
#define EDIT_EACH_DENDIAG_ON_SEQALIGN(Itr, Var)   EDIT_EACH (DENDIAG_ON_SEQALIGN, Itr, Var)
 EDIT_EACH_DENDIAG_ON_SEQALIGN. More...
 
#define STDSEG_ON_SEQALIGN_Type   CSeq_align_Base::C_Segs::TStd
 STDSEG_ON_SEQALIGN macros. More...
 
#define STDSEG_ON_SEQALIGN_Test(Var)   (Var).IsSetSegs() && (Var).GetSegs().IsStd()
 
#define STDSEG_ON_SEQALIGN_Get(Var)   (Var).GetSegs().GetStd()
 
#define STDSEG_ON_SEQALIGN_Set(Var)   (Var).SetSegs().SetStd()
 
#define EDIT_EACH_STDSEG_ON_SEQALIGN(Itr, Var)   EDIT_EACH (STDSEG_ON_SEQALIGN, Itr, Var)
 EDIT_EACH_STDSEG_ON_SEQALIGN. More...
 
#define RECURSIVE_SEQALIGN_ON_SEQALIGN_Type   CSeq_align_Base::C_Segs::TDisc::Tdata
 RECURSIVE_SEQALIGN_ON_SEQALIGN macros. More...
 
#define RECURSIVE_SEQALIGN_ON_SEQALIGN_Test(Var)   (Var).IsSetSegs() && (Var).GetSegs().IsDisc()
 
#define RECURSIVE_SEQALIGN_ON_SEQALIGN_Get(Var)   (Var).GetSegs().GetDisc().Get()
 
#define RECURSIVE_SEQALIGN_ON_SEQALIGN_Set(Var)   (Var).SetSegs().SetDisc().Set()
 
#define EDIT_EACH_RECURSIVE_SEQALIGN_ON_SEQALIGN(Itr, Var)   EDIT_EACH (RECURSIVE_SEQALIGN_ON_SEQALIGN, Itr, Var)
 EDIT_EACH_RECURSIVE_SEQALIGN_ON_SEQALIGN. More...
 
#define SEQID_ON_DENDIAG_Type   CDense_diag_Base::TIds
 SEQID_ON_DENDIAG macros. More...
 
#define SEQID_ON_DENDIAG_Test(Var)   (Var).IsSetIds()
 
#define SEQID_ON_DENDIAG_Get(Var)   (Var).GetIds()
 
#define SEQID_ON_DENDIAG_Set(Var)   (Var).SetIds()
 
#define EDIT_EACH_SEQID_ON_DENDIAG(Itr, Var)   EDIT_EACH (SEQID_ON_DENDIAG, Itr, Var)
 EDIT_EACH_SEQID_ON_DENDIAG. More...
 
#define SEQID_ON_DENSEG_Type   CDense_seg::TIds
 SEQID_ON_DENSEG macros. More...
 
#define SEQID_ON_DENSEG_Test(Var)   (Var).IsSetIds()
 
#define SEQID_ON_DENSEG_Get(Var)   (Var).GetIds()
 
#define SEQID_ON_DENSEG_Set(Var)   (Var).SetIds()
 
#define EDIT_EACH_SEQID_ON_DENSEG(Itr, Var)   EDIT_EACH (SEQID_ON_DENSEG, Itr, Var)
 EDIT_EACH_SEQID_ON_DENSEG. More...
 
typedef CSeq_align::C_Segs::E_Choice TSEGTYPE_TYPE
 

Detailed Description

Utility macros and typedefs for exploring NCBI objects from seqalign.asn.

Definition in file seqalign_macros.hpp.

Macro Definition Documentation

◆ BOUND_ON_SEQALIGN_Get

#define BOUND_ON_SEQALIGN_Get (   Var)    (Var).GetBounds()

Definition at line 79 of file seqalign_macros.hpp.

◆ BOUND_ON_SEQALIGN_Set

#define BOUND_ON_SEQALIGN_Set (   Var)    (Var).SetBounds()

Definition at line 80 of file seqalign_macros.hpp.

◆ BOUND_ON_SEQALIGN_Test

#define BOUND_ON_SEQALIGN_Test (   Var)    (Var).IsSetBounds()

Definition at line 78 of file seqalign_macros.hpp.

◆ BOUND_ON_SEQALIGN_Type

#define BOUND_ON_SEQALIGN_Type   CSeq_align::TBounds

BOUND_ON_SEQALIGN macros.

Definition at line 77 of file seqalign_macros.hpp.

◆ DENDIAG_ON_SEQALIGN_Get

#define DENDIAG_ON_SEQALIGN_Get (   Var)    (Var).GetSegs().GetDendiag()

Definition at line 99 of file seqalign_macros.hpp.

◆ DENDIAG_ON_SEQALIGN_Set

#define DENDIAG_ON_SEQALIGN_Set (   Var)    (Var).SetSegs().SetDendiag()

Definition at line 100 of file seqalign_macros.hpp.

◆ DENDIAG_ON_SEQALIGN_Test

#define DENDIAG_ON_SEQALIGN_Test (   Var)    (Var).IsSetSegs() && (Var).GetSegs().IsDendiag()

Definition at line 98 of file seqalign_macros.hpp.

◆ DENDIAG_ON_SEQALIGN_Type

#define DENDIAG_ON_SEQALIGN_Type   CSeq_align_Base::C_Segs::TDendiag

DENDIAG_ON_SEQALIGN macros.

Definition at line 97 of file seqalign_macros.hpp.

◆ EDIT_EACH_BOUND_ON_SEQALIGN

#define EDIT_EACH_BOUND_ON_SEQALIGN (   Itr,
  Var 
)     EDIT_EACH (BOUND_ON_SEQALIGN, Itr, Var)

Definition at line 84 of file seqalign_macros.hpp.

◆ EDIT_EACH_DENDIAG_ON_SEQALIGN

#define EDIT_EACH_DENDIAG_ON_SEQALIGN (   Itr,
  Var 
)    EDIT_EACH (DENDIAG_ON_SEQALIGN, Itr, Var)

EDIT_EACH_DENDIAG_ON_SEQALIGN.

Definition at line 104 of file seqalign_macros.hpp.

◆ EDIT_EACH_RECURSIVE_SEQALIGN_ON_SEQALIGN

#define EDIT_EACH_RECURSIVE_SEQALIGN_ON_SEQALIGN (   Itr,
  Var 
)    EDIT_EACH (RECURSIVE_SEQALIGN_ON_SEQALIGN, Itr, Var)

EDIT_EACH_RECURSIVE_SEQALIGN_ON_SEQALIGN.

Definition at line 128 of file seqalign_macros.hpp.

◆ EDIT_EACH_SEQID_ON_DENDIAG

#define EDIT_EACH_SEQID_ON_DENDIAG (   Itr,
  Var 
)    EDIT_EACH (SEQID_ON_DENDIAG, Itr, Var)

EDIT_EACH_SEQID_ON_DENDIAG.

Definition at line 140 of file seqalign_macros.hpp.

◆ EDIT_EACH_SEQID_ON_DENSEG

#define EDIT_EACH_SEQID_ON_DENSEG (   Itr,
  Var 
)    EDIT_EACH (SEQID_ON_DENSEG, Itr, Var)

EDIT_EACH_SEQID_ON_DENSEG.

Definition at line 152 of file seqalign_macros.hpp.

◆ EDIT_EACH_STDSEG_ON_SEQALIGN

#define EDIT_EACH_STDSEG_ON_SEQALIGN (   Itr,
  Var 
)    EDIT_EACH (STDSEG_ON_SEQALIGN, Itr, Var)

EDIT_EACH_STDSEG_ON_SEQALIGN.

Definition at line 116 of file seqalign_macros.hpp.

◆ NCBI_SEGTYPE

#define NCBI_SEGTYPE (   Type)    CSeq_align::C_Segs::e_##Type

@NAME Convenience macros for NCBI objects

Macros and typedefs for object subtypes CSeq_align definitions

Definition at line 55 of file seqalign_macros.hpp.

◆ RECURSIVE_SEQALIGN_ON_SEQALIGN_Get

#define RECURSIVE_SEQALIGN_ON_SEQALIGN_Get (   Var)    (Var).GetSegs().GetDisc().Get()

Definition at line 123 of file seqalign_macros.hpp.

◆ RECURSIVE_SEQALIGN_ON_SEQALIGN_Set

#define RECURSIVE_SEQALIGN_ON_SEQALIGN_Set (   Var)    (Var).SetSegs().SetDisc().Set()

Definition at line 124 of file seqalign_macros.hpp.

◆ RECURSIVE_SEQALIGN_ON_SEQALIGN_Test

#define RECURSIVE_SEQALIGN_ON_SEQALIGN_Test (   Var)    (Var).IsSetSegs() && (Var).GetSegs().IsDisc()

Definition at line 122 of file seqalign_macros.hpp.

◆ RECURSIVE_SEQALIGN_ON_SEQALIGN_Type

#define RECURSIVE_SEQALIGN_ON_SEQALIGN_Type   CSeq_align_Base::C_Segs::TDisc::Tdata

RECURSIVE_SEQALIGN_ON_SEQALIGN macros.

Definition at line 121 of file seqalign_macros.hpp.

◆ SEGTYPE_ON_SEQALIGN_Chs

#define SEGTYPE_ON_SEQALIGN_Chs (   Var)    (Var).GetSegs().Which()

Definition at line 90 of file seqalign_macros.hpp.

◆ SEGTYPE_ON_SEQALIGN_Test

#define SEGTYPE_ON_SEQALIGN_Test (   Var)    ((Var).IsSetSegs())

SEGTYPE_ON_SEQALIGN macros.

Definition at line 89 of file seqalign_macros.hpp.

◆ SEQID_ON_DENDIAG_Get

#define SEQID_ON_DENDIAG_Get (   Var)    (Var).GetIds()

Definition at line 135 of file seqalign_macros.hpp.

◆ SEQID_ON_DENDIAG_Set

#define SEQID_ON_DENDIAG_Set (   Var)    (Var).SetIds()

Definition at line 136 of file seqalign_macros.hpp.

◆ SEQID_ON_DENDIAG_Test

#define SEQID_ON_DENDIAG_Test (   Var)    (Var).IsSetIds()

Definition at line 134 of file seqalign_macros.hpp.

◆ SEQID_ON_DENDIAG_Type

#define SEQID_ON_DENDIAG_Type   CDense_diag_Base::TIds

SEQID_ON_DENDIAG macros.

Definition at line 133 of file seqalign_macros.hpp.

◆ SEQID_ON_DENSEG_Get

#define SEQID_ON_DENSEG_Get (   Var)    (Var).GetIds()

Definition at line 147 of file seqalign_macros.hpp.

◆ SEQID_ON_DENSEG_Set

#define SEQID_ON_DENSEG_Set (   Var)    (Var).SetIds()

Definition at line 148 of file seqalign_macros.hpp.

◆ SEQID_ON_DENSEG_Test

#define SEQID_ON_DENSEG_Test (   Var)    (Var).IsSetIds()

Definition at line 146 of file seqalign_macros.hpp.

◆ SEQID_ON_DENSEG_Type

#define SEQID_ON_DENSEG_Type   CDense_seg::TIds

SEQID_ON_DENSEG macros.

Definition at line 145 of file seqalign_macros.hpp.

◆ STDSEG_ON_SEQALIGN_Get

#define STDSEG_ON_SEQALIGN_Get (   Var)    (Var).GetSegs().GetStd()

Definition at line 111 of file seqalign_macros.hpp.

◆ STDSEG_ON_SEQALIGN_Set

#define STDSEG_ON_SEQALIGN_Set (   Var)    (Var).SetSegs().SetStd()

Definition at line 112 of file seqalign_macros.hpp.

◆ STDSEG_ON_SEQALIGN_Test

#define STDSEG_ON_SEQALIGN_Test (   Var)    (Var).IsSetSegs() && (Var).GetSegs().IsStd()

Definition at line 110 of file seqalign_macros.hpp.

◆ STDSEG_ON_SEQALIGN_Type

#define STDSEG_ON_SEQALIGN_Type   CSeq_align_Base::C_Segs::TStd

STDSEG_ON_SEQALIGN macros.

Definition at line 109 of file seqalign_macros.hpp.

◆ SWITCH_ON_SEGTYPE_ON_SEQALIGN

#define SWITCH_ON_SEGTYPE_ON_SEQALIGN (   Var)     SWITCH_ON( SEGTYPE_ON_SEQALIGN, Var )

Definition at line 92 of file seqalign_macros.hpp.

Typedef Documentation

◆ TSEGTYPE_TYPE

Definition at line 56 of file seqalign_macros.hpp.

Modified on Fri Sep 20 14:57:57 2024 by modify_doxy.py rev. 669887