NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members

Represents ASN.1 type Medline-entry defined in file medline.asn

Search Toolkit Book for CMedline_entry_Base

a MEDLINE or PubMed entry regular medline record More...

#include <objects/medline/Medline_entry_.hpp>

+ Inheritance diagram for CMedline_entry_Base:
+ Collaboration diagram for CMedline_entry_Base:

Public Types

enum  EStatus { eStatus_publisher = 1, eStatus_premedline = 2, eStatus_medline = 3 }
 
typedef int TUid
 
typedef CDate TEm
 
typedef CCit_art TCit
 
typedef string TAbstract
 
typedef list< CRef< CMedline_mesh > > TMesh
 
typedef list< CRef< CMedline_rn > > TSubstance
 
typedef list< CRef< CMedline_si > > TXref
 
typedef list< stringTIdnum
 
typedef list< stringTGene
 
typedef CPubMedId TPmid
 
typedef list< stringTPub_type
 
typedef list< CRef< CMedline_field > > TMlfield
 
typedef int TStatus
 
- 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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CMedline_entry_Base (void)
 
virtual ~CMedline_entry_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetUid (void) const
 MEDLINE UID, sometimes not yet available if from PubMed Check if a value has been assigned to Uid data member. More...
 
bool CanGetUid (void) const
 Check if it is safe to call GetUid method. More...
 
void ResetUid (void)
 Reset Uid data member. More...
 
TUid GetUid (void) const
 Get the Uid member data. More...
 
void SetUid (TUid value)
 Assign a value to Uid data member. More...
 
TUidSetUid (void)
 Assign a value to Uid data member. More...
 
bool IsSetEm (void) const
 Entry Month Check if a value has been assigned to Em data member. More...
 
bool CanGetEm (void) const
 Check if it is safe to call GetEm method. More...
 
void ResetEm (void)
 Reset Em data member. More...
 
const TEmGetEm (void) const
 Get the Em member data. More...
 
void SetEm (TEm &value)
 Assign a value to Em data member. More...
 
TEmSetEm (void)
 Assign a value to Em data member. More...
 
bool IsSetCit (void) const
 article citation 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 (TCit &value)
 Assign a value to Cit data member. More...
 
TCitSetCit (void)
 Assign a value to Cit data member. More...
 
bool IsSetAbstract (void) const
 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...
 
TAbstractSetAbstract (void)
 Assign a value to Abstract data member. More...
 
bool IsSetMesh (void) const
 Check if a value has been assigned to Mesh data member. More...
 
bool CanGetMesh (void) const
 Check if it is safe to call GetMesh method. More...
 
void ResetMesh (void)
 Reset Mesh data member. More...
 
const TMeshGetMesh (void) const
 Get the Mesh member data. More...
 
TMeshSetMesh (void)
 Assign a value to Mesh data member. More...
 
bool IsSetSubstance (void) const
 Check if a value has been assigned to Substance data member. More...
 
bool CanGetSubstance (void) const
 Check if it is safe to call GetSubstance method. More...
 
void ResetSubstance (void)
 Reset Substance data member. More...
 
const TSubstanceGetSubstance (void) const
 Get the Substance member data. More...
 
TSubstanceSetSubstance (void)
 Assign a value to Substance data member. More...
 
bool IsSetXref (void) const
 Check if a value has been assigned to Xref data member. More...
 
bool CanGetXref (void) const
 Check if it is safe to call GetXref method. More...
 
void ResetXref (void)
 Reset Xref data member. More...
 
const TXrefGetXref (void) const
 Get the Xref member data. More...
 
TXrefSetXref (void)
 Assign a value to Xref data member. More...
 
bool IsSetIdnum (void) const
 ID Number (grants, contracts) Check if a value has been assigned to Idnum data member. More...
 
bool CanGetIdnum (void) const
 Check if it is safe to call GetIdnum method. More...
 
void ResetIdnum (void)
 Reset Idnum data member. More...
 
const TIdnumGetIdnum (void) const
 Get the Idnum member data. More...
 
TIdnumSetIdnum (void)
 Assign a value to Idnum data member. More...
 
bool IsSetGene (void) const
 Check if a value has been assigned to Gene data member. More...
 
bool CanGetGene (void) const
 Check if it is safe to call GetGene method. More...
 
void ResetGene (void)
 Reset Gene data member. More...
 
const TGeneGetGene (void) const
 Get the Gene member data. More...
 
TGeneSetGene (void)
 Assign a value to Gene data member. More...
 
bool IsSetPmid (void) const
 MEDLINE records may include the PubMedId 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...
 
bool IsSetPub_type (void) const
 may show publication types (review, etc) Check if a value has been assigned to Pub_type data member. More...
 
bool CanGetPub_type (void) const
 Check if it is safe to call GetPub_type method. More...
 
void ResetPub_type (void)
 Reset Pub_type data member. More...
 
const TPub_typeGetPub_type (void) const
 Get the Pub_type member data. More...
 
TPub_typeSetPub_type (void)
 Assign a value to Pub_type data member. More...
 
bool IsSetMlfield (void) const
 additional Medline field types Check if a value has been assigned to Mlfield data member. More...
 
bool CanGetMlfield (void) const
 Check if it is safe to call GetMlfield method. More...
 
void ResetMlfield (void)
 Reset Mlfield data member. More...
 
const TMlfieldGetMlfield (void) const
 Get the Mlfield member data. More...
 
TMlfieldSetMlfield (void)
 Assign a value to Mlfield data member. More...
 
bool IsSetStatus (void) const
 Check if a value has been assigned to Status data member. More...
 
bool CanGetStatus (void) const
 Check if it is safe to call GetStatus method. More...
 
void ResetStatus (void)
 Reset Status data member. More...
 
void SetDefaultStatus (void)
 Assign default value to Status data member. More...
 
TStatus GetStatus (void) const
 Get the Status member data. More...
 
void SetStatus (TStatus value)
 Assign a value to Status data member. More...
 
TStatusSetStatus (void)
 Assign a value to Status 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
 

Static Public Member Functions

static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() EStatus (void)
 Access to EStatus'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_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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)
 

Private Types

typedef CSerialObject Tparent
 

Private Member Functions

 CMedline_entry_Base (const CMedline_entry_Base &)
 
CMedline_entry_Baseoperator= (const CMedline_entry_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
int m_Uid
 
CRef< TEmm_Em
 
CRef< TCitm_Cit
 
string m_Abstract
 
list< CRef< CMedline_mesh > > m_Mesh
 
list< CRef< CMedline_rn > > m_Substance
 
list< CRef< CMedline_si > > m_Xref
 
list< stringm_Idnum
 
list< stringm_Gene
 
CPubMedId m_Pmid
 
list< stringm_Pub_type
 
list< CRef< CMedline_field > > m_Mlfield
 
int m_Status
 

Additional Inherited Members

- 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

a MEDLINE or PubMed entry regular medline record

CMedline_entry_Base

Definition at line 85 of file Medline_entry_.hpp.

Member Typedef Documentation

Definition at line 110 of file Medline_entry_.hpp.

Definition at line 109 of file Medline_entry_.hpp.

Definition at line 108 of file Medline_entry_.hpp.

Definition at line 115 of file Medline_entry_.hpp.

Definition at line 114 of file Medline_entry_.hpp.

Definition at line 111 of file Medline_entry_.hpp.

Definition at line 118 of file Medline_entry_.hpp.

Definition at line 87 of file Medline_entry_.hpp.

Definition at line 116 of file Medline_entry_.hpp.

Definition at line 117 of file Medline_entry_.hpp.

Definition at line 119 of file Medline_entry_.hpp.

Definition at line 112 of file Medline_entry_.hpp.

Definition at line 107 of file Medline_entry_.hpp.

Definition at line 113 of file Medline_entry_.hpp.

Constructor & Destructor Documentation

END_CLASS_INFO CMedline_entry_Base::CMedline_entry_Base ( void  )

Definition at line 180 of file Medline_entry_.cpp.

References CObject::IsAllocatedInPool(), m_set_State, ResetCit(), and ResetEm().

CMedline_entry_Base::~CMedline_entry_Base ( void  )
virtual

Definition at line 191 of file Medline_entry_.cpp.

CMedline_entry_Base::CMedline_entry_Base ( const CMedline_entry_Base )
private

Member Function Documentation

bool CMedline_entry_Base::CanGetAbstract ( void  ) const
inline

Check if it is safe to call GetAbstract method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 722 of file Medline_entry_.hpp.

References IsSetAbstract().

Referenced by GetAbstract().

bool CMedline_entry_Base::CanGetCit ( void  ) const
inline

Check if it is safe to call GetCit method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 692 of file Medline_entry_.hpp.

Referenced by GetPubdescFromEntrezById(), CReloadPublications::LookUpByPmid(), s_GetCitIds(), and CReferenceItem::x_Init().

bool CMedline_entry_Base::CanGetEm ( void  ) const
inline

Check if it is safe to call GetEm method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 662 of file Medline_entry_.hpp.

bool CMedline_entry_Base::CanGetGene ( void  ) const
inline

Check if it is safe to call GetGene method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 862 of file Medline_entry_.hpp.

bool CMedline_entry_Base::CanGetIdnum ( void  ) const
inline

Check if it is safe to call GetIdnum method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 837 of file Medline_entry_.hpp.

bool CMedline_entry_Base::CanGetMesh ( void  ) const
inline

Check if it is safe to call GetMesh method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 762 of file Medline_entry_.hpp.

bool CMedline_entry_Base::CanGetMlfield ( void  ) const
inline

Check if it is safe to call GetMlfield method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 954 of file Medline_entry_.hpp.

bool CMedline_entry_Base::CanGetPmid ( void  ) const
inline

Check if it is safe to call GetPmid method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 887 of file Medline_entry_.hpp.

References IsSetPmid().

Referenced by GetPmid(), s_GetCitIds(), and CReferenceItem::x_Init().

bool CMedline_entry_Base::CanGetPub_type ( void  ) const
inline

Check if it is safe to call GetPub_type method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 929 of file Medline_entry_.hpp.

bool CMedline_entry_Base::CanGetStatus ( void  ) const
inline

Check if it is safe to call GetStatus method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 979 of file Medline_entry_.hpp.

bool CMedline_entry_Base::CanGetSubstance ( void  ) const
inline

Check if it is safe to call GetSubstance method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 787 of file Medline_entry_.hpp.

bool CMedline_entry_Base::CanGetUid ( void  ) const
inline

Check if it is safe to call GetUid method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 615 of file Medline_entry_.hpp.

References IsSetUid().

Referenced by GetUid(), s_GetCitIds(), and CReferenceItem::x_Init().

bool CMedline_entry_Base::CanGetXref ( void  ) const
inline

Check if it is safe to call GetXref method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 812 of file Medline_entry_.hpp.

CMedline_entry_Base::DECLARE_INTERNAL_TYPE_INFO ( )
static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME() CMedline_entry_Base::EStatus ( void  )
static

Access to EStatus's attributes (values, names) as defined in spec.

const CMedline_entry_Base::TAbstract & CMedline_entry_Base::GetAbstract ( void  ) const
inline

Get the Abstract member data.

Returns
Reference to the member data.

Definition at line 728 of file Medline_entry_.hpp.

References CanGetAbstract(), m_Abstract, and CSerialObject::ThrowUnassigned().

const CMedline_entry_Base::TCit & CMedline_entry_Base::GetCit ( void  ) const
inline

Get the Cit member data.

Returns
Reference to the member data.

Definition at line 698 of file Medline_entry_.hpp.

References m_Cit, and ResetCit().

Referenced by CMedline_entry::GetLabelV1(), CMedline_entry::GetLabelV2(), GetPubdescFromEntrezById(), CNewCleanup_imp::MedlineEntryBC(), s_GetCitIds(), and CReferenceItem::x_Init().

const CMedline_entry_Base::TEm & CMedline_entry_Base::GetEm ( void  ) const
inline

Get the Em member data.

Returns
Reference to the member data.

Definition at line 668 of file Medline_entry_.hpp.

References m_Em, and ResetEm().

const CMedline_entry_Base::TGene & CMedline_entry_Base::GetGene ( void  ) const
inline

Get the Gene member data.

Returns
Reference to the member data.

Definition at line 868 of file Medline_entry_.hpp.

References m_Gene.

const CMedline_entry_Base::TIdnum & CMedline_entry_Base::GetIdnum ( void  ) const
inline

Get the Idnum member data.

Returns
Reference to the member data.

Definition at line 843 of file Medline_entry_.hpp.

References m_Idnum.

const CMedline_entry_Base::TMesh & CMedline_entry_Base::GetMesh ( void  ) const
inline

Get the Mesh member data.

Returns
Reference to the member data.

Definition at line 768 of file Medline_entry_.hpp.

References m_Mesh.

const CMedline_entry_Base::TMlfield & CMedline_entry_Base::GetMlfield ( void  ) const
inline

Get the Mlfield member data.

Returns
Reference to the member data.

Definition at line 960 of file Medline_entry_.hpp.

References m_Mlfield.

const CMedline_entry_Base::TPmid & CMedline_entry_Base::GetPmid ( void  ) const
inline

Get the Pmid member data.

Returns
Reference to the member data.

Definition at line 900 of file Medline_entry_.hpp.

References CanGetPmid(), m_Pmid, and CSerialObject::ThrowUnassigned().

Referenced by CMedline_entry::GetLabelV1(), s_GetCitIds(), and CReferenceItem::x_Init().

const CMedline_entry_Base::TPub_type & CMedline_entry_Base::GetPub_type ( void  ) const
inline

Get the Pub_type member data.

Returns
Reference to the member data.

Definition at line 935 of file Medline_entry_.hpp.

References m_Pub_type.

CMedline_entry_Base::TStatus CMedline_entry_Base::GetStatus ( void  ) const
inline

Get the Status member data.

Returns
Copy of the member data.

Definition at line 998 of file Medline_entry_.hpp.

References m_Status.

const CMedline_entry_Base::TSubstance & CMedline_entry_Base::GetSubstance ( void  ) const
inline

Get the Substance member data.

Returns
Reference to the member data.

Definition at line 793 of file Medline_entry_.hpp.

References m_Substance.

CMedline_entry_Base::TUid CMedline_entry_Base::GetUid ( void  ) const
inline

Get the Uid member data.

Returns
Copy of the member data.

Definition at line 628 of file Medline_entry_.hpp.

References CanGetUid(), m_Uid, and CSerialObject::ThrowUnassigned().

Referenced by CMedline_entry::GetLabelV1(), s_GetCitIds(), and CReferenceItem::x_Init().

const CMedline_entry_Base::TXref & CMedline_entry_Base::GetXref ( void  ) const
inline

Get the Xref member data.

Returns
Reference to the member data.

Definition at line 818 of file Medline_entry_.hpp.

References m_Xref.

bool CMedline_entry_Base::IsSetAbstract ( void  ) const
inline

Check if a value has been assigned to Abstract data member.

Data member Abstract is optional; its type is defined as 'typedef string TAbstract'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 716 of file Medline_entry_.hpp.

References m_set_State.

Referenced by CanGetAbstract(), and SetAbstract().

bool CMedline_entry_Base::IsSetCit ( void  ) const
inline

article citation Check if a value has been assigned to Cit data member.

Data member Cit is mandatory; its type is defined as 'typedef CCit_art TCit'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 686 of file Medline_entry_.hpp.

References m_Cit.

Referenced by CAutogeneratedCleanup::x_BasicCleanupSeqFeat_xref_E_E_data_data_variation_variation_pub_pub_medline_medline_ETC().

bool CMedline_entry_Base::IsSetEm ( void  ) const
inline

Entry Month Check if a value has been assigned to Em data member.

Data member Em is mandatory; its type is defined as 'typedef CDate TEm'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 656 of file Medline_entry_.hpp.

References m_Em.

Referenced by CAutogeneratedCleanup::x_BasicCleanupSeqFeat_xref_E_E_data_data_variation_variation_pub_pub_medline_medline_ETC().

bool CMedline_entry_Base::IsSetGene ( void  ) const
inline

Check if a value has been assigned to Gene data member.

Data member Gene is optional; its type is defined as 'typedef list< string > TGene'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 856 of file Medline_entry_.hpp.

References m_set_State.

bool CMedline_entry_Base::IsSetIdnum ( void  ) const
inline

ID Number (grants, contracts) Check if a value has been assigned to Idnum data member.

Data member Idnum is optional; its type is defined as 'typedef list< string > TIdnum'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 831 of file Medline_entry_.hpp.

References m_set_State.

bool CMedline_entry_Base::IsSetMesh ( void  ) const
inline

Check if a value has been assigned to Mesh data member.

Data member Mesh is optional; its type is defined as 'typedef list< CRef< CMedline_mesh > > TMesh'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 756 of file Medline_entry_.hpp.

References m_set_State.

bool CMedline_entry_Base::IsSetMlfield ( void  ) const
inline

additional Medline field types Check if a value has been assigned to Mlfield data member.

Data member Mlfield is optional; its type is defined as 'typedef list< CRef< CMedline_field > > TMlfield'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 948 of file Medline_entry_.hpp.

References m_set_State.

bool CMedline_entry_Base::IsSetPmid ( void  ) const
inline

MEDLINE records may include the PubMedId Check if a value has been assigned to Pmid data member.

Data member Pmid is optional; its type is defined as 'typedef CPubMedId TPmid'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 881 of file Medline_entry_.hpp.

References m_set_State.

Referenced by CanGetPmid(), and CMedline_entry::GetLabelV1().

bool CMedline_entry_Base::IsSetPub_type ( void  ) const
inline

may show publication types (review, etc) Check if a value has been assigned to Pub_type data member.

Data member Pub_type is optional; its type is defined as 'typedef list< string > TPub_type'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 923 of file Medline_entry_.hpp.

References m_set_State.

bool CMedline_entry_Base::IsSetStatus ( void  ) const
inline

Check if a value has been assigned to Status data member.

Data member Status is optional with default eStatus_medline; its type is defined as 'typedef int TStatus'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 973 of file Medline_entry_.hpp.

References m_set_State.

Referenced by SetStatus().

bool CMedline_entry_Base::IsSetSubstance ( void  ) const
inline

Check if a value has been assigned to Substance data member.

Data member Substance is optional; its type is defined as 'typedef list< CRef< CMedline_rn > > TSubstance'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 781 of file Medline_entry_.hpp.

References m_set_State.

bool CMedline_entry_Base::IsSetUid ( void  ) const
inline

MEDLINE UID, sometimes not yet available if from PubMed Check if a value has been assigned to Uid data member.

Data member Uid is optional; its type is defined as 'typedef int TUid'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 609 of file Medline_entry_.hpp.

References m_set_State.

Referenced by CanGetUid(), CMedline_entry::GetLabelV1(), and SetUid().

bool CMedline_entry_Base::IsSetXref ( void  ) const
inline

Check if a value has been assigned to Xref data member.

Data member Xref is optional; its type is defined as 'typedef list< CRef< CMedline_si > > TXref'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 806 of file Medline_entry_.hpp.

References m_set_State.

CMedline_entry_Base& CMedline_entry_Base::operator= ( const CMedline_entry_Base )
private
void CMedline_entry_Base::Reset ( void  )
virtual
void CMedline_entry_Base::ResetAbstract ( void  )

Reset Abstract data member.

Definition at line 94 of file Medline_entry_.cpp.

References m_Abstract, and m_set_State.

Referenced by Reset().

void CMedline_entry_Base::ResetCit ( void  )

Reset Cit data member.

Definition at line 80 of file Medline_entry_.cpp.

References m_Cit.

Referenced by CMedline_entry_Base(), GetCit(), Reset(), and SetCit().

END_ENUM_INFO void CMedline_entry_Base::ResetEm ( void  )

Reset Em data member.

Definition at line 66 of file Medline_entry_.cpp.

References m_Em.

Referenced by CMedline_entry_Base(), GetEm(), Reset(), and SetEm().

void CMedline_entry_Base::ResetGene ( void  )

Reset Gene data member.

Definition at line 124 of file Medline_entry_.cpp.

References m_Gene, and m_set_State.

Referenced by Reset().

void CMedline_entry_Base::ResetIdnum ( void  )

Reset Idnum data member.

Definition at line 118 of file Medline_entry_.cpp.

References m_Idnum, and m_set_State.

Referenced by Reset().

void CMedline_entry_Base::ResetMesh ( void  )

Reset Mesh data member.

Definition at line 100 of file Medline_entry_.cpp.

References m_Mesh, and m_set_State.

Referenced by Reset().

void CMedline_entry_Base::ResetMlfield ( void  )

Reset Mlfield data member.

Definition at line 136 of file Medline_entry_.cpp.

References m_Mlfield, and m_set_State.

Referenced by Reset().

void CMedline_entry_Base::ResetPmid ( void  )
inline

Reset Pmid data member.

Definition at line 893 of file Medline_entry_.hpp.

References m_Pmid, and m_set_State.

Referenced by Reset().

void CMedline_entry_Base::ResetPub_type ( void  )

Reset Pub_type data member.

Definition at line 130 of file Medline_entry_.cpp.

References m_Pub_type, and m_set_State.

Referenced by Reset().

void CMedline_entry_Base::ResetStatus ( void  )
inline

Reset Status data member.

Definition at line 985 of file Medline_entry_.hpp.

References eStatus_medline, m_set_State, and m_Status.

Referenced by Reset(), and SetDefaultStatus().

void CMedline_entry_Base::ResetSubstance ( void  )

Reset Substance data member.

Definition at line 106 of file Medline_entry_.cpp.

References m_set_State, and m_Substance.

Referenced by Reset().

void CMedline_entry_Base::ResetUid ( void  )
inline

Reset Uid data member.

Definition at line 621 of file Medline_entry_.hpp.

References m_set_State, and m_Uid.

Referenced by Reset().

void CMedline_entry_Base::ResetXref ( void  )

Reset Xref data member.

Definition at line 112 of file Medline_entry_.cpp.

References m_set_State, and m_Xref.

Referenced by Reset().

void CMedline_entry_Base::SetAbstract ( const TAbstract value)
inline

Assign a value to Abstract data member.

Parameters
valueValue to assign

Definition at line 737 of file Medline_entry_.hpp.

References m_Abstract, m_set_State, and rapidjson::value.

CMedline_entry_Base::TAbstract & CMedline_entry_Base::SetAbstract ( void  )
inline

Assign a value to Abstract data member.

Returns
Reference to the data value.

Definition at line 744 of file Medline_entry_.hpp.

References IsSetAbstract(), m_Abstract, m_set_State, and CSerialObject::UnassignedString().

void CMedline_entry_Base::SetCit ( CMedline_entry_Base::TCit value)

Assign a value to Cit data member.

Parameters
valueReference to value.

Definition at line 89 of file Medline_entry_.cpp.

References m_Cit.

Referenced by CNewCleanup_imp::MedlineEntryBC(), and CAutogeneratedCleanup::x_BasicCleanupSeqFeat_xref_E_E_data_data_variation_variation_pub_pub_medline_medline_ETC().

CMedline_entry_Base::TCit & CMedline_entry_Base::SetCit ( void  )
inline

Assign a value to Cit data member.

Returns
Reference to the data value.

Definition at line 707 of file Medline_entry_.hpp.

References m_Cit, and ResetCit().

void CMedline_entry_Base::SetDefaultStatus ( void  )
inline

Assign default value to Status data member.

Definition at line 992 of file Medline_entry_.hpp.

References ResetStatus().

void CMedline_entry_Base::SetEm ( CMedline_entry_Base::TEm value)

Assign a value to Em data member.

Parameters
valueReference to value.

Definition at line 75 of file Medline_entry_.cpp.

References m_Em.

Referenced by CAutogeneratedCleanup::x_BasicCleanupSeqFeat_xref_E_E_data_data_variation_variation_pub_pub_medline_medline_ETC().

CMedline_entry_Base::TEm & CMedline_entry_Base::SetEm ( void  )
inline

Assign a value to Em data member.

Returns
Reference to the data value.

Definition at line 677 of file Medline_entry_.hpp.

References m_Em, and ResetEm().

CMedline_entry_Base::TGene & CMedline_entry_Base::SetGene ( void  )
inline

Assign a value to Gene data member.

Returns
Reference to the data value.

Definition at line 874 of file Medline_entry_.hpp.

References m_Gene, and m_set_State.

CMedline_entry_Base::TIdnum & CMedline_entry_Base::SetIdnum ( void  )
inline

Assign a value to Idnum data member.

Returns
Reference to the data value.

Definition at line 849 of file Medline_entry_.hpp.

References m_Idnum, and m_set_State.

CMedline_entry_Base::TMesh & CMedline_entry_Base::SetMesh ( void  )
inline

Assign a value to Mesh data member.

Returns
Reference to the data value.

Definition at line 774 of file Medline_entry_.hpp.

References m_Mesh, and m_set_State.

CMedline_entry_Base::TMlfield & CMedline_entry_Base::SetMlfield ( void  )
inline

Assign a value to Mlfield data member.

Returns
Reference to the data value.

Definition at line 966 of file Medline_entry_.hpp.

References m_Mlfield, and m_set_State.

void CMedline_entry_Base::SetPmid ( const TPmid value)
inline

Assign a value to Pmid data member.

Parameters
valueValue to assign

Definition at line 909 of file Medline_entry_.hpp.

References m_Pmid, m_set_State, and rapidjson::value.

CMedline_entry_Base::TPmid & CMedline_entry_Base::SetPmid ( void  )
inline

Assign a value to Pmid data member.

Returns
Reference to the data value.

Definition at line 916 of file Medline_entry_.hpp.

References m_Pmid, and m_set_State.

CMedline_entry_Base::TPub_type & CMedline_entry_Base::SetPub_type ( void  )
inline

Assign a value to Pub_type data member.

Returns
Reference to the data value.

Definition at line 941 of file Medline_entry_.hpp.

References m_Pub_type, and m_set_State.

void CMedline_entry_Base::SetStatus ( CMedline_entry_Base::TStatus  value)
inline

Assign a value to Status data member.

Parameters
valueValue to assign

Definition at line 1004 of file Medline_entry_.hpp.

References m_set_State, m_Status, and rapidjson::value.

CMedline_entry_Base::TStatus & CMedline_entry_Base::SetStatus ( void  )
inline

Assign a value to Status data member.

Returns
Reference to the data value.

Definition at line 1011 of file Medline_entry_.hpp.

References IsSetStatus(), m_set_State, m_Status, and CSerialObject::UnassignedByte().

CMedline_entry_Base::TSubstance & CMedline_entry_Base::SetSubstance ( void  )
inline

Assign a value to Substance data member.

Returns
Reference to the data value.

Definition at line 799 of file Medline_entry_.hpp.

References m_set_State, and m_Substance.

void CMedline_entry_Base::SetUid ( CMedline_entry_Base::TUid  value)
inline

Assign a value to Uid data member.

Parameters
valueValue to assign

Definition at line 637 of file Medline_entry_.hpp.

References m_set_State, m_Uid, and rapidjson::value.

CMedline_entry_Base::TUid & CMedline_entry_Base::SetUid ( void  )
inline

Assign a value to Uid data member.

Returns
Reference to the data value.

Definition at line 644 of file Medline_entry_.hpp.

References IsSetUid(), m_set_State, m_Uid, and CSerialObject::UnassignedByte().

CMedline_entry_Base::TXref & CMedline_entry_Base::SetXref ( void  )
inline

Assign a value to Xref data member.

Returns
Reference to the data value.

Definition at line 824 of file Medline_entry_.hpp.

References m_set_State, and m_Xref.

Member Data Documentation

string CMedline_entry_Base::m_Abstract
private

Definition at line 587 of file Medline_entry_.hpp.

Referenced by GetAbstract(), ResetAbstract(), and SetAbstract().

CRef< TCit > CMedline_entry_Base::m_Cit
private

Definition at line 586 of file Medline_entry_.hpp.

Referenced by GetCit(), IsSetCit(), ResetCit(), and SetCit().

CRef< TEm > CMedline_entry_Base::m_Em
private

Definition at line 585 of file Medline_entry_.hpp.

Referenced by GetEm(), IsSetEm(), ResetEm(), and SetEm().

list< string > CMedline_entry_Base::m_Gene
private

Definition at line 592 of file Medline_entry_.hpp.

Referenced by GetGene(), ResetGene(), and SetGene().

list< string > CMedline_entry_Base::m_Idnum
private

Definition at line 591 of file Medline_entry_.hpp.

Referenced by GetIdnum(), ResetIdnum(), and SetIdnum().

list< CRef< CMedline_mesh > > CMedline_entry_Base::m_Mesh
private

Definition at line 588 of file Medline_entry_.hpp.

Referenced by GetMesh(), ResetMesh(), and SetMesh().

list< CRef< CMedline_field > > CMedline_entry_Base::m_Mlfield
private

Definition at line 595 of file Medline_entry_.hpp.

Referenced by GetMlfield(), ResetMlfield(), and SetMlfield().

CPubMedId CMedline_entry_Base::m_Pmid
private

Definition at line 593 of file Medline_entry_.hpp.

Referenced by GetPmid(), ResetPmid(), and SetPmid().

list< string > CMedline_entry_Base::m_Pub_type
private

Definition at line 594 of file Medline_entry_.hpp.

Referenced by GetPub_type(), ResetPub_type(), and SetPub_type().

Uint4 CMedline_entry_Base::m_set_State[1]
private
int CMedline_entry_Base::m_Status
private

Definition at line 596 of file Medline_entry_.hpp.

Referenced by GetStatus(), ResetStatus(), and SetStatus().

list< CRef< CMedline_rn > > CMedline_entry_Base::m_Substance
private

Definition at line 589 of file Medline_entry_.hpp.

Referenced by GetSubstance(), ResetSubstance(), and SetSubstance().

int CMedline_entry_Base::m_Uid
private

Definition at line 584 of file Medline_entry_.hpp.

Referenced by GetUid(), ResetUid(), and SetUid().

list< CRef< CMedline_si > > CMedline_entry_Base::m_Xref
private

Definition at line 590 of file Medline_entry_.hpp.

Referenced by GetXref(), ResetXref(), and SetXref().


The documentation for this class was generated from the following files:
Modified on Wed Jul 01 12:47:51 2015 by modify_doxy.py rev. 426318