NCBI C++ ToolKit
|
Search Toolkit Book for CID2_Request_Get_Seq_id_Base
Requested sequence ID, can be any string or Seq-id. More...
#include <objects/id2/ID2_Request_Get_Seq_id_.hpp>
Public Types | |
enum | ESeq_id_type { eSeq_id_type_any = 0 , eSeq_id_type_gi = 1 , eSeq_id_type_text = 2 , eSeq_id_type_general = 4 , eSeq_id_type_all = 127 , eSeq_id_type_label = 128 , eSeq_id_type_taxid = 256 , eSeq_id_type_hash = 512 , eSeq_id_type_seq_length = 1024 , eSeq_id_type_seq_mol = 2048 } |
enum class | E_memberIndex { e__allMandatory = 0 , e_seq_id , e_seq_id_type } |
typedef CID2_Seq_id | TSeq_id |
typedef int | TSeq_id_type |
typedef Tparent::CMemberIndex< E_memberIndex, 3 > | 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... | |
Public Member Functions | |
CID2_Request_Get_Seq_id_Base (void) | |
virtual | ~CID2_Request_Get_Seq_id_Base (void) |
DECLARE_INTERNAL_TYPE_INFO () | |
bool | IsSetSeq_id (void) const |
Check if a value has been assigned to Seq_id data member. More... | |
bool | CanGetSeq_id (void) const |
Check if it is safe to call GetSeq_id method. More... | |
void | ResetSeq_id (void) |
Reset Seq_id data member. More... | |
const TSeq_id & | GetSeq_id (void) const |
Get the Seq_id member data. More... | |
void | SetSeq_id (TSeq_id &value) |
Assign a value to Seq_id data member. More... | |
TSeq_id & | SetSeq_id (void) |
Assign a value to Seq_id data member. More... | |
bool | IsSetSeq_id_type (void) const |
Check if a value has been assigned to Seq_id_type data member. More... | |
bool | CanGetSeq_id_type (void) const |
Check if it is safe to call GetSeq_id_type method. More... | |
void | ResetSeq_id_type (void) |
Reset Seq_id_type data member. More... | |
void | SetDefaultSeq_id_type (void) |
Assign default value to Seq_id_type data member. More... | |
TSeq_id_type | GetSeq_id_type (void) const |
Get the Seq_id_type member data. More... | |
void | SetSeq_id_type (TSeq_id_type value) |
Assign a value to Seq_id_type data member. More... | |
TSeq_id_type & | SetSeq_id_type (void) |
Assign a value to Seq_id_type 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 |
Static Public Member Functions | |
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() | ESeq_id_type (void) |
Access to ESeq_id_type'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 | |
CID2_Request_Get_Seq_id_Base (const CID2_Request_Get_Seq_id_Base &) | |
CID2_Request_Get_Seq_id_Base & | operator= (const CID2_Request_Get_Seq_id_Base &) |
Private Attributes | |
Uint4 | m_set_State [1] |
CRef< TSeq_id > | m_Seq_id |
int | m_Seq_id_type |
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... | |
Requested sequence ID, can be any string or Seq-id.
This request will be replied with one or more ID2-Reply-Get-Seq-id.
CID2_Request_Get_Seq_id_Base –
Definition at line 74 of file ID2_Request_Get_Seq_id_.hpp.