NCBI C++ ToolKit
pub_macros.hpp File Reference

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

#include <objects/misc/sequence_util_macros.hpp>
#include <objects/pub/pub__.hpp>
+ Include dependency graph for pub_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_PUB(Type)   CPub::e_##Type
 @NAME Convenience macros for NCBI objects More...
 
#define PUB_ON_PUBEQUIV_Type   CPub_equiv::Tdata
 CPubequiv macros. More...
 
#define PUB_ON_PUBEQUIV_Test(Var)   (Var).IsSet()
 
#define PUB_ON_PUBEQUIV_Get(Var)   (Var).Get()
 
#define PUB_ON_PUBEQUIV_Set(Var)   (Var).Set()
 
#define FOR_EACH_PUB_ON_PUBEQUIV(Itr, Var)   FOR_EACH (PUB_ON_PUBEQUIV, Itr, Var)
 
#define EDIT_EACH_PUB_ON_PUBEQUIV(Itr, Var)   EDIT_EACH (PUB_ON_PUBEQUIV, Itr, Var)
 
#define ADD_PUB_TO_PUBEQUIV(Var, Ref)   ADD_ITEM (PUB_ON_PUBEQUIV, Var, Ref)
 ADD_PUB_TO_PUBEQUIV. More...
 
#define ERASE_PUB_ON_PUBEQUIV(Itr, Var)   LIST_ERASE_ITEM (PUB_ON_PUBEQUIV, Itr, Var)
 ERASE_PUB_ON_PUBEQUIV. More...
 
#define PUB_ON_PUBDESC_Type   CPub_equiv::Tdata
 CPubdesc macros. More...
 
#define PUB_ON_PUBDESC_Test(Var)   (Var).IsSetPub() && (Var).GetPub().IsSet()
 
#define PUB_ON_PUBDESC_Get(Var)   (Var).GetPub().Get()
 
#define PUB_ON_PUBDESC_Set(Var)   (Var).SetPub().Set()
 
#define PUBDESC_HAS_PUB(Var)   ITEM_HAS (PUB_ON_PUBDESC, Var)
 PUBDESC_HAS_PUB. More...
 
#define FOR_EACH_PUB_ON_PUBDESC(Itr, Var)   FOR_EACH (PUB_ON_PUBDESC, Itr, Var)
 FOR_EACH_PUB_ON_PUBDESC EDIT_EACH_PUB_ON_PUBDESC. More...
 
#define EDIT_EACH_PUB_ON_PUBDESC(Itr, Var)   EDIT_EACH (PUB_ON_PUBDESC, Itr, Var)
 
#define ADD_PUB_TO_PUBDESC(Var, Ref)   ADD_ITEM (PUB_ON_PUBDESC, Var, Ref)
 ADD_PUB_TO_PUBDESC. More...
 
#define ERASE_PUB_ON_PUBDESC(Itr, Var)   LIST_ERASE_ITEM (PUB_ON_PUBDESC, Itr, Var)
 ERASE_PUB_ON_PUBDESC. More...
 
#define AUTHOR_ON_PUB_Type   CAuth_list::C_Names::TStd
 CPub macros. More...
 
#define AUTHOR_ON_PUB_Test(Var)
 
#define AUTHOR_ON_PUB_Get(Var)   (Var).GetAuthors().GetNames().GetStd()
 
#define AUTHOR_ON_PUB_Set(Var)   (Var).SetAuthors().SetNames().SetStd()
 
#define PUB_HAS_AUTHOR(Var)   ITEM_HAS (AUTHOR_ON_PUB, Var)
 PUB_HAS_AUTHOR. More...
 
#define FOR_EACH_AUTHOR_ON_PUB(Itr, Var)   FOR_EACH (AUTHOR_ON_PUB, Itr, Var)
 FOR_EACH_AUTHOR_ON_PUB EDIT_EACH_AUTHOR_ON_PUB. More...
 
#define EDIT_EACH_AUTHOR_ON_PUB(Itr, Var)   EDIT_EACH (AUTHOR_ON_PUB, Itr, Var)
 
#define ADD_AUTHOR_TO_PUB(Var, Ref)   ADD_ITEM (AUTHOR_ON_PUB, Var, Ref)
 ADD_AUTHOR_TO_PUB. More...
 
#define ERASE_AUTHOR_ON_PUB(Itr, Var)   LIST_ERASE_ITEM (AUTHOR_ON_PUB, Itr, Var)
 ERASE_AUTHOR_ON_PUB. More...
 
typedef CPub::E_Choice TPUB_CHOICE
 

Detailed Description

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

Definition in file pub_macros.hpp.

Macro Definition Documentation

◆ ADD_AUTHOR_TO_PUB

#define ADD_AUTHOR_TO_PUB (   Var,
  Ref 
)    ADD_ITEM (AUTHOR_ON_PUB, Var, Ref)

ADD_AUTHOR_TO_PUB.

Definition at line 173 of file pub_macros.hpp.

◆ ADD_PUB_TO_PUBDESC

#define ADD_PUB_TO_PUBDESC (   Var,
  Ref 
)    ADD_ITEM (PUB_ON_PUBDESC, Var, Ref)

ADD_PUB_TO_PUBDESC.

Definition at line 135 of file pub_macros.hpp.

◆ ADD_PUB_TO_PUBEQUIV

#define ADD_PUB_TO_PUBEQUIV (   Var,
  Ref 
)    ADD_ITEM (PUB_ON_PUBEQUIV, Var, Ref)

ADD_PUB_TO_PUBEQUIV.

Definition at line 94 of file pub_macros.hpp.

◆ AUTHOR_ON_PUB_Get

#define AUTHOR_ON_PUB_Get (   Var)    (Var).GetAuthors().GetNames().GetStd()

Definition at line 153 of file pub_macros.hpp.

◆ AUTHOR_ON_PUB_Set

#define AUTHOR_ON_PUB_Set (   Var)    (Var).SetAuthors().SetNames().SetStd()

Definition at line 154 of file pub_macros.hpp.

◆ AUTHOR_ON_PUB_Test

#define AUTHOR_ON_PUB_Test (   Var)
Value:
(Var).IsSetAuthors() && \
(Var).GetAuthors().IsSetNames() && \
(Var).GetAuthors().GetNames().IsStd()

Definition at line 150 of file pub_macros.hpp.

◆ AUTHOR_ON_PUB_Type

#define AUTHOR_ON_PUB_Type   CAuth_list::C_Names::TStd

CPub macros.

AUTHOR_ON_PUB macros

Definition at line 149 of file pub_macros.hpp.

◆ EDIT_EACH_AUTHOR_ON_PUB

#define EDIT_EACH_AUTHOR_ON_PUB (   Itr,
  Var 
)    EDIT_EACH (AUTHOR_ON_PUB, Itr, Var)

Definition at line 168 of file pub_macros.hpp.

◆ EDIT_EACH_PUB_ON_PUBDESC

#define EDIT_EACH_PUB_ON_PUBDESC (   Itr,
  Var 
)    EDIT_EACH (PUB_ON_PUBDESC, Itr, Var)

Definition at line 130 of file pub_macros.hpp.

◆ EDIT_EACH_PUB_ON_PUBEQUIV

#define EDIT_EACH_PUB_ON_PUBEQUIV (   Itr,
  Var 
)    EDIT_EACH (PUB_ON_PUBEQUIV, Itr, Var)

Definition at line 89 of file pub_macros.hpp.

◆ ERASE_AUTHOR_ON_PUB

#define ERASE_AUTHOR_ON_PUB (   Itr,
  Var 
)    LIST_ERASE_ITEM (AUTHOR_ON_PUB, Itr, Var)

ERASE_AUTHOR_ON_PUB.

Definition at line 178 of file pub_macros.hpp.

◆ ERASE_PUB_ON_PUBDESC

#define ERASE_PUB_ON_PUBDESC (   Itr,
  Var 
)    LIST_ERASE_ITEM (PUB_ON_PUBDESC, Itr, Var)

ERASE_PUB_ON_PUBDESC.

Definition at line 140 of file pub_macros.hpp.

◆ ERASE_PUB_ON_PUBEQUIV

#define ERASE_PUB_ON_PUBEQUIV (   Itr,
  Var 
)    LIST_ERASE_ITEM (PUB_ON_PUBEQUIV, Itr, Var)

ERASE_PUB_ON_PUBEQUIV.

Definition at line 99 of file pub_macros.hpp.

◆ FOR_EACH_AUTHOR_ON_PUB

#define FOR_EACH_AUTHOR_ON_PUB (   Itr,
  Var 
)    FOR_EACH (AUTHOR_ON_PUB, Itr, Var)

FOR_EACH_AUTHOR_ON_PUB EDIT_EACH_AUTHOR_ON_PUB.

Definition at line 165 of file pub_macros.hpp.

◆ FOR_EACH_PUB_ON_PUBDESC

#define FOR_EACH_PUB_ON_PUBDESC (   Itr,
  Var 
)    FOR_EACH (PUB_ON_PUBDESC, Itr, Var)

FOR_EACH_PUB_ON_PUBDESC EDIT_EACH_PUB_ON_PUBDESC.

Definition at line 127 of file pub_macros.hpp.

◆ FOR_EACH_PUB_ON_PUBEQUIV

#define FOR_EACH_PUB_ON_PUBEQUIV (   Itr,
  Var 
)    FOR_EACH (PUB_ON_PUBEQUIV, Itr, Var)

Definition at line 86 of file pub_macros.hpp.

◆ NCBI_PUB

#define NCBI_PUB (   Type)    CPub::e_##Type

@NAME Convenience macros for NCBI objects

Macros and typedefs for object subtypes CPub definitions

Definition at line 55 of file pub_macros.hpp.

◆ PUB_HAS_AUTHOR

#define PUB_HAS_AUTHOR (   Var)    ITEM_HAS (AUTHOR_ON_PUB, Var)

PUB_HAS_AUTHOR.

Definition at line 158 of file pub_macros.hpp.

◆ PUB_ON_PUBDESC_Get

#define PUB_ON_PUBDESC_Get (   Var)    (Var).GetPub().Get()

Definition at line 110 of file pub_macros.hpp.

◆ PUB_ON_PUBDESC_Set

#define PUB_ON_PUBDESC_Set (   Var)    (Var).SetPub().Set()

Definition at line 111 of file pub_macros.hpp.

◆ PUB_ON_PUBDESC_Test

#define PUB_ON_PUBDESC_Test (   Var)    (Var).IsSetPub() && (Var).GetPub().IsSet()

Definition at line 109 of file pub_macros.hpp.

◆ PUB_ON_PUBDESC_Type

#define PUB_ON_PUBDESC_Type   CPub_equiv::Tdata

CPubdesc macros.

PUB_ON_PUBDESC macros

Definition at line 108 of file pub_macros.hpp.

◆ PUB_ON_PUBEQUIV_Get

#define PUB_ON_PUBEQUIV_Get (   Var)    (Var).Get()

Definition at line 83 of file pub_macros.hpp.

◆ PUB_ON_PUBEQUIV_Set

#define PUB_ON_PUBEQUIV_Set (   Var)    (Var).Set()

Definition at line 84 of file pub_macros.hpp.

◆ PUB_ON_PUBEQUIV_Test

#define PUB_ON_PUBEQUIV_Test (   Var)    (Var).IsSet()

Definition at line 82 of file pub_macros.hpp.

◆ PUB_ON_PUBEQUIV_Type

#define PUB_ON_PUBEQUIV_Type   CPub_equiv::Tdata

CPubequiv macros.

PUB_ON_PUBEQUIV macros

Definition at line 81 of file pub_macros.hpp.

◆ PUBDESC_HAS_PUB

#define PUBDESC_HAS_PUB (   Var)    ITEM_HAS (PUB_ON_PUBDESC, Var)

PUBDESC_HAS_PUB.

Definition at line 115 of file pub_macros.hpp.

Typedef Documentation

◆ TPUB_CHOICE

Definition at line 56 of file pub_macros.hpp.

Modified on Tue May 28 05:51:54 2024 by modify_doxy.py rev. 669887