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

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

Search Toolkit Book for CCit_sub

#include <objects/biblio/Cit_sub.hpp>

+ Inheritance diagram for CCit_sub:
+ Collaboration diagram for CCit_sub:

Public Member Functions

 CCit_sub (void)
 
 ~CCit_sub (void)
 
- Public Member Functions inherited from CCit_sub_Base
 CCit_sub_Base (void)
 
virtual ~CCit_sub_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetAuthors (void) const
 not necessarily authors of the paper 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 IsSetImp (void) const
 this only used to get date. More...
 
bool CanGetImp (void) const
 Check if it is safe to call GetImp method. More...
 
void ResetImp (void)
 Reset Imp data member. More...
 
const TImpGetImp (void) const
 Get the Imp member data. More...
 
void SetImp (TImp &value)
 Assign a value to Imp data member. More...
 
TImpSetImp (void)
 Assign a value to Imp data member. More...
 
bool IsSetMedium (void) const
 Check if a value has been assigned to Medium data member. More...
 
bool CanGetMedium (void) const
 Check if it is safe to call GetMedium method. More...
 
void ResetMedium (void)
 Reset Medium data member. More...
 
TMedium GetMedium (void) const
 Get the Medium member data. More...
 
void SetMedium (TMedium value)
 Assign a value to Medium data member. More...
 
TMediumSetMedium (void)
 Assign a value to Medium data member. More...
 
bool IsSetDate (void) const
 replaces imp, will become required 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 IsSetDescr (void) const
 description of changes for public view Check if a value has been assigned to Descr data member. More...
 
bool CanGetDescr (void) const
 Check if it is safe to call GetDescr method. More...
 
void ResetDescr (void)
 Reset Descr data member. More...
 
const TDescrGetDescr (void) const
 Get the Descr member data. More...
 
void SetDescr (const TDescr &value)
 Assign a value to Descr data member. More...
 
void SetDescr (TDescr &&value)
 
TDescrSetDescr (void)
 Assign a value to Descr 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_sub_Base Tparent
 

Private Member Functions

 CCit_sub (const CCit_sub &value)
 
CCit_suboperator= (const CCit_sub &value)
 

Additional Inherited Members

- Public Types inherited from CCit_sub_Base
enum  EMedium {
  eMedium_paper = 1 , eMedium_tape = 2 , eMedium_floppy = 3 , eMedium_email = 4 ,
  eMedium_other = 255
}
 medium of submission More...
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_authors , e_imp , e_medium ,
  e_date , e_descr
}
 
typedef CAuth_list TAuthors
 
typedef CImprint TImp
 
typedef EMedium TMedium
 
typedef CDate TDate
 
typedef string TDescr
 
typedef Tparent::CMemberIndex< E_memberIndex, 6 > 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 CCit_sub_Base
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() EMedium (void)
 Access to EMedium's attributes (values, names) as defined in spec. 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_sub.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 54 of file Cit_sub.hpp.

Constructor & Destructor Documentation

◆ CCit_sub() [1/2]

CCit_sub::CCit_sub ( void  )
inline

Definition at line 79 of file Cit_sub.hpp.

◆ ~CCit_sub()

CCit_sub::~CCit_sub ( void  )

Definition at line 51 of file Cit_sub.cpp.

◆ CCit_sub() [2/2]

CCit_sub::CCit_sub ( const CCit_sub value)
private

Member Function Documentation

◆ GetLabelV1()

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

◆ GetLabelV2()

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

◆ operator=()

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

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