NCBI C++ ToolKit
biblio_macros.hpp File Reference

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

#include <objects/misc/sequence_util_macros.hpp>
#include <objects/biblio/biblio__.hpp>
+ Include dependency graph for biblio_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.

Macros

#define ARTICLEID_ON_CITART_Type   CCit_art::TIds::Tdata
 @NAME Convenience macros for NCBI objects More...
 
#define ARTICLEID_ON_CITART_Test(Var)   ( (Var).IsSetIds() && (Var).GetIds().IsSet() )
 
#define ARTICLEID_ON_CITART_Get(Var)   (Var).GetIds().Get()
 
#define ARTICLEID_ON_CITART_Set(Var)   (Var).SetIds().Set()
 
#define FOR_EACH_ARTICLEID_ON_CITART(Itr, Var)   FOR_EACH (ARTICLEID_ON_CITART, Itr, Var)
 
#define EDIT_EACH_ARTICLEID_ON_CITART(Itr, Var)   EDIT_EACH (ARTICLEID_ON_CITART, Itr, Var)
 
#define ERASE_ARTICLEID_ON_CITART(Itr, Var)   LIST_ERASE_ITEM (ARTICLEID_ON_CITART, Itr, Var)
 
#define ARTICLEID_ON_CITART_IS_SORTED(Itr, Var)   IS_SORTED (ARTICLEID_ON_CITART, Itr, Var)
 
#define SORT_ARTICLEID_ON_CITART(Itr, Var)   DO_LIST_SORT (ARTICLEID_ON_CITART, Itr, Var)
 
#define ARTICLEID_ON_CITART_IS_UNIQUE(Itr, Var)   IS_UNIQUE (ARTICLEID_ON_CITART, Itr, Var)
 
#define UNIQUE_ARTICLEID_ON_CITART(Itr, Var)   DO_UNIQUE (ARTICLEID_ON_CITART, Itr, Var)
 
#define REMOVE_IF_EMPTY_ARTICLEID_ON_CITART(Var)   REMOVE_IF_EMPTY_FIELD (ARTICLEID_ON_CITART,, Var)
 
#define ARTICLEID_ON_CITART_IS_EMPTY(Var)   FIELD_IS_EMPTY (ARTICLEID_ON_CITART, Var)
 
#define AUTHOR_ON_AUTHLIST_Type   CAuth_list::C_Names::TStd
 CAuth_list macros. More...
 
#define AUTHOR_ON_AUTHLIST_Test(Var)
 
#define AUTHOR_ON_AUTHLIST_Get(Var)   (Var).GetNames().GetStd()
 
#define AUTHOR_ON_AUTHLIST_Set(Var)   (Var).SetNames().SetStd()
 
#define EDIT_EACH_AUTHOR_ON_AUTHLIST(Itr, Var)   EDIT_EACH (AUTHOR_ON_AUTHLIST, Itr, Var)
 
#define ERASE_AUTHOR_ON_AUTHLIST(Itr, Var)   LIST_ERASE_ITEM (AUTHOR_ON_AUTHLIST, Itr, Var)
 ERASE_AUTHOR_ON_AUTHLIST. More...
 
#define AUTHOR_ON_AUTHLIST_IS_EMPTY(Var)    FIELD_IS_EMPTY( AUTHOR_ON_AUTHLIST, Var )
 AUTHOR_ON_AUTHLIST_IS_EMPTY. More...
 

Detailed Description

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

Definition in file biblio_macros.hpp.

Macro Definition Documentation

◆ ARTICLEID_ON_CITART_Get

#define ARTICLEID_ON_CITART_Get (   Var)    (Var).GetIds().Get()

Definition at line 70 of file biblio_macros.hpp.

◆ ARTICLEID_ON_CITART_IS_EMPTY

#define ARTICLEID_ON_CITART_IS_EMPTY (   Var)    FIELD_IS_EMPTY (ARTICLEID_ON_CITART, Var)

Definition at line 97 of file biblio_macros.hpp.

◆ ARTICLEID_ON_CITART_IS_SORTED

#define ARTICLEID_ON_CITART_IS_SORTED (   Itr,
  Var 
)    IS_SORTED (ARTICLEID_ON_CITART, Itr, Var)

Definition at line 82 of file biblio_macros.hpp.

◆ ARTICLEID_ON_CITART_IS_UNIQUE

#define ARTICLEID_ON_CITART_IS_UNIQUE (   Itr,
  Var 
)    IS_UNIQUE (ARTICLEID_ON_CITART, Itr, Var)

Definition at line 88 of file biblio_macros.hpp.

◆ ARTICLEID_ON_CITART_Set

#define ARTICLEID_ON_CITART_Set (   Var)    (Var).SetIds().Set()

Definition at line 71 of file biblio_macros.hpp.

◆ ARTICLEID_ON_CITART_Test

#define ARTICLEID_ON_CITART_Test (   Var)    ( (Var).IsSetIds() && (Var).GetIds().IsSet() )

Definition at line 69 of file biblio_macros.hpp.

◆ ARTICLEID_ON_CITART_Type

#define ARTICLEID_ON_CITART_Type   CCit_art::TIds::Tdata

@NAME Convenience macros for NCBI objects

Macros and typedefs for object subtypes

CCit_art macros

Definition at line 68 of file biblio_macros.hpp.

◆ AUTHOR_ON_AUTHLIST_Get

#define AUTHOR_ON_AUTHLIST_Get (   Var)    (Var).GetNames().GetStd()

Definition at line 106 of file biblio_macros.hpp.

◆ AUTHOR_ON_AUTHLIST_IS_EMPTY

#define AUTHOR_ON_AUTHLIST_IS_EMPTY (   Var)     FIELD_IS_EMPTY( AUTHOR_ON_AUTHLIST, Var )

AUTHOR_ON_AUTHLIST_IS_EMPTY.

Definition at line 119 of file biblio_macros.hpp.

◆ AUTHOR_ON_AUTHLIST_Set

#define AUTHOR_ON_AUTHLIST_Set (   Var)    (Var).SetNames().SetStd()

Definition at line 107 of file biblio_macros.hpp.

◆ AUTHOR_ON_AUTHLIST_Test

#define AUTHOR_ON_AUTHLIST_Test (   Var)
Value:
(Var).IsSetNames() && \
(Var).GetNames().IsStd()

Definition at line 104 of file biblio_macros.hpp.

◆ AUTHOR_ON_AUTHLIST_Type

#define AUTHOR_ON_AUTHLIST_Type   CAuth_list::C_Names::TStd

CAuth_list macros.

Definition at line 103 of file biblio_macros.hpp.

◆ EDIT_EACH_ARTICLEID_ON_CITART

#define EDIT_EACH_ARTICLEID_ON_CITART (   Itr,
  Var 
)    EDIT_EACH (ARTICLEID_ON_CITART, Itr, Var)

Definition at line 76 of file biblio_macros.hpp.

◆ EDIT_EACH_AUTHOR_ON_AUTHLIST

#define EDIT_EACH_AUTHOR_ON_AUTHLIST (   Itr,
  Var 
)    EDIT_EACH (AUTHOR_ON_AUTHLIST, Itr, Var)

Definition at line 109 of file biblio_macros.hpp.

◆ ERASE_ARTICLEID_ON_CITART

#define ERASE_ARTICLEID_ON_CITART (   Itr,
  Var 
)    LIST_ERASE_ITEM (ARTICLEID_ON_CITART, Itr, Var)

Definition at line 79 of file biblio_macros.hpp.

◆ ERASE_AUTHOR_ON_AUTHLIST

#define ERASE_AUTHOR_ON_AUTHLIST (   Itr,
  Var 
)    LIST_ERASE_ITEM (AUTHOR_ON_AUTHLIST, Itr, Var)

ERASE_AUTHOR_ON_AUTHLIST.

Definition at line 114 of file biblio_macros.hpp.

◆ FOR_EACH_ARTICLEID_ON_CITART

#define FOR_EACH_ARTICLEID_ON_CITART (   Itr,
  Var 
)    FOR_EACH (ARTICLEID_ON_CITART, Itr, Var)

Definition at line 73 of file biblio_macros.hpp.

◆ REMOVE_IF_EMPTY_ARTICLEID_ON_CITART

#define REMOVE_IF_EMPTY_ARTICLEID_ON_CITART (   Var)    REMOVE_IF_EMPTY_FIELD (ARTICLEID_ON_CITART,, Var)

Definition at line 94 of file biblio_macros.hpp.

◆ SORT_ARTICLEID_ON_CITART

#define SORT_ARTICLEID_ON_CITART (   Itr,
  Var 
)    DO_LIST_SORT (ARTICLEID_ON_CITART, Itr, Var)

Definition at line 85 of file biblio_macros.hpp.

◆ UNIQUE_ARTICLEID_ON_CITART

#define UNIQUE_ARTICLEID_ON_CITART (   Itr,
  Var 
)    DO_UNIQUE (ARTICLEID_ON_CITART, Itr, Var)

Definition at line 91 of file biblio_macros.hpp.

Modified on Thu May 23 12:26:38 2024 by modify_doxy.py rev. 669887