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

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

Search Toolkit Book for CCit_pat

#include <objects/biblio/Cit_pat.hpp>

+ Inheritance diagram for CCit_pat:
+ Collaboration diagram for CCit_pat:

Public Member Functions

 CCit_pat (void)
 
 ~CCit_pat (void)
 
- Public Member Functions inherited from CCit_pat_Base
 CCit_pat_Base (void)
 
virtual ~CCit_pat_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetTitle (void) const
 Check if a value has been assigned to Title data member. 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 IsSetAuthors (void) const
 author/inventor 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 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 IsSetDoc_type (void) const
 Patent Document 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...
 
bool IsSetNumber (void) const
 Patent Document Number Check if a value has been assigned to Number data member. More...
 
bool CanGetNumber (void) const
 Check if it is safe to call GetNumber method. More...
 
void ResetNumber (void)
 Reset Number data member. More...
 
const TNumberGetNumber (void) const
 Get the Number member data. More...
 
void SetNumber (const TNumber &value)
 Assign a value to Number data member. More...
 
void SetNumber (TNumber &&value)
 
TNumberSetNumber (void)
 Assign a value to Number data member. More...
 
bool IsSetDate_issue (void) const
 Patent Issue/Pub Date Check if a value has been assigned to Date_issue data member. More...
 
bool CanGetDate_issue (void) const
 Check if it is safe to call GetDate_issue method. More...
 
void ResetDate_issue (void)
 Reset Date_issue data member. More...
 
const TDate_issueGetDate_issue (void) const
 Get the Date_issue member data. More...
 
void SetDate_issue (TDate_issue &value)
 Assign a value to Date_issue data member. More...
 
TDate_issueSetDate_issue (void)
 Assign a value to Date_issue data member. More...
 
bool IsSetClass (void) const
 Patent Doc Class Code Check if a value has been assigned to Class data member. More...
 
bool CanGetClass (void) const
 Check if it is safe to call GetClass method. More...
 
void ResetClass (void)
 Reset Class data member. More...
 
const TClassGetClass (void) const
 Get the Class member data. More...
 
TClassSetClass (void)
 Assign a value to Class data member. More...
 
bool IsSetApp_number (void) const
 Patent Doc Appl Number Check if a value has been assigned to App_number data member. More...
 
bool CanGetApp_number (void) const
 Check if it is safe to call GetApp_number method. More...
 
void ResetApp_number (void)
 Reset App_number data member. More...
 
const TApp_numberGetApp_number (void) const
 Get the App_number member data. More...
 
void SetApp_number (const TApp_number &value)
 Assign a value to App_number data member. More...
 
void SetApp_number (TApp_number &&value)
 
TApp_numberSetApp_number (void)
 Assign a value to App_number data member. More...
 
bool IsSetApp_date (void) const
 Patent Appl File Date Check if a value has been assigned to App_date data member. More...
 
bool CanGetApp_date (void) const
 Check if it is safe to call GetApp_date method. More...
 
void ResetApp_date (void)
 Reset App_date data member. More...
 
const TApp_dateGetApp_date (void) const
 Get the App_date member data. More...
 
void SetApp_date (TApp_date &value)
 Assign a value to App_date data member. More...
 
TApp_dateSetApp_date (void)
 Assign a value to App_date data member. More...
 
bool IsSetApplicants (void) const
 Applicants Check if a value has been assigned to Applicants data member. More...
 
bool CanGetApplicants (void) const
 Check if it is safe to call GetApplicants method. More...
 
void ResetApplicants (void)
 Reset Applicants data member. More...
 
const TApplicantsGetApplicants (void) const
 Get the Applicants member data. More...
 
void SetApplicants (TApplicants &value)
 Assign a value to Applicants data member. More...
 
TApplicantsSetApplicants (void)
 Assign a value to Applicants data member. More...
 
bool IsSetAssignees (void) const
 Assignees Check if a value has been assigned to Assignees data member. More...
 
bool CanGetAssignees (void) const
 Check if it is safe to call GetAssignees method. More...
 
void ResetAssignees (void)
 Reset Assignees data member. More...
 
const TAssigneesGetAssignees (void) const
 Get the Assignees member data. More...
 
void SetAssignees (TAssignees &value)
 Assign a value to Assignees data member. More...
 
TAssigneesSetAssignees (void)
 Assign a value to Assignees data member. More...
 
bool IsSetPriority (void) const
 Priorities Check if a value has been assigned to Priority data member. More...
 
bool CanGetPriority (void) const
 Check if it is safe to call GetPriority method. More...
 
void ResetPriority (void)
 Reset Priority data member. More...
 
const TPriorityGetPriority (void) const
 Get the Priority member data. More...
 
TPrioritySetPriority (void)
 Assign a value to Priority data member. More...
 
bool IsSetAbstract (void) const
 abstract of patent Check if a value has been assigned to Abstract data member. More...
 
bool CanGetAbstract (void) const
 Check if it is safe to call GetAbstract method. More...
 
void ResetAbstract (void)
 Reset Abstract data member. More...
 
const TAbstractGetAbstract (void) const
 Get the Abstract member data. More...
 
void SetAbstract (const TAbstract &value)
 Assign a value to Abstract data member. More...
 
void SetAbstract (TAbstract &&value)
 
TAbstractSetAbstract (void)
 Assign a value to Abstract 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_pat_Base Tparent
 

Private Member Functions

 CCit_pat (const CCit_pat &value)
 
CCit_patoperator= (const CCit_pat &value)
 

Static Private Member Functions

static bool x_GetLabelV2 (string *label, const CAuth_list &authors, string prefix)
 

Additional Inherited Members

- Public Types inherited from CCit_pat_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_title , e_authors , e_country ,
  e_doc_type , e_number , e_date_issue , e_class ,
  e_app_number , e_app_date , e_applicants , e_assignees ,
  e_priority , e_abstract
}
 
typedef string TTitle
 
typedef CAuth_list TAuthors
 
typedef string TCountry
 
typedef string TDoc_type
 
typedef string TNumber
 
typedef CDate TDate_issue
 
typedef list< stringTClass
 
typedef string TApp_number
 
typedef CDate TApp_date
 
typedef CAuth_list TApplicants
 
typedef CAuth_list TAssignees
 
typedef list< CRef< CPatent_priority > > TPriority
 
typedef string TAbstract
 
typedef Tparent::CMemberIndex< E_memberIndex, 14 > 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_pat.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 54 of file Cit_pat.hpp.

Constructor & Destructor Documentation

◆ CCit_pat() [1/2]

CCit_pat::CCit_pat ( void  )
inline

Definition at line 81 of file Cit_pat.hpp.

◆ ~CCit_pat()

CCit_pat::~CCit_pat ( void  )

Definition at line 51 of file Cit_pat.cpp.

◆ CCit_pat() [2/2]

CCit_pat::CCit_pat ( const CCit_pat value)
private

Member Function Documentation

◆ GetLabelV1()

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

◆ GetLabelV2()

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

◆ operator=()

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

◆ x_GetLabelV2()

bool CCit_pat::x_GetLabelV2 ( string label,
const CAuth_list authors,
string  prefix 
)
staticprivate

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