NCBI C++ ToolKit
|
Search Toolkit Book for CBDB_FieldUChar
Char field type. More...
#include <db/bdb/bdb_types.hpp>
Public Member Functions | |
CBDB_FieldUChar & | operator= (unsigned char val) |
CBDB_FieldUChar & | operator= (const CBDB_FieldUChar &val) |
virtual CBDB_Field * | Construct (size_t) const |
Virtual constructor - class factory for BDB fields. More... | |
unsigned char | Get () const |
operator char () const | |
virtual string | GetString () const |
virtual void | ToString (string &s) const |
virtual BDB_CompareFunction | GetCompareFunction (bool) const |
Return address to the type specific comparison function By default it's universal BDB_Compare. More... | |
virtual int | Compare (const void *p1, const void *p2, bool) const |
Comparison function. More... | |
Public Member Functions inherited from CBDB_FieldSimpleInt< unsigned char > | |
CBDB_FieldSimpleInt () | |
void | Set (unsigned char val) |
virtual void | SetInt (int val) |
virtual void | SetUint (unsigned int val) |
virtual void | SetString (const char *val) |
virtual int | GetInt () const |
virtual unsigned | GetUint () const |
virtual void | SetStdString (const string &str) |
virtual void | SetMinVal () |
Set minimal possible value for the field type. More... | |
virtual void | SetMaxVal () |
Set maximum possible value for the field type. More... | |
Public Member Functions inherited from CBDB_FieldSimple< unsigned char > | |
CBDB_FieldSimple () | |
void | SetField (const CBDB_FieldSimple &field) |
virtual size_t | GetDataLength (const void *) const |
Return current effective size of the buffer. More... | |
Public Member Functions inherited from CBDB_Field | |
CBDB_Field (ELengthType length_type=eFixedLength) | |
virtual | ~CBDB_Field () |
bool | IsNullable () const |
Return TRUE if field can be NULL. More... | |
void | SetNull () |
Assign field value to NULL. More... | |
bool | IsNull () const |
Return TRUE if field is NULL. More... | |
const string & | GetName () const |
Return symbolic name for the field. More... | |
const void * | GetBuffer () const |
Get pointer to the data. NULL if not yet attached. More... | |
void * | GetBuffer () |
Get pointer to the data. NULL if not yet attached. More... | |
size_t | GetBufferSize () const |
Return maximum possible buffer length. More... | |
size_t | GetLength () const |
Get length of the actual data. More... | |
Public Member Functions inherited from IBDB_Field | |
virtual | ~IBDB_Field () |
Public Member Functions inherited from IBDB_FieldConvert | |
virtual | ~IBDB_FieldConvert () |
virtual void | SetUint (unsigned) |
virtual void | SetFloat (float) |
virtual void | SetDouble (double) |
Additional Inherited Members | |
Public Types inherited from CBDB_FieldSimple< unsigned char > | |
typedef unsigned char | TFieldType |
Public Types inherited from CBDB_Field | |
enum | ELengthType { eFixedLength , eVariableLength } |
Length based classificator for fields (fixed-variable) More... | |
Protected Member Functions inherited from CBDB_Field | |
int | CompareWith (const CBDB_Field &field) const |
Field comparison function. More... | |
void | CopyFrom (const CBDB_Field &src) |
Copies field value from another field. More... | |
bool | IsVariableLength () const |
Return TRUE if it is a variable length variable (like string) More... | |
bool | IsBufferAttached () const |
Return TRUE if external buffer has already been attached. More... | |
bool | IsSameType (const CBDB_Field &field) const |
RTTI based check if fld is of the same type. More... | |
bool | IsByteSwapped () const |
Return TRUE if field belongs to a file with an alternative byte order. More... | |
void | SetNullable () |
Mark field as "NULL" capable. More... | |
void | SetNotNull () |
Set "is NULL" flag to FALSE. More... | |
void | SetName (const char *name) |
Set symbolic name for the field. More... | |
void | SetBufferIdx (unsigned int idx) |
Set field position in the buffer manager. More... | |
void * | Unpack () |
Unpack the buffer which contains this field (using CBDB_BufferManager). More... | |
void | SetBuffer (void *buf, size_t buf_size=0) |
Set external buffer pointer and length. More... | |
void | SetBufferSize (size_t size) |
Set the buffer size. More... | |
void | SetDataSize (size_t size) |
Set data size, taking into account possible extra data for some fields. More... | |
virtual size_t | GetExtraDataLength () |
Hook for defining extra data length. More... | |
void | SetBufferManager (CBDB_BufferManager *owner) |
Set CBDB_BufferManager – which works as a memory manager for BDB fields. More... | |
void | CopyFrom (const void *src_buf) |
Copy buffer value from the external source. More... | |
Protected Attributes inherited from CBDB_Field | |
CBDB_BufferManager * | m_BufferManager |
struct { | |
unsigned CBDB_Field::VariableLength: 1 | |
unsigned CBDB_Field::Attached: 1 | |
unsigned CBDB_Field::Nullable: 1 | |
} | m_Flags |
Char field type.
Definition at line 1077 of file bdb_types.hpp.