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

Represents ASN.1 type Pub-equiv defined in file pub.asn

Search Toolkit Book for CPub_equiv

#include <objects/pub/Pub_equiv.hpp>

+ Inheritance diagram for CPub_equiv:
+ Collaboration diagram for CPub_equiv:

Public Member Functions

 CPub_equiv (void)
 
 ~CPub_equiv (void)
 
bool GetLabel (string *label, TLabelFlags flags=0, ELabelVersion version=eLabel_DefaultVersion) const override
 Append a label to "label" based on content. More...
 
bool SameCitation (const CPub_equiv &other) const
 
bool SameCitation (const CPub &pub) const
 
- Public Member Functions inherited from CPub_equiv_Base
 CPub_equiv_Base (void)
 
virtual ~CPub_equiv_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSet (void) const
 Check if a value has been assigned to data member. More...
 
bool CanGet (void) const
 Check if it is safe to call Get method. More...
 
void Reset (void)
 Reset data member. More...
 
const TdataGet (void) const
 Get the member data. More...
 
TdataSet (void)
 Assign a value to data member. More...
 
 operator const Tdata & (void) const
 Conversion operator to 'const Tdata' type. More...
 
 operator Tdata & (void)
 Conversion operator to 'Tdata' type. 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 IAbstractCitation
virtual ~IAbstractCitation ()
 

Private Types

typedef CPub_equiv_Base Tparent
 

Private Member Functions

 CPub_equiv (const CPub_equiv &value)
 
CPub_equivoperator= (const CPub_equiv &value)
 

Additional Inherited Members

- Public Types inherited from CPub_equiv_Base
typedef list< CRef< CPub > > Tdata
 
- 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 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...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 52 of file Pub_equiv.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 55 of file Pub_equiv.hpp.

Constructor & Destructor Documentation

◆ CPub_equiv() [1/2]

CPub_equiv::CPub_equiv ( void  )
inline

Definition at line 80 of file Pub_equiv.hpp.

◆ ~CPub_equiv()

CPub_equiv::~CPub_equiv ( void  )

Definition at line 51 of file Pub_equiv.cpp.

◆ CPub_equiv() [2/2]

CPub_equiv::CPub_equiv ( const CPub_equiv value)
private

Member Function Documentation

◆ GetLabel()

bool CPub_equiv::GetLabel ( string label,
TLabelFlags  flags = 0,
ELabelVersion  version = eLabel_DefaultVersion 
) const
overridevirtual

◆ operator=()

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

◆ SameCitation() [1/2]

bool CPub_equiv::SameCitation ( const CPub pub) const

Definition at line 114 of file Pub_equiv.cpp.

References CPub_equiv_Base::Get(), ITERATE, and CPub_Base::Which().

◆ SameCitation() [2/2]

bool CPub_equiv::SameCitation ( const CPub_equiv other) const

The documentation for this class was generated from the following files:
Modified on Sun Apr 14 05:24:23 2024 by modify_doxy.py rev. 669887