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 Cdregion defined in file seqfeat.asn

Search Toolkit Book for CCdregion_Base

*** CdRegion *********************************************** * * Instructions to translate from a nucleic acid to a peptide * conflict means it's supposed to translate but doesn't * More...

#include <objects/seqfeat/Cdregion_.hpp>

+ Inheritance diagram for CCdregion_Base:
+ Collaboration diagram for CCdregion_Base:

Public Types

enum  EFrame { eFrame_not_set = 0 , eFrame_one = 1 , eFrame_two = 2 , eFrame_three = 3 }
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_orf , e_frame , e_conflict ,
  e_gaps , e_mismatch , e_code , e_code_break ,
  e_stops
}
 
typedef bool TOrf
 
typedef EFrame TFrame
 
typedef bool TConflict
 
typedef TSeqPos TGaps
 
typedef TSeqPos TMismatch
 
typedef CGenetic_code TCode
 
typedef list< CRef< CCode_break > > TCode_break
 
typedef TSeqPos TStops
 
typedef Tparent::CMemberIndex< E_memberIndex, 9 > 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 Member Functions

 CCdregion_Base (void)
 
virtual ~CCdregion_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetOrf (void) const
 just an ORF ? Check if a value has been assigned to Orf data member. More...
 
bool CanGetOrf (void) const
 Check if it is safe to call GetOrf method. More...
 
void ResetOrf (void)
 Reset Orf data member. More...
 
TOrf GetOrf (void) const
 Get the Orf member data. More...
 
void SetOrf (TOrf value)
 Assign a value to Orf data member. More...
 
TOrfSetOrf (void)
 Assign a value to Orf data member. More...
 
bool IsSetFrame (void) const
 Check if a value has been assigned to Frame data member. More...
 
bool CanGetFrame (void) const
 Check if it is safe to call GetFrame method. More...
 
void ResetFrame (void)
 Reset Frame data member. More...
 
void SetDefaultFrame (void)
 Assign default value to Frame data member. More...
 
TFrame GetFrame (void) const
 Get the Frame member data. More...
 
void SetFrame (TFrame value)
 Assign a value to Frame data member. More...
 
TFrameSetFrame (void)
 Assign a value to Frame data member. More...
 
bool IsSetConflict (void) const
 conflict Check if a value has been assigned to Conflict data member. More...
 
bool CanGetConflict (void) const
 Check if it is safe to call GetConflict method. More...
 
void ResetConflict (void)
 Reset Conflict data member. More...
 
TConflict GetConflict (void) const
 Get the Conflict member data. More...
 
void SetConflict (TConflict value)
 Assign a value to Conflict data member. More...
 
TConflictSetConflict (void)
 Assign a value to Conflict data member. More...
 
bool IsSetGaps (void) const
 number of gaps on conflict/except Check if a value has been assigned to Gaps data member. More...
 
bool CanGetGaps (void) const
 Check if it is safe to call GetGaps method. More...
 
void ResetGaps (void)
 Reset Gaps data member. More...
 
TGaps GetGaps (void) const
 Get the Gaps member data. More...
 
void SetGaps (TGaps value)
 Assign a value to Gaps data member. More...
 
TGapsSetGaps (void)
 Assign a value to Gaps data member. More...
 
bool IsSetMismatch (void) const
 number of mismatches on above Check if a value has been assigned to Mismatch data member. More...
 
bool CanGetMismatch (void) const
 Check if it is safe to call GetMismatch method. More...
 
void ResetMismatch (void)
 Reset Mismatch data member. More...
 
TMismatch GetMismatch (void) const
 Get the Mismatch member data. More...
 
void SetMismatch (TMismatch value)
 Assign a value to Mismatch data member. More...
 
TMismatchSetMismatch (void)
 Assign a value to Mismatch data member. More...
 
bool IsSetCode (void) const
 genetic code used Check if a value has been assigned to Code data member. More...
 
bool CanGetCode (void) const
 Check if it is safe to call GetCode method. More...
 
void ResetCode (void)
 Reset Code data member. More...
 
const TCodeGetCode (void) const
 Get the Code member data. More...
 
void SetCode (TCode &value)
 Assign a value to Code data member. More...
 
TCodeSetCode (void)
 Assign a value to Code data member. More...
 
bool IsSetCode_break (void) const
 individual exceptions Check if a value has been assigned to Code_break data member. More...
 
bool CanGetCode_break (void) const
 Check if it is safe to call GetCode_break method. More...
 
void ResetCode_break (void)
 Reset Code_break data member. More...
 
const TCode_breakGetCode_break (void) const
 Get the Code_break member data. More...
 
TCode_breakSetCode_break (void)
 Assign a value to Code_break data member. More...
 
bool IsSetStops (void) const
 number of stop codons on above Check if a value has been assigned to Stops data member. More...
 
bool CanGetStops (void) const
 Check if it is safe to call GetStops method. More...
 
void ResetStops (void)
 Reset Stops data member. More...
 
TStops GetStops (void) const
 Get the Stops member data. More...
 
void SetStops (TStops value)
 Assign a value to Stops data member. More...
 
TStopsSetStops (void)
 Assign a value to Stops 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
 

Static Public Member Functions

static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() EFrame (void)
 Access to EFrame'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)
 

Private Types

typedef CSerialObject Tparent
 

Private Member Functions

 CCdregion_Base (const CCdregion_Base &)
 
CCdregion_Baseoperator= (const CCdregion_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
bool m_Orf
 
EFrame m_Frame
 
bool m_Conflict
 
TSeqPos m_Gaps
 
TSeqPos m_Mismatch
 
CRef< TCodem_Code
 
list< CRef< CCode_break > > m_Code_break
 
TSeqPos m_Stops
 

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

*** CdRegion *********************************************** * * Instructions to translate from a nucleic acid to a peptide * conflict means it's supposed to translate but doesn't *

CCdregion_Base

Definition at line 82 of file Cdregion_.hpp.


The documentation for this class was generated from the following files:
Modified on Thu May 23 12:34:57 2024 by modify_doxy.py rev. 669887