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

Represents ASN.1 type Id-pat defined in file biblio.asn

Search Toolkit Book for CId_pat

#include <objects/biblio/Id_pat.hpp>

+ Inheritance diagram for CId_pat:
+ Collaboration diagram for CId_pat:

Public Member Functions

 CId_pat (void)
 
 ~CId_pat (void)
 
bool Match (const CId_pat &idp2) const
 
const stringGetSomeNumber (void) const
 
- Public Member Functions inherited from CId_pat_Base
 CId_pat_Base (void)
 
virtual ~CId_pat_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetCountry (void) const
 Patent Document Country Check if a value has been assigned to Country data member. More...
 
bool CanGetCountry (void) const
 Check if it is safe to call GetCountry method. More...
 
void ResetCountry (void)
 Reset Country data member. More...
 
const TCountryGetCountry (void) const
 Get the Country member data. More...
 
void SetCountry (const TCountry &value)
 Assign a value to Country data member. More...
 
void SetCountry (TCountry &&value)
 
TCountrySetCountry (void)
 Assign a value to Country data member. More...
 
bool IsSetId (void) const
 Check if a value has been assigned to Id data member. More...
 
bool CanGetId (void) const
 Check if it is safe to call GetId method. More...
 
void ResetId (void)
 Reset Id data member. More...
 
const TIdGetId (void) const
 Get the Id member data. More...
 
void SetId (TId &value)
 Assign a value to Id data member. More...
 
TIdSetId (void)
 Assign a value to Id data member. More...
 
bool IsSetDoc_type (void) const
 Patent Doc Type Check if a value has been assigned to Doc_type data member. More...
 
bool CanGetDoc_type (void) const
 Check if it is safe to call GetDoc_type method. More...
 
void ResetDoc_type (void)
 Reset Doc_type data member. More...
 
const TDoc_typeGetDoc_type (void) const
 Get the Doc_type member data. More...
 
void SetDoc_type (const TDoc_type &value)
 Assign a value to Doc_type data member. More...
 
void SetDoc_type (TDoc_type &&value)
 
TDoc_typeSetDoc_type (void)
 Assign a value to Doc_type 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 ()
 

Static Public Member Functions

static bool Id_Match (const C_Id &id1, const C_Id &id2)
 
- 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)
 

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 CId_pat_Base Tparent
 

Private Member Functions

 CId_pat (const CId_pat &)
 
CId_patoperator= (const CId_pat &)
 

Additional Inherited Members

- Public Types inherited from CId_pat_Base
enum class  E_memberIndex { e__allMandatory = 0 , e_country , e_id , e_doc_type }
 
typedef string TCountry
 
typedef C_Id TId
 
typedef string TDoc_type
 
typedef Tparent::CMemberIndex< E_memberIndex, 4 > 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 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 Id_pat.hpp.

Member Typedef Documentation

◆ Tparent

typedef CId_pat_Base CId_pat::Tparent
private

Definition at line 54 of file Id_pat.hpp.

Constructor & Destructor Documentation

◆ CId_pat() [1/2]

CId_pat::CId_pat ( void  )
inline

Definition at line 85 of file Id_pat.hpp.

◆ ~CId_pat()

CId_pat::~CId_pat ( void  )

Definition at line 50 of file Id_pat.cpp.

◆ CId_pat() [2/2]

CId_pat::CId_pat ( const CId_pat )
private

Member Function Documentation

◆ GetLabelV1()

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

Implements ICitationBase.

Definition at line 82 of file Id_pat.cpp.

References CId_pat_Base::GetCountry(), GetSomeNumber(), label, and ICitationBase::x_GetLabelV1().

Referenced by GetLabelV2().

◆ GetLabelV2()

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

Implements ICitationBase.

Definition at line 89 of file Id_pat.cpp.

References flags, GetLabelV1(), and label.

◆ GetSomeNumber()

const string & CId_pat::GetSomeNumber ( void  ) const

◆ Id_Match()

bool CId_pat::Id_Match ( const C_Id id1,
const C_Id id2 
)
static

◆ Match()

bool CId_pat::Match ( const CId_pat idp2) const

◆ operator=()

CId_pat& CId_pat::operator= ( const CId_pat )
private

The documentation for this class was generated from the following files:
Modified on Thu Feb 22 17:10:55 2024 by modify_doxy.py rev. 669887