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

Represents ASN.1 type Seqdesc defined in file seq.asn

Search Toolkit Book for CSeqdesc

#include <objects/seq/Seqdesc.hpp>

+ Inheritance diagram for CSeqdesc:
+ Collaboration diagram for CSeqdesc:

Public Types

enum  ELabelType { eType , eContent , eBoth }
 
- Public Types inherited from CSeqdesc_Base
enum  E_Choice {
  e_not_set = 0 , e_Mol_type , e_Modif , e_Method ,
  e_Name , e_Title , e_Org , e_Comment ,
  e_Num , e_Maploc , e_Pir , e_Genbank ,
  e_Pub , e_Region , e_User , e_Sp ,
  e_Dbxref , e_Embl , e_Create_date , e_Update_date ,
  e_Prf , e_Pdb , e_Het , e_Source ,
  e_Molinfo , e_Modelev
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 26 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef EGIBB_mol TMol_type
 
typedef list< EGIBB_modTModif
 
typedef EGIBB_method TMethod
 
typedef string TName
 
typedef string TTitle
 
typedef COrg_ref TOrg
 
typedef string TComment
 
typedef CNumbering TNum
 
typedef CDbtag TMaploc
 
typedef CPIR_block TPir
 
typedef CGB_block TGenbank
 
typedef CPubdesc TPub
 
typedef string TRegion
 
typedef CUser_object TUser
 
typedef CSP_block TSp
 
typedef CDbtag TDbxref
 
typedef CEMBL_block TEmbl
 
typedef CDate TCreate_date
 
typedef CDate TUpdate_date
 
typedef CPRF_block TPrf
 
typedef CPDB_block TPdb
 
typedef CHeterogen THet
 
typedef CBioSource TSource
 
typedef CMolInfo TMolinfo
 
typedef CModelEvidenceSupport TModelev
 
- 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 Member Functions

 CSeqdesc (void)
 
 ~CSeqdesc (void)
 
void GetLabel (string *const label, ELabelType label_type) const
 
- Public Member Functions inherited from CSeqdesc_Base
 CSeqdesc_Base (void)
 
virtual ~CSeqdesc_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
virtual void Reset (void)
 Reset the whole object. More...
 
virtual void ResetSelection (void)
 Reset the selection (set it to e_not_set). More...
 
E_Choice Which (void) const
 Which variant is currently selected. More...
 
void CheckSelected (E_Choice index) const
 Verify selection, throw exception if it differs from the expected. More...
 
void ThrowInvalidSelection (E_Choice index) const
 Throw 'InvalidSelection' exception. More...
 
void Select (E_Choice index, EResetVariant reset=eDoResetVariant)
 Select the requested variant if needed. More...
 
void Select (E_Choice index, EResetVariant reset, CObjectMemoryPool *pool)
 Select the requested variant if needed, allocating CObject variants from memory pool. More...
 
bool IsMol_type (void) const
 Check if variant Mol_type is selected. More...
 
TMol_type GetMol_type (void) const
 Get the variant data. More...
 
TMol_typeSetMol_type (void)
 Select the variant. More...
 
void SetMol_type (TMol_type value)
 Select the variant and set its data. More...
 
bool IsModif (void) const
 Check if variant Modif is selected. More...
 
const TModifGetModif (void) const
 Get the variant data. More...
 
TModifSetModif (void)
 Select the variant. More...
 
bool IsMethod (void) const
 Check if variant Method is selected. More...
 
TMethod GetMethod (void) const
 Get the variant data. More...
 
TMethodSetMethod (void)
 Select the variant. More...
 
void SetMethod (TMethod value)
 Select the variant and set its data. More...
 
bool IsName (void) const
 Check if variant Name is selected. More...
 
const TNameGetName (void) const
 Get the variant data. More...
 
TNameSetName (void)
 Select the variant. More...
 
void SetName (const TName &value)
 Select the variant and set its data. More...
 
bool IsTitle (void) const
 Check if variant Title is selected. More...
 
const TTitleGetTitle (void) const
 Get the variant data. More...
 
TTitleSetTitle (void)
 Select the variant. More...
 
void SetTitle (const TTitle &value)
 Select the variant and set its data. More...
 
bool IsOrg (void) const
 Check if variant Org is selected. More...
 
const TOrgGetOrg (void) const
 Get the variant data. More...
 
TOrgSetOrg (void)
 Select the variant. More...
 
void SetOrg (TOrg &value)
 Select the variant and set its data. More...
 
bool IsComment (void) const
 Check if variant Comment is selected. More...
 
const TCommentGetComment (void) const
 Get the variant data. More...
 
TCommentSetComment (void)
 Select the variant. More...
 
void SetComment (const TComment &value)
 Select the variant and set its data. More...
 
bool IsNum (void) const
 Check if variant Num is selected. More...
 
const TNumGetNum (void) const
 Get the variant data. More...
 
TNumSetNum (void)
 Select the variant. More...
 
void SetNum (TNum &value)
 Select the variant and set its data. More...
 
bool IsMaploc (void) const
 Check if variant Maploc is selected. More...
 
const TMaplocGetMaploc (void) const
 Get the variant data. More...
 
TMaplocSetMaploc (void)
 Select the variant. More...
 
void SetMaploc (TMaploc &value)
 Select the variant and set its data. More...
 
bool IsPir (void) const
 Check if variant Pir is selected. More...
 
const TPirGetPir (void) const
 Get the variant data. More...
 
TPirSetPir (void)
 Select the variant. More...
 
void SetPir (TPir &value)
 Select the variant and set its data. More...
 
bool IsGenbank (void) const
 Check if variant Genbank is selected. More...
 
const TGenbankGetGenbank (void) const
 Get the variant data. More...
 
TGenbankSetGenbank (void)
 Select the variant. More...
 
void SetGenbank (TGenbank &value)
 Select the variant and set its data. More...
 
bool IsPub (void) const
 Check if variant Pub is selected. More...
 
const TPubGetPub (void) const
 Get the variant data. More...
 
TPubSetPub (void)
 Select the variant. More...
 
void SetPub (TPub &value)
 Select the variant and set its data. More...
 
bool IsRegion (void) const
 Check if variant Region is selected. More...
 
const TRegionGetRegion (void) const
 Get the variant data. More...
 
TRegionSetRegion (void)
 Select the variant. More...
 
void SetRegion (const TRegion &value)
 Select the variant and set its data. More...
 
bool IsUser (void) const
 Check if variant User is selected. More...
 
const TUserGetUser (void) const
 Get the variant data. More...
 
TUserSetUser (void)
 Select the variant. More...
 
void SetUser (TUser &value)
 Select the variant and set its data. More...
 
bool IsSp (void) const
 Check if variant Sp is selected. More...
 
const TSpGetSp (void) const
 Get the variant data. More...
 
TSpSetSp (void)
 Select the variant. More...
 
void SetSp (TSp &value)
 Select the variant and set its data. More...
 
bool IsDbxref (void) const
 Check if variant Dbxref is selected. More...
 
const TDbxrefGetDbxref (void) const
 Get the variant data. More...
 
TDbxrefSetDbxref (void)
 Select the variant. More...
 
void SetDbxref (TDbxref &value)
 Select the variant and set its data. More...
 
bool IsEmbl (void) const
 Check if variant Embl is selected. More...
 
const TEmblGetEmbl (void) const
 Get the variant data. More...
 
TEmblSetEmbl (void)
 Select the variant. More...
 
void SetEmbl (TEmbl &value)
 Select the variant and set its data. More...
 
bool IsCreate_date (void) const
 Check if variant Create_date is selected. More...
 
const TCreate_dateGetCreate_date (void) const
 Get the variant data. More...
 
TCreate_dateSetCreate_date (void)
 Select the variant. More...
 
void SetCreate_date (TCreate_date &value)
 Select the variant and set its data. More...
 
bool IsUpdate_date (void) const
 Check if variant Update_date is selected. More...
 
const TUpdate_dateGetUpdate_date (void) const
 Get the variant data. More...
 
TUpdate_dateSetUpdate_date (void)
 Select the variant. More...
 
void SetUpdate_date (TUpdate_date &value)
 Select the variant and set its data. More...
 
bool IsPrf (void) const
 Check if variant Prf is selected. More...
 
const TPrfGetPrf (void) const
 Get the variant data. More...
 
TPrfSetPrf (void)
 Select the variant. More...
 
void SetPrf (TPrf &value)
 Select the variant and set its data. More...
 
bool IsPdb (void) const
 Check if variant Pdb is selected. More...
 
const TPdbGetPdb (void) const
 Get the variant data. More...
 
TPdbSetPdb (void)
 Select the variant. More...
 
void SetPdb (TPdb &value)
 Select the variant and set its data. More...
 
bool IsHet (void) const
 Check if variant Het is selected. More...
 
const THetGetHet (void) const
 Get the variant data. More...
 
THetSetHet (void)
 Select the variant. More...
 
void SetHet (const THet &value)
 Select the variant and set its data. More...
 
bool IsSource (void) const
 Check if variant Source is selected. More...
 
const TSourceGetSource (void) const
 Get the variant data. More...
 
TSourceSetSource (void)
 Select the variant. More...
 
void SetSource (TSource &value)
 Select the variant and set its data. More...
 
bool IsMolinfo (void) const
 Check if variant Molinfo is selected. More...
 
const TMolinfoGetMolinfo (void) const
 Get the variant data. More...
 
TMolinfoSetMolinfo (void)
 Select the variant. More...
 
void SetMolinfo (TMolinfo &value)
 Select the variant and set its data. More...
 
bool IsModelev (void) const
 Check if variant Modelev is selected. More...
 
const TModelevGetModelev (void) const
 Get the variant data. More...
 
TModelevSetModelev (void)
 Select the variant. More...
 
void SetModelev (TModelev &value)
 Select the variant and set its data. 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 CSeqdesc_Base Tparent
 

Private Member Functions

 CSeqdesc (const CSeqdesc &value)
 
CSeqdescoperator= (const CSeqdesc &value)
 

Additional Inherited Members

- Static Public Member Functions inherited from CSeqdesc_Base
static string SelectionName (E_Choice index)
 Retrieve selection name (for diagnostic purposes). 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 50 of file Seqdesc.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 52 of file Seqdesc.hpp.

Member Enumeration Documentation

◆ ELabelType

Enumerator
eType 
eContent 
eBoth 

Definition at line 59 of file Seqdesc.hpp.

Constructor & Destructor Documentation

◆ CSeqdesc() [1/2]

CSeqdesc::CSeqdesc ( void  )
inline

Definition at line 82 of file Seqdesc.hpp.

◆ ~CSeqdesc()

CSeqdesc::~CSeqdesc ( void  )

Definition at line 59 of file Seqdesc.cpp.

◆ CSeqdesc() [2/2]

CSeqdesc::CSeqdesc ( const CSeqdesc value)
private

Member Function Documentation

◆ GetLabel()

void CSeqdesc::GetLabel ( string *const  label,
ELabelType  label_type 
) const

◆ operator=()

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

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