Search Toolkit Book for CSeqTable_column
#include <objects/seqtable/SeqTable_column.hpp>
Inheritance diagram for CSeqTable_column:
Collaboration diagram for CSeqTable_column:
Public Member Functions | |
| CSeqTable_column (void) | |
| ~CSeqTable_column (void) | |
| bool | IsSet (size_t row) const |
| template<class Value > | |
| bool | TryGetValue (size_t row, Value &v) const |
| bool | TryGetBool (size_t row, bool &v) const |
| bool | TryGetInt (size_t row, int &v) const |
| bool | TryGetReal (size_t row, double &v) const |
| const string * | GetStringPtr (size_t row) const |
| const vector< char > * | GetBytesPtr (size_t row) const |
| CConstRef< CSeq_id > | GetSeq_id (size_t row) const |
| CConstRef< CSeq_loc > | GetSeq_loc (size_t row) const |
| CConstRef< CSeq_interval > | GetSeq_int (size_t row) const |
| Public Member Functions inherited from CSeqTable_column_Base | |
| CSeqTable_column_Base (void) | |
| virtual | ~CSeqTable_column_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetHeader (void) const |
| column description or reference to previously defined info information about data Check if a value has been assigned to Header data member. More... | |
| bool | CanGetHeader (void) const |
| Check if it is safe to call GetHeader method. More... | |
| void | ResetHeader (void) |
| Reset Header data member. More... | |
| const THeader & | GetHeader (void) const |
| Get the Header member data. More... | |
| void | SetHeader (THeader &value) |
| Assign a value to Header data member. More... | |
| THeader & | SetHeader (void) |
| Assign a value to Header data member. More... | |
| bool | IsSetData (void) const |
| row data Check if a value has been assigned to Data data member. More... | |
| bool | CanGetData (void) const |
| Check if it is safe to call GetData method. More... | |
| void | ResetData (void) |
| Reset Data data member. More... | |
| const TData & | GetData (void) const |
| Get the Data member data. More... | |
| void | SetData (TData &value) |
| Assign a value to Data data member. More... | |
| TData & | SetData (void) |
| Assign a value to Data data member. More... | |
| bool | IsSetSparse (void) const |
| in case not all rows contain data this field will contain sparse info Check if a value has been assigned to Sparse data member. More... | |
| bool | CanGetSparse (void) const |
| Check if it is safe to call GetSparse method. More... | |
| void | ResetSparse (void) |
| Reset Sparse data member. More... | |
| const TSparse & | GetSparse (void) const |
| Get the Sparse member data. More... | |
| void | SetSparse (TSparse &value) |
| Assign a value to Sparse data member. More... | |
| TSparse & | SetSparse (void) |
| Assign a value to Sparse data member. More... | |
| bool | IsSetDefault (void) const |
| default value for sparse table, or if row data is too short Check if a value has been assigned to Default data member. More... | |
| bool | CanGetDefault (void) const |
| Check if it is safe to call GetDefault method. More... | |
| void | ResetDefault (void) |
| Reset Default data member. More... | |
| const TDefault & | GetDefault (void) const |
| Get the Default member data. More... | |
| void | SetDefault (TDefault &value) |
| Assign a value to Default data member. More... | |
| TDefault & | SetDefault (void) |
| Assign a value to Default data member. More... | |
| bool | IsSetSparse_other (void) const |
| single value for indexes not listed in sparse table Check if a value has been assigned to Sparse_other data member. More... | |
| bool | CanGetSparse_other (void) const |
| Check if it is safe to call GetSparse_other method. More... | |
| void | ResetSparse_other (void) |
| Reset Sparse_other data member. More... | |
| const TSparse_other & | GetSparse_other (void) const |
| Get the Sparse_other member data. More... | |
| void | SetSparse_other (TSparse_other &value) |
| Assign a value to Sparse_other data member. More... | |
| TSparse_other & | SetSparse_other (void) |
| Assign a value to Sparse_other 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 CTypeInfo * | GetThisTypeInfo (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 string & | GetNamespaceName (void) const |
| Get namespace name. More... | |
| bool | HasNamespacePrefix (void) const |
| Check if data type has namespace prefix. More... | |
| const string & | GetNamespacePrefix (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... | |
| CObject & | operator= (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 CSeqTable_column_Base | Tparent |
Private Member Functions | |
| CSeqTable_column (const CSeqTable_column &value) | |
| CSeqTable_column & | operator= (const CSeqTable_column &value) |
Additional Inherited Members | |
| Public Types inherited from CSeqTable_column_Base | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_header , e_data , e_sparse , e_default , e_sparse_other } |
| typedef CSeqTable_column_info | THeader |
| typedef CSeqTable_multi_data | TData |
| typedef CSeqTable_sparse_index | TSparse |
| typedef CSeqTable_single_data | TDefault |
| typedef CSeqTable_single_data | TSparse_other |
| typedef Tparent::CMemberIndex< E_memberIndex, 6 > | 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< Uint8 > | TCounter |
| Counter type is CAtomiCounter. More... | |
| typedef Uint8 | TCount |
| Alias for value type of counter. 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 62 of file SeqTable_column.hpp.
Member Typedef Documentation
◆ Tparent
|
private |
Definition at line 64 of file SeqTable_column.hpp.
Constructor & Destructor Documentation
◆ CSeqTable_column() [1/2]
|
inline |
Definition at line 133 of file SeqTable_column.hpp.
◆ ~CSeqTable_column()
| CSeqTable_column::~CSeqTable_column | ( | void | ) |
Definition at line 57 of file SeqTable_column.cpp.
◆ CSeqTable_column() [2/2]
|
private |
Member Function Documentation
◆ GetBytesPtr()
| const vector< char > * CSeqTable_column::GetBytesPtr | ( | size_t | row | ) | const |
Definition at line 102 of file SeqTable_column.cpp.
References CSeqTable_single_data_Base::GetBytes(), CSeqTable_column_Base::GetData(), CSeqTable_column_Base::GetDefault(), CSeqTable_sparse_index::GetIndexAt(), CSeqTable_column_Base::GetSparse(), CSeqTable_column_Base::GetSparse_other(), CSeqTable_column_Base::IsSetData(), CSeqTable_column_Base::IsSetDefault(), CSeqTable_column_Base::IsSetSparse(), CSeqTable_column_Base::IsSetSparse_other(), CSeqTable_sparse_index::kSkipped, and row.
Referenced by CSeqTableColumnInfo::GetBytesPtr().
◆ GetSeq_id()
Definition at line 126 of file SeqTable_column.cpp.
References arr, ConstRef(), CSeqTable_column_Base::GetData(), CSeqTable_column_Base::GetDefault(), GetId(), CSeqTable_multi_data_Base::GetId(), CSeqTable_sparse_index::GetIndexAt(), CSeqTable_column_Base::GetSparse(), CSeqTable_column_Base::GetSparse_other(), CSeqTable_column_Base::IsSetData(), CSeqTable_column_Base::IsSetDefault(), CSeqTable_column_Base::IsSetSparse(), CSeqTable_column_Base::IsSetSparse_other(), CSeqTable_sparse_index::kSkipped, and row.
Referenced by CSeqTableColumnInfo::GetSeq_id().
◆ GetSeq_int()
| CConstRef< CSeq_interval > CSeqTable_column::GetSeq_int | ( | size_t | row | ) | const |
Definition at line 176 of file SeqTable_column.cpp.
References arr, ConstRef(), CSeqTable_column_Base::GetData(), CSeqTable_column_Base::GetDefault(), CSeqTable_sparse_index::GetIndexAt(), CSeqTable_multi_data_Base::GetInterval(), CSeqTable_column_Base::GetSparse(), CSeqTable_column_Base::GetSparse_other(), CSeqTable_column_Base::IsSetData(), CSeqTable_column_Base::IsSetDefault(), CSeqTable_column_Base::IsSetSparse(), CSeqTable_column_Base::IsSetSparse_other(), CSeqTable_sparse_index::kSkipped, and row.
◆ GetSeq_loc()
Definition at line 151 of file SeqTable_column.cpp.
References arr, ConstRef(), CSeqTable_column_Base::GetData(), CSeqTable_column_Base::GetDefault(), CSeqTable_sparse_index::GetIndexAt(), GetLoc(), CSeqTable_multi_data_Base::GetLoc(), CSeqTable_column_Base::GetSparse(), CSeqTable_column_Base::GetSparse_other(), CSeqTable_column_Base::IsSetData(), CSeqTable_column_Base::IsSetDefault(), CSeqTable_column_Base::IsSetSparse(), CSeqTable_column_Base::IsSetSparse_other(), CSeqTable_sparse_index::kSkipped, and row.
Referenced by CSeqTableColumnInfo::GetSeq_loc().
◆ GetStringPtr()
Definition at line 78 of file SeqTable_column.cpp.
References CSeqTable_column_Base::GetData(), CSeqTable_column_Base::GetDefault(), CSeqTable_sparse_index::GetIndexAt(), CSeqTable_column_Base::GetSparse(), CSeqTable_column_Base::GetSparse_other(), CSeqTable_single_data_Base::GetString(), CSeqTable_column_Base::IsSetData(), CSeqTable_column_Base::IsSetDefault(), CSeqTable_column_Base::IsSetSparse(), CSeqTable_column_Base::IsSetSparse_other(), CSeqTable_sparse_index::kSkipped, and row.
Referenced by CSeqTableColumnInfo::GetStringPtr().
◆ IsSet()
| bool CSeqTable_column::IsSet | ( | size_t | row | ) | const |
Definition at line 62 of file SeqTable_column.cpp.
References CSeqTable_column_Base::GetData(), CSeqTable_sparse_index::GetIndexAt(), CSeqTable_column_Base::GetSparse(), CSeqTable_column_Base::IsSetData(), CSeqTable_column_Base::IsSetDefault(), CSeqTable_column_Base::IsSetSparse(), CSeqTable_column_Base::IsSetSparse_other(), CSeqTable_sparse_index::kSkipped, and row.
Referenced by CTableFieldHandle_Base::IsSet(), and CSeqTableColumnInfo::IsSet().
◆ operator=()
|
private |
◆ TryGetBool()
Definition at line 99 of file SeqTable_column.hpp.
References row, and TryGetValue().
Referenced by CSeqTableColumnInfo::GetBool(), and CSGSegmentSmearJob::x_LoadFromNA().
◆ TryGetInt()
Definition at line 103 of file SeqTable_column.hpp.
References row, and TryGetValue().
◆ TryGetReal()
|
inline |
Definition at line 107 of file SeqTable_column.hpp.
References row, and TryGetValue().
◆ TryGetValue()
|
inline |
Definition at line 76 of file SeqTable_column.hpp.
References CSeqTable_column_Base::GetData(), CSeqTable_column_Base::GetDefault(), CSeqTable_sparse_index::GetIndexAt(), CSeqTable_column_Base::GetSparse(), CSeqTable_column_Base::GetSparse_other(), CSeqTable_single_data::GetValue(), CSeqTable_column_Base::IsSetData(), CSeqTable_column_Base::IsSetDefault(), CSeqTable_column_Base::IsSetSparse(), CSeqTable_column_Base::IsSetSparse_other(), CSeqTable_sparse_index::kSkipped, and row.
Referenced by CSeqTableColumnInfo::GetValue(), TryGetBool(), TryGetInt(), and TryGetReal().
The documentation for this class was generated from the following files:
- include/objects/seqtable/SeqTable_column.hpp
- src/objects/seqtable/SeqTable_column.cpp
