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

Represents ASN.1 type Gene-commentary defined in file entrezgene.asn

Search Toolkit Book for CGene_commentary

#include <objects/entrezgene/Gene_commentary.hpp>

+ Inheritance diagram for CGene_commentary:
+ Collaboration diagram for CGene_commentary:

Public Member Functions

 CGene_commentary (void)
 
 ~CGene_commentary (void)
 
- Public Member Functions inherited from CGene_commentary_Base
 CGene_commentary_Base (void)
 
virtual ~CGene_commentary_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetType (void) const
 Check if a value has been assigned to Type data member. More...
 
bool CanGetType (void) const
 Check if it is safe to call GetType method. More...
 
void ResetType (void)
 Reset Type data member. More...
 
TType GetType (void) const
 Get the Type member data. More...
 
void SetType (TType value)
 Assign a value to Type data member. More...
 
TTypeSetType (void)
 Assign a value to Type data member. More...
 
bool IsSetHeading (void) const
 appears above text Check if a value has been assigned to Heading data member. More...
 
bool CanGetHeading (void) const
 Check if it is safe to call GetHeading method. More...
 
void ResetHeading (void)
 Reset Heading data member. More...
 
const THeadingGetHeading (void) const
 Get the Heading member data. More...
 
void SetHeading (const THeading &value)
 Assign a value to Heading data member. More...
 
void SetHeading (THeading &&value)
 
THeadingSetHeading (void)
 Assign a value to Heading data member. More...
 
bool IsSetLabel (void) const
 occurs to left of text for protein and RNA types it is a name for property type it is a property tag Check if a value has been assigned to Label data member. More...
 
bool CanGetLabel (void) const
 Check if it is safe to call GetLabel method. More...
 
void ResetLabel (void)
 Reset Label data member. More...
 
const TLabelGetLabel (void) const
 Get the Label member data. More...
 
void SetLabel (const TLabel &value)
 Assign a value to Label data member. More...
 
void SetLabel (TLabel &&value)
 
TLabelSetLabel (void)
 Assign a value to Label data member. More...
 
bool IsSetText (void) const
 block of text for property type it is a property value Check if a value has been assigned to Text data member. More...
 
bool CanGetText (void) const
 Check if it is safe to call GetText method. More...
 
void ResetText (void)
 Reset Text data member. More...
 
const TTextGetText (void) const
 Get the Text member data. More...
 
void SetText (const TText &value)
 Assign a value to Text data member. More...
 
void SetText (TText &&value)
 
TTextSetText (void)
 Assign a value to Text data member. More...
 
bool IsSetAccession (void) const
 accession for the gi in the seqloc, see note 3 Check if a value has been assigned to Accession data member. More...
 
bool CanGetAccession (void) const
 Check if it is safe to call GetAccession method. More...
 
void ResetAccession (void)
 Reset Accession data member. More...
 
const TAccessionGetAccession (void) const
 Get the Accession member data. More...
 
void SetAccession (const TAccession &value)
 Assign a value to Accession data member. More...
 
void SetAccession (TAccession &&value)
 
TAccessionSetAccession (void)
 Assign a value to Accession data member. More...
 
bool IsSetVersion (void) const
 version for the accession above Check if a value has been assigned to Version data member. More...
 
bool CanGetVersion (void) const
 Check if it is safe to call GetVersion method. More...
 
void ResetVersion (void)
 Reset Version data member. More...
 
TVersion GetVersion (void) const
 Get the Version member data. More...
 
void SetVersion (TVersion value)
 Assign a value to Version data member. More...
 
TVersionSetVersion (void)
 Assign a value to Version data member. More...
 
bool IsSetXtra_properties (void) const
 see note 2 Check if a value has been assigned to Xtra_properties data member. More...
 
bool CanGetXtra_properties (void) const
 Check if it is safe to call GetXtra_properties method. More...
 
void ResetXtra_properties (void)
 Reset Xtra_properties data member. More...
 
const TXtra_propertiesGetXtra_properties (void) const
 Get the Xtra_properties member data. More...
 
TXtra_propertiesSetXtra_properties (void)
 Assign a value to Xtra_properties data member. More...
 
bool IsSetRefs (void) const
 refs for this Check if a value has been assigned to Refs data member. More...
 
bool CanGetRefs (void) const
 Check if it is safe to call GetRefs method. More...
 
void ResetRefs (void)
 Reset Refs data member. More...
 
const TRefsGetRefs (void) const
 Get the Refs member data. More...
 
TRefsSetRefs (void)
 Assign a value to Refs data member. More...
 
bool IsSetSource (void) const
 links and refs Check if a value has been assigned to Source data member. More...
 
bool CanGetSource (void) const
 Check if it is safe to call GetSource method. More...
 
void ResetSource (void)
 Reset Source data member. More...
 
const TSourceGetSource (void) const
 Get the Source member data. More...
 
TSourceSetSource (void)
 Assign a value to Source data member. More...
 
bool IsSetGenomic_coords (void) const
 referenced sequences in genomic coords Check if a value has been assigned to Genomic_coords data member. More...
 
bool CanGetGenomic_coords (void) const
 Check if it is safe to call GetGenomic_coords method. More...
 
void ResetGenomic_coords (void)
 Reset Genomic_coords data member. More...
 
const TGenomic_coordsGetGenomic_coords (void) const
 Get the Genomic_coords member data. More...
 
TGenomic_coordsSetGenomic_coords (void)
 Assign a value to Genomic_coords data member. More...
 
bool IsSetSeqs (void) const
 referenced sequences in non-genomic coords Check if a value has been assigned to Seqs data member. More...
 
bool CanGetSeqs (void) const
 Check if it is safe to call GetSeqs method. More...
 
void ResetSeqs (void)
 Reset Seqs data member. More...
 
const TSeqsGetSeqs (void) const
 Get the Seqs member data. More...
 
TSeqsSetSeqs (void)
 Assign a value to Seqs data member. More...
 
bool IsSetProducts (void) const
 Check if a value has been assigned to Products data member. More...
 
bool CanGetProducts (void) const
 Check if it is safe to call GetProducts method. More...
 
void ResetProducts (void)
 Reset Products data member. More...
 
const TProductsGetProducts (void) const
 Get the Products member data. More...
 
TProductsSetProducts (void)
 Assign a value to Products data member. More...
 
bool IsSetProperties (void) const
 Check if a value has been assigned to Properties data member. More...
 
bool CanGetProperties (void) const
 Check if it is safe to call GetProperties method. More...
 
void ResetProperties (void)
 Reset Properties data member. More...
 
const TPropertiesGetProperties (void) const
 Get the Properties member data. More...
 
TPropertiesSetProperties (void)
 Assign a value to Properties data member. More...
 
bool IsSetComment (void) const
 Check if a value has been assigned to Comment data member. More...
 
bool CanGetComment (void) const
 Check if it is safe to call GetComment method. More...
 
void ResetComment (void)
 Reset Comment data member. More...
 
const TCommentGetComment (void) const
 Get the Comment member data. More...
 
TCommentSetComment (void)
 Assign a value to Comment data member. More...
 
bool IsSetCreate_date (void) const
 Check if a value has been assigned to Create_date data member. More...
 
bool CanGetCreate_date (void) const
 Check if it is safe to call GetCreate_date method. More...
 
void ResetCreate_date (void)
 Reset Create_date data member. More...
 
const TCreate_dateGetCreate_date (void) const
 Get the Create_date member data. More...
 
void SetCreate_date (TCreate_date &value)
 Assign a value to Create_date data member. More...
 
TCreate_dateSetCreate_date (void)
 Assign a value to Create_date data member. More...
 
bool IsSetUpdate_date (void) const
 Check if a value has been assigned to Update_date data member. More...
 
bool CanGetUpdate_date (void) const
 Check if it is safe to call GetUpdate_date method. More...
 
void ResetUpdate_date (void)
 Reset Update_date data member. More...
 
const TUpdate_dateGetUpdate_date (void) const
 Get the Update_date member data. More...
 
void SetUpdate_date (TUpdate_date &value)
 Assign a value to Update_date data member. More...
 
TUpdate_dateSetUpdate_date (void)
 Assign a value to Update_date data member. More...
 
bool IsSetRna (void) const
 Check if a value has been assigned to Rna data member. More...
 
bool CanGetRna (void) const
 Check if it is safe to call GetRna method. More...
 
void ResetRna (void)
 Reset Rna data member. More...
 
const TRnaGetRna (void) const
 Get the Rna member data. More...
 
void SetRna (TRna &value)
 Assign a value to Rna data member. More...
 
TRnaSetRna (void)
 Assign a value to Rna 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
 

Private Types

typedef CGene_commentary_Base Tparent
 

Private Member Functions

 CGene_commentary (const CGene_commentary &value)
 
CGene_commentaryoperator= (const CGene_commentary &value)
 

Additional Inherited Members

- Public Types inherited from CGene_commentary_Base
enum  EType {
  eType_genomic = 1 , eType_pre_RNA = 2 , eType_mRNA = 3 , eType_rRNA = 4 ,
  eType_tRNA = 5 , eType_snRNA = 6 , eType_scRNA = 7 , eType_peptide = 8 ,
  eType_other_genetic = 9 , eType_genomic_mRNA = 10 , eType_cRNA = 11 , eType_mature_peptide = 12 ,
  eType_pre_protein = 13 , eType_miscRNA = 14 , eType_snoRNA = 15 , eType_property = 16 ,
  eType_reference = 17 , eType_generif = 18 , eType_phenotype = 19 , eType_complex = 20 ,
  eType_compound = 21 , eType_ncRNA = 22 , eType_gene_group = 23 , eType_assembly = 24 ,
  eType_assembly_unit = 25 , eType_c_region = 26 , eType_d_segment = 27 , eType_j_segment = 28 ,
  eType_v_segment = 29 , eType_comment = 254 , eType_other = 255
}
 type of Gene Commentary More...
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_type , e_heading , e_label ,
  e_text , e_accession , e_version , e_xtra_properties ,
  e_refs , e_source , e_genomic_coords , e_seqs ,
  e_products , e_properties , e_comment , e_create_date ,
  e_update_date , e_rna
}
 
typedef int TType
 
typedef string THeading
 
typedef string TLabel
 
typedef string TText
 
typedef string TAccession
 
typedef int TVersion
 
typedef list< CRef< CXtra_Terms > > TXtra_properties
 
typedef list< CRef< CPub > > TRefs
 
typedef list< CRef< COther_source > > TSource
 
typedef list< CRef< CSeq_loc > > TGenomic_coords
 
typedef list< CRef< CSeq_loc > > TSeqs
 
typedef list< CRef< CGene_commentary > > TProducts
 
typedef list< CRef< CGene_commentary > > TProperties
 
typedef list< CRef< CGene_commentary > > TComment
 
typedef CDate TCreate_date
 
typedef CDate TUpdate_date
 
typedef CRNA_ref TRna
 
typedef Tparent::CMemberIndex< E_memberIndex, 18 > 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...
 
- Static Public Member Functions inherited from CGene_commentary_Base
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() EType (void)
 Access to EType'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 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 53 of file Gene_commentary.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 55 of file Gene_commentary.hpp.

Constructor & Destructor Documentation

◆ CGene_commentary() [1/2]

CGene_commentary::CGene_commentary ( void  )
inline

Definition at line 73 of file Gene_commentary.hpp.

◆ ~CGene_commentary()

CGene_commentary::~CGene_commentary ( void  )

Definition at line 50 of file Gene_commentary.cpp.

◆ CGene_commentary() [2/2]

CGene_commentary::CGene_commentary ( const CGene_commentary value)
private

Member Function Documentation

◆ operator=()

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

The documentation for this class was generated from the following files:
Modified on Wed Mar 27 11:23:11 2024 by modify_doxy.py rev. 669887