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

Represents ASN.1 type Seq-table defined in file seqtable.asn

Search Toolkit Book for CSeq_table

#include <objects/seqtable/Seq_table.hpp>

+ Inheritance diagram for CSeq_table:
+ Collaboration diagram for CSeq_table:

Public Types

typedef CSeqTable_column_info::EField_id TColumnId
 
- Public Types inherited from CSeq_table_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_feat_type , e_feat_subtype , e_num_rows ,
  e_columns
}
 
typedef int TFeat_type
 
typedef int TFeat_subtype
 
typedef int TNum_rows
 
typedef vector< CRef< CSeqTable_column > > TColumns
 
typedef Tparent::CMemberIndex< E_memberIndex, 5 > 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

 CSeq_table (void)
 
 ~CSeq_table (void)
 
const CSeqTable_columnGetColumn (CTempString column_name) const
 
const CSeqTable_columnGetColumn (TColumnId column_id) const
 
const CSeqTable_columnGetColumn (TColumnId column_id, CTempString column_name) const
 
- Public Member Functions inherited from CSeq_table_Base
 CSeq_table_Base (void)
 
virtual ~CSeq_table_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetFeat_type (void) const
 type of features in this table, equal to Seq-feat.data variant index Check if a value has been assigned to Feat_type data member. More...
 
bool CanGetFeat_type (void) const
 Check if it is safe to call GetFeat_type method. More...
 
void ResetFeat_type (void)
 Reset Feat_type data member. More...
 
TFeat_type GetFeat_type (void) const
 Get the Feat_type member data. More...
 
void SetFeat_type (TFeat_type value)
 Assign a value to Feat_type data member. More...
 
TFeat_typeSetFeat_type (void)
 Assign a value to Feat_type data member. More...
 
bool IsSetFeat_subtype (void) const
 subtype of features in this table, defined in header SeqFeatData.hpp Check if a value has been assigned to Feat_subtype data member. More...
 
bool CanGetFeat_subtype (void) const
 Check if it is safe to call GetFeat_subtype method. More...
 
void ResetFeat_subtype (void)
 Reset Feat_subtype data member. More...
 
TFeat_subtype GetFeat_subtype (void) const
 Get the Feat_subtype member data. More...
 
void SetFeat_subtype (TFeat_subtype value)
 Assign a value to Feat_subtype data member. More...
 
TFeat_subtypeSetFeat_subtype (void)
 Assign a value to Feat_subtype data member. More...
 
bool IsSetNum_rows (void) const
 number of rows Check if a value has been assigned to Num_rows data member. More...
 
bool CanGetNum_rows (void) const
 Check if it is safe to call GetNum_rows method. More...
 
void ResetNum_rows (void)
 Reset Num_rows data member. More...
 
TNum_rows GetNum_rows (void) const
 Get the Num_rows member data. More...
 
void SetNum_rows (TNum_rows value)
 Assign a value to Num_rows data member. More...
 
TNum_rowsSetNum_rows (void)
 Assign a value to Num_rows data member. More...
 
bool IsSetColumns (void) const
 data in columns Check if a value has been assigned to Columns data member. More...
 
bool CanGetColumns (void) const
 Check if it is safe to call GetColumns method. More...
 
void ResetColumns (void)
 Reset Columns data member. More...
 
const TColumnsGetColumns (void) const
 Get the Columns member data. More...
 
TColumnsSetColumns (void)
 Assign a value to Columns 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 string GetIdName (TColumnId column_id)
 
- 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 CSeq_table_Base Tparent
 

Private Member Functions

 CSeq_table (const CSeq_table &value)
 
CSeq_tableoperator= (const CSeq_table &value)
 

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

Definition at line 56 of file Seq_table.hpp.

Member Typedef Documentation

◆ TColumnId

Definition at line 65 of file Seq_table.hpp.

◆ Tparent

Definition at line 58 of file Seq_table.hpp.

Constructor & Destructor Documentation

◆ CSeq_table() [1/2]

CSeq_table::CSeq_table ( void  )
inline

Definition at line 84 of file Seq_table.hpp.

◆ ~CSeq_table()

CSeq_table::~CSeq_table ( void  )

Definition at line 54 of file Seq_table.cpp.

◆ CSeq_table() [2/2]

CSeq_table::CSeq_table ( const CSeq_table value)
private

Member Function Documentation

◆ GetColumn() [1/3]

const CSeqTable_column & CSeq_table::GetColumn ( CTempString  column_name) const

◆ GetColumn() [2/3]

const CSeqTable_column & CSeq_table::GetColumn ( TColumnId  column_id) const

Definition at line 79 of file Seq_table.cpp.

References column, CSeq_table_Base::GetColumns(), GetIdName(), info, ITERATE, and NCBI_THROW.

◆ GetColumn() [3/3]

const CSeqTable_column & CSeq_table::GetColumn ( TColumnId  column_id,
CTempString  column_name 
) const

Definition at line 93 of file Seq_table.cpp.

References column, CSeq_table_Base::GetColumns(), GetIdName(), info, ITERATE, and NCBI_THROW.

◆ GetIdName()

string CSeq_table::GetIdName ( TColumnId  column_id)
static

Definition at line 59 of file Seq_table.cpp.

References ENUM_METHOD_NAME.

Referenced by GetColumn().

◆ operator=()

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

The documentation for this class was generated from the following files:
Modified on Sun Apr 21 03:42:16 2024 by modify_doxy.py rev. 669887