NCBI C++ ToolKit
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | List of all members
CCit_gen Class Reference

Represents ASN.1 type Cit-gen defined in file biblio.asn

Search Toolkit Book for CCit_gen

#include <objects/biblio/Cit_gen.hpp>

+ Inheritance diagram for CCit_gen:
+ Collaboration diagram for CCit_gen:

Public Member Functions

 CCit_gen (void)
 
 ~CCit_gen (void)
 
- Public Member Functions inherited from CCit_gen_Base
 CCit_gen_Base (void)
 
virtual ~CCit_gen_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetCit (void) const
 anything, not parsable Check if a value has been assigned to Cit data member. More...
 
bool CanGetCit (void) const
 Check if it is safe to call GetCit method. More...
 
void ResetCit (void)
 Reset Cit data member. More...
 
const TCitGetCit (void) const
 Get the Cit member data. More...
 
void SetCit (const TCit &value)
 Assign a value to Cit data member. More...
 
void SetCit (TCit &&value)
 
TCitSetCit (void)
 Assign a value to Cit data member. More...
 
bool IsSetAuthors (void) const
 Check if a value has been assigned to Authors data member. More...
 
bool CanGetAuthors (void) const
 Check if it is safe to call GetAuthors method. More...
 
void ResetAuthors (void)
 Reset Authors data member. More...
 
const TAuthorsGetAuthors (void) const
 Get the Authors member data. More...
 
void SetAuthors (TAuthors &value)
 Assign a value to Authors data member. More...
 
TAuthorsSetAuthors (void)
 Assign a value to Authors data member. More...
 
bool IsSetMuid (void) const
 medline uid Check if a value has been assigned to Muid data member. More...
 
bool CanGetMuid (void) const
 Check if it is safe to call GetMuid method. More...
 
void ResetMuid (void)
 Reset Muid data member. More...
 
TMuid GetMuid (void) const
 Get the Muid member data. More...
 
void SetMuid (TMuid value)
 Assign a value to Muid data member. More...
 
TMuidSetMuid (void)
 Assign a value to Muid data member. More...
 
bool IsSetJournal (void) const
 Check if a value has been assigned to Journal data member. More...
 
bool CanGetJournal (void) const
 Check if it is safe to call GetJournal method. More...
 
void ResetJournal (void)
 Reset Journal data member. More...
 
const TJournalGetJournal (void) const
 Get the Journal member data. More...
 
void SetJournal (TJournal &value)
 Assign a value to Journal data member. More...
 
TJournalSetJournal (void)
 Assign a value to Journal data member. More...
 
bool IsSetVolume (void) const
 Check if a value has been assigned to Volume data member. More...
 
bool CanGetVolume (void) const
 Check if it is safe to call GetVolume method. More...
 
void ResetVolume (void)
 Reset Volume data member. More...
 
const TVolumeGetVolume (void) const
 Get the Volume member data. More...
 
void SetVolume (const TVolume &value)
 Assign a value to Volume data member. More...
 
void SetVolume (TVolume &&value)
 
TVolumeSetVolume (void)
 Assign a value to Volume data member. More...
 
bool IsSetIssue (void) const
 Check if a value has been assigned to Issue data member. More...
 
bool CanGetIssue (void) const
 Check if it is safe to call GetIssue method. More...
 
void ResetIssue (void)
 Reset Issue data member. More...
 
const TIssueGetIssue (void) const
 Get the Issue member data. More...
 
void SetIssue (const TIssue &value)
 Assign a value to Issue data member. More...
 
void SetIssue (TIssue &&value)
 
TIssueSetIssue (void)
 Assign a value to Issue data member. More...
 
bool IsSetPages (void) const
 Check if a value has been assigned to Pages data member. More...
 
bool CanGetPages (void) const
 Check if it is safe to call GetPages method. More...
 
void ResetPages (void)
 Reset Pages data member. More...
 
const TPagesGetPages (void) const
 Get the Pages member data. More...
 
void SetPages (const TPages &value)
 Assign a value to Pages data member. More...
 
void SetPages (TPages &&value)
 
TPagesSetPages (void)
 Assign a value to Pages data member. More...
 
bool IsSetDate (void) const
 Check if a value has been assigned to Date data member. More...
 
bool CanGetDate (void) const
 Check if it is safe to call GetDate method. More...
 
void ResetDate (void)
 Reset Date data member. More...
 
const TDateGetDate (void) const
 Get the Date member data. More...
 
void SetDate (TDate &value)
 Assign a value to Date data member. More...
 
TDateSetDate (void)
 Assign a value to Date data member. More...
 
bool IsSetSerial_number (void) const
 for GenBank style references Check if a value has been assigned to Serial_number data member. More...
 
bool CanGetSerial_number (void) const
 Check if it is safe to call GetSerial_number method. More...
 
void ResetSerial_number (void)
 Reset Serial_number data member. More...
 
TSerial_number GetSerial_number (void) const
 Get the Serial_number member data. More...
 
void SetSerial_number (TSerial_number value)
 Assign a value to Serial_number data member. More...
 
TSerial_numberSetSerial_number (void)
 Assign a value to Serial_number data member. More...
 
bool IsSetTitle (void) const
 eg. More...
 
bool CanGetTitle (void) const
 Check if it is safe to call GetTitle method. More...
 
void ResetTitle (void)
 Reset Title data member. More...
 
const TTitleGetTitle (void) const
 Get the Title member data. More...
 
void SetTitle (const TTitle &value)
 Assign a value to Title data member. More...
 
void SetTitle (TTitle &&value)
 
TTitleSetTitle (void)
 Assign a value to Title data member. More...
 
bool IsSetPmid (void) const
 PubMed Id Check if a value has been assigned to Pmid data member. More...
 
bool CanGetPmid (void) const
 Check if it is safe to call GetPmid method. More...
 
void ResetPmid (void)
 Reset Pmid data member. More...
 
const TPmidGetPmid (void) const
 Get the Pmid member data. More...
 
void SetPmid (const TPmid &value)
 Assign a value to Pmid data member. More...
 
TPmidSetPmid (void)
 Assign a value to Pmid data member. More...
 
virtual void Reset (void)
 Reset the whole object. More...
 
- Public Member Functions inherited from CSerialObject
 CSerialObject (void)
 
virtual ~CSerialObject (void)
 
virtual const CTypeInfoGetThisTypeInfo (void) const =0
 
virtual void Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive)
 Set object to copy of another one. More...
 
virtual bool Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const
 Check if both objects contain the same values. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
void ThrowUnassigned (TMemberIndex index) const
 
void ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const
 
bool HasNamespaceName (void) const
 Check if object data type has namespace name. More...
 
const stringGetNamespaceName (void) const
 Get namespace name. More...
 
bool HasNamespacePrefix (void) const
 Check if data type has namespace prefix. More...
 
const stringGetNamespacePrefix (void) const
 Get namespace prefix. More...
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (const CObject &src) THROWS_NONE
 Assignment operator. More...
 
bool CanBeDeleted (void) const THROWS_NONE
 Check if object can be deleted. More...
 
bool IsAllocatedInPool (void) const THROWS_NONE
 Check if object is allocated in memory pool (not system heap) More...
 
bool Referenced (void) const THROWS_NONE
 Check if object is referenced. More...
 
bool ReferencedOnlyOnce (void) const THROWS_NONE
 Check if object is referenced only once. More...
 
void AddReference (void) const
 Add reference to object. More...
 
void RemoveReference (void) const
 Remove reference to object. More...
 
void ReleaseReference (void) const
 Remove reference without deleting object. More...
 
virtual void DoNotDeleteThisObject (void)
 Mark this object as not allocated in heap – do not delete this object. More...
 
virtual void DoDeleteThisObject (void)
 Mark this object as allocated in heap – object can be deleted. More...
 
void * operator new (size_t size)
 Define new operator for memory allocation. More...
 
void * operator new[] (size_t size)
 Define new[] operator for 'array' memory allocation. More...
 
void operator delete (void *ptr)
 Define delete operator for memory deallocation. More...
 
void operator delete[] (void *ptr)
 Define delete[] operator for memory deallocation. More...
 
void * operator new (size_t size, void *place)
 Define new operator. More...
 
void operator delete (void *ptr, void *place)
 Define delete operator. More...
 
void * operator new (size_t size, CObjectMemoryPool *place)
 Define new operator using memory pool. More...
 
void operator delete (void *ptr, CObjectMemoryPool *place)
 Define delete operator. More...
 
- Public Member Functions inherited from CDebugDumpable
 CDebugDumpable (void)
 
virtual ~CDebugDumpable (void)
 
void DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
 
void DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
 
void DumpToConsole (void) const
 
- Public Member Functions inherited from ICitationBase
bool GetLabel (string *label, TLabelFlags flags=0, ELabelVersion version=eLabel_DefaultVersion) const override
 Append a label to the specified string per the specified flags. More...
 
bool GetLabel (string *label, bool unique) const
 
- Public Member Functions inherited from IAbstractCitation
virtual ~IAbstractCitation ()
 

Protected Member Functions

bool GetLabelV1 (string *label, TLabelFlags flags) const override
 
bool GetLabelV2 (string *label, TLabelFlags flags) const override
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Private Types

typedef CCit_gen_Base Tparent
 

Private Member Functions

 CCit_gen (const CCit_gen &value)
 
CCit_genoperator= (const CCit_gen &value)
 

Additional Inherited Members

- Public Types inherited from CCit_gen_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_cit , e_authors , e_muid ,
  e_journal , e_volume , e_issue , e_pages ,
  e_date , e_serial_number , e_title , e_pmid
}
 
typedef string TCit
 
typedef CAuth_list TAuthors
 
typedef NCBI_NS_NCBI::TEntrezId TMuid
 
typedef CTitle TJournal
 
typedef string TVolume
 
typedef string TIssue
 
typedef string TPages
 
typedef CDate TDate
 
typedef int TSerial_number
 
typedef string TTitle
 
typedef CPubMedId TPmid
 
typedef Tparent::CMemberIndex< E_memberIndex, 12 > TmemberIndex
 
- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- Public Types inherited from IAbstractCitation
enum  ELabelFlags {
  fLabel_Unique = 1 << 0 , fLabel_FlatNCBI = 1 << 1 , fLabel_FlatEMBL = 1 << 2 , fLabel_ISO_JTA = 1 << 3 ,
  fLabel_NoBadCitGen = 1 << 4 , fLabel_NoUnpubAffil = 1 << 5 , fLabel_Consortia = 1 << 30
}
 Flags for use by GetLabel methods. More...
 
enum  ELabelVersion {
  eLabel_V1 = 1 , eLabel_V2 = 2 , eLabel_MinVersion = eLabel_V1 , eLabel_DefaultVersion = eLabel_V1 ,
  eLabel_MaxVersion = eLabel_V2
}
 
typedef int TLabelFlags
 binary OR of ELabelFlags More...
 
- Static Public Member Functions inherited from CSerialObject
static void SetVerifyDataThread (ESerialVerifyData verify)
 
static void SetVerifyDataGlobal (ESerialVerifyData verify)
 
static string UnassignedString (void)
 
static CStringUTF8 UnassignedStringUTF8 (void)
 
static char UnassignedByte (void)
 
- Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_XNCBI_EXPORT void ThrowNullPointerException (const type_info &type)
 
static EAllocFillMode GetAllocFillMode (void)
 
static void SetAllocFillMode (EAllocFillMode mode)
 
static void SetAllocFillMode (const string &value)
 Set mode from configuration parameter value. More...
 
- Static Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 
- Static Public Member Functions inherited from ICitationBase
static string FixPages (const string &orig_pages)
 Canonicalize a range of page numbers, expanding Medline-style 125-35 -> 125-135, F124-34 -> F124-F134, and 12a-c -> 12a-12c, and returning a single number (without a dash) for a single page. More...
 
static string GetParenthesizedYear (const CDate &date)
 
static bool HasText (const string &s)
 
static bool HasText (const string *s)
 
static void MaybeAddSpace (string *label)
 
static void NoteSup (string *label, const CImprint &imp)
 
static bool SWNC (const string &str, const string &pfx)
 
- Static Public Attributes inherited from CSerialObject
static const char * ms_UnassignedStr = "<*unassigned*>"
 
static const char ms_UnassignedByte = char(0xcd)
 
- Static Public Attributes inherited from CObject
static const TCount eCounterBitsCanBeDeleted = 1 << 0
 Define possible object states. More...
 
static const TCount eCounterBitsInPlainHeap = 1 << 1
 Heap signature was found. More...
 
static const TCount eCounterBitsPlaceMask
 Mask for 'in heap' state flags. More...
 
static const int eCounterStep = 1 << 2
 Skip over the "in heap" bits. More...
 
static const TCount eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
 Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
 
static const TCount eCounterStateMask
 Valid object, and object in heap. More...
 
- Static Protected Member Functions inherited from ICitationBase
static bool x_GetLabelV1 (string *label, bool unique, const CAuth_list *authors, const CImprint *imprint, const CTitle *title, const CCit_book *book, const CCit_jour *journal, const string *title1=0, const string *title2=0, const string *titleunique=0, const string *date=0, const string *volume=0, const string *issue=0, const string *pages=0, bool unpublished=false)
 

Detailed Description

Definition at line 52 of file Cit_gen.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 54 of file Cit_gen.hpp.

Constructor & Destructor Documentation

◆ CCit_gen() [1/2]

CCit_gen::CCit_gen ( void  )
inline

Definition at line 79 of file Cit_gen.hpp.

◆ ~CCit_gen()

CCit_gen::~CCit_gen ( void  )

Definition at line 51 of file Cit_gen.cpp.

◆ CCit_gen() [2/2]

CCit_gen::CCit_gen ( const CCit_gen value)
private

Member Function Documentation

◆ GetLabelV1()

bool CCit_gen::GetLabelV1 ( string label,
TLabelFlags  flags 
) const
overrideprotectedvirtual

◆ GetLabelV2()

bool CCit_gen::GetLabelV2 ( string label,
TLabelFlags  flags 
) const
overrideprotectedvirtual

◆ operator=()

CCit_gen& CCit_gen::operator= ( const CCit_gen value)
private

The documentation for this class was generated from the following files:
Modified on Mon Mar 04 05:11:01 2024 by modify_doxy.py rev. 669887